react-radix-tooltip 0.0.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -7
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -46,15 +46,26 @@ const MyComponent = () => (
46
46
 
47
47
  ## Props
48
48
 
49
+ More Details on [Radix-UI Documentation](https://www.radix-ui.com/primitives/docs/components/tooltip)
50
+
49
51
  | Prop | Type | Default | Description |
50
52
  |---|---|---|---|
51
- | title | ReactNode | Required | The content to display inside the tooltip. |
52
- | children | ReactElement | Required | The element that triggers the tooltip. |
53
- | placement | top | bottom | left | right | top | Preferred position of the tooltip. |
54
- | sideOffset | number | 4 | Distance between the trigger and the tooltip. |
55
- | arrow | boolean | false | Whether to display the optional arrow component. |
56
- | delayDuration | number | 700 | Delay in ms before tooltip opens. |
57
- | tooltipClassName | string | - | CSS class for the tooltip content. | |
53
+ | title | React.ReactNode | — | The content to be displayed inside the tooltip. |
54
+ | children | React.ReactElement | — | The trigger element that activates the tooltip on hover/focus. |
55
+ | container | HTMLDivElement | null | — | The container element into which the tooltip will be rendered. |
56
+ | placement | 'top' \| 'bottom' \| 'left' \| 'right' | 'top' | The preferred side of the trigger to render the tooltip. |
57
+ | sideOffset | number | 0 | The distance in pixels from the trigger element. |
58
+ | arrow | boolean | false | Whether to render an arrow pointing to the trigger. |
59
+ | arrowWidth | number | — | The width of the arrow in pixels. |
60
+ | arrowHeight | number | — | The height of the arrow in pixels. |
61
+ | arrowPadding | number | — | The padding between the arrow and the edges of the tooltip. |
62
+ | delayDuration | number | 700 | The duration in milliseconds to wait before showing the tooltip. |
63
+ | skipDelayDuration | number | 300 | The duration to wait before resetting the delay. |
64
+ | defaultOpen | boolean | false | The open state of the tooltip when it is initially rendered. |
65
+ | onOpenChange | (open: boolean) => void | — | Event handler called when the open state of the tooltip changes. |
66
+ | style | React.CSSProperties | — | Custom inline styles for the tooltip content. |
67
+ | tooltipClassName | string | — | CSS class for the tooltip content container. |
68
+ | tooltipArrowClassName | string | — | CSS class for the tooltip arrow element. |
58
69
 
59
70
  ---
60
71
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "react-radix-tooltip",
3
- "version": "0.0.1",
4
- "description": "ReactRadixTooltip is a lightweight wrapper built on top of @radix-ui/react-tooltip. It simplifies the implementation of accessible tooltips by consolidating Radix's modular structure into a single, prop-driven component, making it easier to manage positioning, styling, and arrow configurations.",
3
+ "version": "1.0.0",
4
+ "description": "A streamlined, developer-friendly wrapper for [@radix-ui/react-tooltip](https://www.radix-ui.com). This component simplifies the Radix Tooltip implementation by allowing you to trigger tooltips using a single component and a simplified prop interface.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
7
7
  "types": "dist/index.d.ts",