Added documentation to the readme #2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WrathChaos
requested changes
Jan 19, 2024
| @@ -77,6 +77,7 @@ The tooltip wraps an element _in place_ in your React Native rendering. When it | |||
| | closeOnChildInteraction | bool | true | When child interaction is allowed, this prop determines if `onClose` should be called when the user interacts with the child element. Default is true (usually means the tooltip will dismiss once the user touches the element highlighted) | | |||
| | closeOnContentInteraction | bool | true | this prop determines if `onClose` should be called when the user interacts with the content element. Default is true (usually means the tooltip will dismiss once the user touches the content element) | | |||
| | content | function/Element | `<View />` | This is the view displayed in the tooltip popover bubble | | |||
| | contentStyle | CSS | | Custom CSS to modify the tooltip as needed. | | |||
There was a problem hiding this comment.
The type should be StyleProp<ViewStyle> and the explanation should match with it.
Because in react native, we're not using CSS, it is its own style
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This prop is defined in the code but not explained in the README.md, that's why I decided to add it because sometimes the dev needs to modify de CSS, for example to change de borderRadius of the tooltip.