Skip to content

Commit

Permalink
Merge pull request #41 from brainstormforce/component/tooltip
Browse files Browse the repository at this point in the history
Tooltip component - update documentation
  • Loading branch information
vrundakansara authored Aug 29, 2024
2 parents 36377f7 + ae2a9c5 commit a706ca8
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion src/components/tooltip/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,16 @@ The `Tooltips` are small, interactive pop-up boxes that provide brief, informati
- crossAxis?: number;
- alignmentAxis?: number | null;

### `tooltipPortalRoot`
- **Type:** `HTMLElement | null`
- **Default:** `null`
- **Description:** Root element where the tooltip will be rendered. It's helpful when the tooltip is rendered outside the parent container and scopped Tailwind CSS styles.

### `tooltipPortalId`
- **Type:** `string`
- **Default:** `""`
- **Description:** Id of the tooltip portal where the tooltip will be rendered. It's helpful when the tooltip is rendered outside the parent container and scopped Tailwind CSS styles.

### `triggers`
- **Type:** `string[]`
- **Default:** `["hover", "focus"]`
Expand Down Expand Up @@ -131,7 +141,7 @@ const App = () => (
triggers={['click']}
arrow
>
<button>Hover over me</button>
<button>Click me</button>
</Tooltip>

{/* Interactive Tooltip */}
Expand Down

0 comments on commit a706ca8

Please sign in to comment.