Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@ertugrulkaragoz1
ertugrulkaragoz1 committed Sep 20, 2023
1 parent 713aba1 commit 9b52c81
Showing 1 changed file with 42 additions and 41 deletions.
83 changes: 42 additions & 41 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,47 +66,48 @@ showcaseManager.show(context) // or showcaseManager.show(context, REQUEST_CODE_S

### Builder Configuration

| Usage | Description | Optional | Default Value | StyleRes |
|:--------------------------------------------------------|:---------------------------------------------------------------------------------|:---------|:----------------------------|:---------|
| `builder.focus(View)` | view to be focused on | no | null | no |
| `builder.focus(Array<View>)` | view array to be focused on | no | null | no |
| `builder.resId(Int)` | Showcase.Theme style | yes | null | yes |
| `builder.titleText(String)` | text to be showed on top of the tooltip | yes | "" | no |
| `builder.descriptionText(String)` | description text will be displayed on tooltip | yes | "" | no |
| `builder.titleTextColor(Int)` | titleText's color | yes | Color.BLACK | yes |
| `builder.descriptionTextColor(Int)` | descriptionText's color | yes | Color.BLACK | yes |
| `builder.titleTextSize(Int)` | titleText's text size in SP | yes | 18 SP | no |
| `builder.descriptionTextSize(Int)` | descriptionText's text size in SP | yes | 14 SP | no |
| `builder.titleTextFontFamily(String)` | titleText's fontFamily | yes | sans-serif | yes |
| `builder.descriptionTextFontFamily(String)` | descriptionText's fontFamily | yes | sans-serif | yes |
| `builder.titleTextStyle(Int)` | titleText's textStyle | yes | Typeface.NORMAL | yes |
| `builder.descriptionTextStyle(Int)` | descriptionText's textStyle | yes | Typeface.NORMAL | yes |
| `builder.backgroundColor(Int)` | background color of tooltip | yes | Color.WHITE | yes |
| `builder.closeButtonColor(Int)` | closeButton's color | yes | Color.BLACK | yes |
| `builder.showCloseButton(Boolean)` | show close button on tooltip | yes | true | yes |
| `builder.arrowResource(Int)` | custom icon resource for the arrow rotates 180° if the arrow position is bottom | yes | ic_arrow_up | no |
| `builder.arrowPosition(ArrowPosition)` | arrow can be placed under or over the tooltip | yes | ArrowPosition.AUTO | no |
| `builder.arrowPercentage(Int)` | arrow position percentage can be decided | yes | null | no |
| `builder.highlightType(HighlightType)` | view can be highlighted with a circle shape or rectangle | yes | HighlightType.RECTANGLE | no |
| `builder.cancelListener(CancelListener)` | will be called after user quit from tooltip | yes | null | no |
| `builder.windowBackgroundColor(Int)` | background of the window's color can be decided | yes | Color.BLACK | yes |
| `builder.windowBackgroundTint(Int)` | alpha value of window's background color | yes | 204 | no |
| `builder.titleTextSize(Int)` | titleText's text size in SP | yes | 18 | no |
| `builder.cancellableFromOutsideTouch(Boolean)` | outside touch from tooltip will act as close click | yes | false | yes |
| `builder.showcaseViewClickable(Boolean)` | makes the showcase view clickable or not | yes | false | yes |
| `builder.isDebugMode(Boolean)` | tooltip won't be presented | yes | false | no |
| `builder.attachOnParentLifecycle(Boolean)` | observe parent lifecycle and dismiss showcase | yes | false | no |
| `builder.textPosition(TextPosition)` | text can be positioning center, end and start | yes | TextPosition.START | no |
| `builder.imageUrl(String)` | show image on tooltip | yes | null | no |
| `builder.customContent(Int)` | show given layout | yes | null | no |
| `builder.statusBarVisible(Boolean)` | statusBar visibility of window | yes | true | no |
| `builder.toolTipVisible(Boolean)` | tooltip visibility | yes | true | no |
| `builder.highlightRadius(Float, Float, Float, Float)` | tooltip visibility | yes | 0f, 0f, 0f, 0f | no |
| `builder.setSlidableContentList(List<SlidableContent>)` | show slidable content | yes | null | no |
| `builder.showDurationMillis(Long)` | duration of the tooltip visibility | yes | 2000L | no |
| `builder.showcaseViewVisibleIndefinitely(Boolean)` | controls tooltip visibility condition | yes | true | no |
| `builder.build()` | will return ShowcaseManager instance | no | | |
| `showcaseManager.show(Context)` | show the tooltip with set attributes on | no | | |
| Usage | Description | Optional | Default Value | StyleRes |
|:--------------------------------------------------------|:--------------------------------------------------------------------------------|:---------|:----------------------------|:---------|
| `builder.focus(View)` | view to be focused on | no | null | no |
| `builder.focus(Array<View>)` | view array to be focused on | no | null | no |
| `builder.resId(Int)` | Showcase.Theme style | yes | null | yes |
| `builder.titleText(String)` | text to be showed on top of the tooltip | yes | "" | no |
| `builder.descriptionText(String)` | description text will be displayed on tooltip | yes | "" | no |
| `builder.titleTextColor(Int)` | titleText's color | yes | Color.BLACK | yes |
| `builder.descriptionTextColor(Int)` | descriptionText's color | yes | Color.BLACK | yes |
| `builder.titleTextSize(Int)` | titleText's text size in SP | yes | 18 SP | no |
| `builder.descriptionTextSize(Int)` | descriptionText's text size in SP | yes | 14 SP | no |
| `builder.titleTextFontFamily(String)` | titleText's fontFamily | yes | sans-serif | yes |
| `builder.descriptionTextFontFamily(String)` | descriptionText's fontFamily | yes | sans-serif | yes |
| `builder.titleTextStyle(Int)` | titleText's textStyle | yes | Typeface.NORMAL | yes |
| `builder.descriptionTextStyle(Int)` | descriptionText's textStyle | yes | Typeface.NORMAL | yes |
| `builder.backgroundColor(Int)` | background color of tooltip | yes | Color.WHITE | yes |
| `builder.closeButtonColor(Int)` | closeButton's color | yes | Color.BLACK | yes |
| `builder.showCloseButton(Boolean)` | show close button on tooltip | yes | true | yes |
| `builder.setArrowVisibility(Boolean)` | controls whether arrow icon should be shown or not | yes | true | no |
| `builder.arrowResource(Int)` | custom icon resource for the arrow rotates 180° if the arrow position is bottom | yes | ic_arrow_up | no |
| `builder.arrowPosition(ArrowPosition)` | arrow can be placed under or over the tooltip | yes | ArrowPosition.AUTO | no |
| `builder.arrowPercentage(Int)` | arrow position percentage can be decided | yes | null | no |
| `builder.highlightType(HighlightType)` | view can be highlighted with a circle shape or rectangle | yes | HighlightType.RECTANGLE | no |
| `builder.cancelListener(CancelListener)` | will be called after user quit from tooltip | yes | null | no |
| `builder.windowBackgroundColor(Int)` | background of the window's color can be decided | yes | Color.BLACK | yes |
| `builder.windowBackgroundTint(Int)` | alpha value of window's background color | yes | 204 | no |
| `builder.titleTextSize(Int)` | titleText's text size in SP | yes | 18 | no |
| `builder.cancellableFromOutsideTouch(Boolean)` | outside touch from tooltip will act as close click | yes | false | yes |
| `builder.showcaseViewClickable(Boolean)` | makes the showcase view clickable or not | yes | false | yes |
| `builder.isDebugMode(Boolean)` | tooltip won't be presented | yes | false | no |
| `builder.attachOnParentLifecycle(Boolean)` | observe parent lifecycle and dismiss showcase | yes | false | no |
| `builder.textPosition(TextPosition)` | text can be positioning center, end and start | yes | TextPosition.START | no |
| `builder.imageUrl(String)` | show image on tooltip | yes | null | no |
| `builder.customContent(Int)` | show given layout | yes | null | no |
| `builder.statusBarVisible(Boolean)` | statusBar visibility of window | yes | true | no |
| `builder.toolTipVisible(Boolean)` | tooltip visibility | yes | true | no |
| `builder.highlightRadius(Float, Float, Float, Float)` | tooltip visibility | yes | 0f, 0f, 0f, 0f | no |
| `builder.setSlidableContentList(List<SlidableContent>)` | show slidable content | yes | null | no |
| `builder.showDurationMillis(Long)` | duration of the tooltip visibility | yes | 2000L | no |
| `builder.showcaseViewVisibleIndefinitely(Boolean)` | controls tooltip visibility condition | yes | true | no |
| `builder.build()` | will return ShowcaseManager instance | no | | |
| `showcaseManager.show(Context)` | show the tooltip with set attributes on | no | | |

### Action Result

Expand Down

0 comments on commit 9b52c81

Please sign in to comment.