Skip to content

Commit 626f39b

Browse files
StringsaeedStringsaeed
committed
docs: add renderPointer prop to documentation
1 parent 705d13b commit 626f39b

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

‎README.md‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -152,20 +152,21 @@ const styles = StyleSheet.create({
152152
153153
## Props
154154
155-
| Name | Type | ? | Default | Description |
156-
| --------------- | ------------------ | --- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
157-
| `isVisible` | `boolean` | ✅ | `undefined` | Determines whether the tooltip is visible or not. |
158-
| `renderContent` | `() => ReactNode` | ✅ | `undefined` | the content of the tooltip |
159-
| `children` | `ReactNode` | ✅ | `undefined` | the children component that the tooltip will point to |
160-
| `withOverlay` | `boolean` | ❌ | `undefined` | whether or not to render overlay behind the `children` and the `Tooltip` |
161-
| `onDismiss` | `() => void` | ❌ | `undefined` | a function to be called when the user presses on the overlay |
162-
| `overlayStyle` | `ViewStyle` | ❌ | `undefined` | a style object to customize how `Overlay` looks |
163-
| `offset` | `number` | ❌ | `0` | a distance added between the `Tooltip` and the `children`, Please note that the `Pointer` size is calculated separately |
164-
| `pointerStyle` | `ViewStyle` | ❌ | `undefined` | a style object to customize `Pointer` looks, <br />Please note: the only available styles in only `width` and `height` |
165-
| `pointerColor` | `string` | ❌ | `"#000000"` | The `Pointer`'s color |
166-
| `position` | `string` | ❌ | `top` | `top`, `bottom`, `left`, and `right`, to control the placement of the `Tooltip` |
167-
| `timingConfig` | `WithTimingConfig` | ❌ | `{ duration: 300 }` | the timing config for animating opening and closing of the `Tooltip` and `Overlay`, <br />Please note: that is from [`react-native-reanimated`](https://docs.swmansion.com/react-native-reanimated/docs/api/animations/withTiming) |
168-
| `childrenStyle` | `ViewStyle` | ❌ | `undefined` | the style of `children` |
155+
| ? | Name | Type | Default | Description |
156+
| --- | --------------- | ------------------------------------ | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
157+
| ✅ | `isVisible` | `boolean` | `undefined` | Determines whether the tooltip is visible or not. |
158+
| ✅ | `renderContent` | `() => ReactNode` | `undefined` | the content of the tooltip |
159+
| ✅ | `children` | `ReactNode` | `undefined` | the children component that the tooltip will point to |
160+
| ❌ | `withOverlay` | `boolean` | `undefined` | whether or not to render overlay behind the `children` and the `Tooltip` |
161+
| ❌ | `onDismiss` | `() => void` | `undefined` | a function to be called when the user presses on the overlay |
162+
| ❌ | `overlayStyle` | `ViewStyle` | `undefined` | a style object to customize how `Overlay` looks |
163+
| ❌ | `offset` | `number` | `0` | a distance added between the `Tooltip` and the `children`, Please note that the `Pointer` size is calculated separately |
164+
| ❌ | `pointerStyle` | `ViewStyle` | `undefined` | a style object to customize `Pointer` looks, <br />Please note: the only available styles in only `width` and `height` |
165+
| ❌ | `pointerColor` | `string` | `"#000000"` | The `Pointer`'s color |
166+
| ❌ | `position` | `string` | `top` | `top`, `bottom`, `left`, and `right`, to control the placement of the `Tooltip` |
167+
| ❌ | `timingConfig` | `WithTimingConfig` | `{ duration: 300 }` | the timing config for animating opening and closing of the `Tooltip` and `Overlay`, <br />Please note: that is from [`react-native-reanimated`](https://docs.swmansion.com/react-native-reanimated/docs/api/animations/withTiming) |
168+
| ❌ | `childrenStyle` | `ViewStyle` | `undefined` | the style of `children` |
169+
| ❌ | `renderPointer` | `(props: PointerProps) => ReactNode` | `undefined` | a render function for the pointer component takes the pointer props that you pass them as a props |
169170
170171
171172

0 commit comments

Comments
 (0)