Skip to content

Commit

Permalink
updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
prscms committed May 30, 2018
1 parent c9cd6e8 commit e678c2d
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,28 +68,39 @@ RNTooltips.Show(

## Props


- **Props: Generic**

| Prop | Type | Default | Note |
| ----------------- | ---------- | ------- | ---------------------------------------------------------------------------------------------------------- |
| `text` | `string` | | Text which needs to be displayed
| `position: Android` | `number` | | Position of the tooltip view. On iOS it is auto adjustable
| `align: Android` | `number` | | Alignment of tooltip |
| `autoHide` | `bool` | | Should tip view get auto dismiss |
| `duration` | `number` | | Duration after which tooltip view should be dismissed | |
| `clickToHide: iOS` | `bool` | | On click should tooltip view be dismissed | |
| `clickToHide` | `bool` | | On click should tooltip view be dismissed | |
| `corner` | `number` | | Radius of corner
| `tintColor` | `string` | | Color of tooltip view background
| `textColor` | `string` | | Color of text
| `textSize` | `number` | | Size of text displayed
| `gravity` | `number` | | Gravity of text
| `visible` | `bool` | | Should tooltip be displayed
| `shadow` | `bool` | | Shadow on tooltip view
| `arrow: iOS` | `bool` | true | Display Arrow
| `arrow` | `bool` | true | Display Arrow
| `reference` | `object` | | Reference of react component of which you need tooltip
| `onHide` | `func` | | Callback function invoked on tooltip hide


- **Props - iOS**

| Prop | Type | Default | Note |
| ----------------- | ---------- | ------- | ---------------------------------------------------------------------------------------------------------- |

- **Props - Android**

| Prop | Type | Default | Note |
| ----------------- | ---------- | ------- | ---------------------------------------------------------------------------------------------------------- |
| `position` | `number` | | Position of the tooltip view. On iOS it is auto adjustable
| `align` | `number` | | Alignment of tooltip |


## Credits

- Android: [florent37/ViewTooltip](https://github.com/florent37/ViewTooltip)
Expand Down

0 comments on commit e678c2d

Please sign in to comment.