From 24b5a1d72eb07decb01f4095168f00e44623a284 Mon Sep 17 00:00:00 2001 From: JelenaTakac Date: Wed, 28 Aug 2024 15:03:21 +0200 Subject: [PATCH] Update readme.md --- src/components/tooltip/readme.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/src/components/tooltip/readme.md b/src/components/tooltip/readme.md index 972ef8ec..e4ca9c2e 100644 --- a/src/components/tooltip/readme.md +++ b/src/components/tooltip/readme.md @@ -74,12 +74,15 @@ The `Tooltips` are small, interactive pop-up boxes that provide brief, informati - crossAxis?: number; - alignmentAxis?: number | null; -### `focusOnly` -- **Type:** `boolean` -- **Default:** `false` -- **Description:** When true, the tooltip is displayed only on focus. Options include: - - `"false"` - - `"true"` +### `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. ### `children` - **Type:** `ReactNode` @@ -106,7 +109,7 @@ const App = () => ( - Tooltips are used to describe or identify an element. In most scenarios, tooltips help the user understand meaning, function or alt-text.} placement="right" arrow> + Tooltips are used to describe or identify an element. In most scenarios, tooltips help the user understand meaning, function or alt-text.} placement="right" arrow>