diff --git a/example/storybook-nativewind/src/components/Tooltip/Tooltip.tsx b/example/storybook-nativewind/src/components/Tooltip/Tooltip.tsx
index 28a79ac09f..dee82fdb80 100644
--- a/example/storybook-nativewind/src/components/Tooltip/Tooltip.tsx
+++ b/example/storybook-nativewind/src/components/Tooltip/Tooltip.tsx
@@ -1,16 +1,4 @@
import React from 'react';
-import {
- Center,
- Text,
- Avatar,
- AvatarGroup,
- AvatarFallbackText,
- Box,
- Heading,
- VStack,
- HStack,
- Icon,
-} from '@gluestack-ui/themed';
import { Tooltip, TooltipContent, TooltipText } from '@/components/ui/tooltip';
import { Button, ButtonText } from '@/components/ui/button';
import { Edit, Command } from 'lucide-react-native';
@@ -42,60 +30,18 @@ const TooltipBasic = ({
);
};
-const FigmaTooltipStory = ({
- showTooltip: _showTooltipProp = true,
- _placement = 'bottom',
- ...props
-}: any) => {
- 2;
- return (
- {
- return (
-
-
-
- );
- }}
- >
-
- Hello world!
-
-
- );
-};
-
TooltipBasic.description =
'This is a basic Tooltip component example. A tooltip is a popup that displays information related to an element when the element receives keyboard focus or the mouse hovers over it.';
export default TooltipBasic;
export {
- FigmaTooltipStory,
TooltipBasic,
Tooltip,
TooltipContent,
TooltipText,
- Center,
Button,
ButtonText,
- Text,
- Avatar,
- AvatarGroup,
- AvatarFallbackText,
- Box,
- Heading,
Edit,
- VStack,
Command,
- HStack,
- Icon,
};
diff --git a/example/storybook-nativewind/src/components/Tooltip/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Tooltip/index.nw.stories.mdx
index 0e225322c9..26b2c35ecb 100644
--- a/example/storybook-nativewind/src/components/Tooltip/index.nw.stories.mdx
+++ b/example/storybook-nativewind/src/components/Tooltip/index.nw.stories.mdx
@@ -7,15 +7,610 @@ pageTitle: Tooltip
pageDescription: Whether you need to provide helpful hints to new users or display extra details for power users, the Tooltip component is a simple and effective way.
-showHeader: false
-
-tag: coming soon
+showHeader: true
---
import { Meta } from '@storybook/addon-docs';
-# Tooltip
+import {
+ Tooltip,
+ TooltipContent,
+ TooltipText,
+ Button,
+ ButtonText,
+ Avatar,
+ AvatarGroup,
+ AvatarFallbackText,
+ HStack,
+ Box,
+ Heading,
+ EditIcon,
+ Center,
+ VStack,
+ Icon
+} from '../../core-components/nativewind';
+import { transformedCode } from '../../utils';
+import {
+ AppProvider,
+ CodePreview,
+ Table,
+ TableContainer,
+ Text,
+ InlineCode,
+ CollapsibleCode
+} from '@gluestack/design-system';
+import Wrapper from '../../core-components/nativewind/Wrapper';
+;
+import {Command} from 'lucide-react-native';
+
+This is an illustration of **Tooltip** component.
+
+<>
+ {
+ return (
+
+ );
+ }}
+ >
+
+ Tooltip
+
+
+ `,
+ transformCode: (code) => {
+ return transformedCode(code);
+ },
+ scope: {
+ Wrapper,
+ Tooltip,
+ TooltipContent,
+ TooltipText,
+ Center,
+ Button,
+ ButtonText,
+ },
+ argsType: {
+ placement: {
+ control: 'select',
+ options: [
+ 'top left',
+ 'top',
+ 'top right',
+ 'left top',
+ 'left',
+ 'left bottom',
+ 'bottom left',
+ 'bottom',
+ 'bottom right',
+ 'right top',
+ 'right',
+ 'right bottom',
+ ],
+ default: 'top',
+ },
+ },
+ }}
+ />
+
+
+
+
+## Installation
+
+### Step 1: Install the following dependencies:
+
+```bash
+
+npm i @gluestack-ui/tooltip
+
+```
+
+### Step 2: Copy and paste the following code into your project.
+
+
+
+```jsx
+%%-- File: core-components/nativewind/tooltip/index.tsx --%%
+```
+
+
+
+### Step 3: Update the import paths to match your project setup.
+
+## API Reference
+
+To use this component in your project, include the following import statement in your file.
+
+```jsx
+import { Tooltip } from '@/components/ui/tooltip';
+```
+
+```jsx
+export default () => (
+
+
+
+
+
+);
+```
+### Component Props
+
+This section provides a comprehensive reference list for the component props, detailing descriptions, properties, types, and default behavior for easy project integration.
+
+#### Tooltip
+
+It inherits all the properties of React Native's [View](https://reactnative.dev/docs/view) component.
+
+<>
+
+
+
+
+
+ Prop
+
+
+ Type
+
+
+ Default
+
+
+ Description
+
+
+
+
+
+
+
+ isOpen
+
+
+
+ boolean
+
+
+ false
+
+
+ {`Whether the tooltip is opened. Useful for controlling the open state.`}
+
+
+
+
+
+ isDisabled
+
+
+
+ boolean
+
+
+ false
+
+
+ {`Whether the tooltip is disabled.`}
+
+
+
+
+
+ defaultIsOpen
+
+
+
+ boolean
+
+
+ false
+
+
+ {`If true, the popover will be opened by default.`}
+
+
+
+
+
+ onOpen
+
+
+
+ {'() => void'}
+
+
+ true
+
+
+ {`This function will be invoked when the tooltip is opened.`}
+
+
+
+
+
+ onClose
+
+
+
+ {'() => void'}
+
+
+ -
+
+
+ {`This function will be invoked when tooltip is closed. It will also be called when the user attempts to close the tooltip via Escape key or backdrop press.`}
+
+
+
+
+
+ openDelay
+
+
+
+ {'number'}
+
+
+ 0
+
+
+ {`Duration in ms to wait till displaying the tooltip.`}
+
+
+
+
+
+ closeDelay
+
+
+
+ {'number'}
+
+
+ 0
+
+
+ {`Duration in ms to wait till hiding the tooltip.`}
+
+
+
+
+
+ placement
+
+
+
+ {`"bottom" | "top" | "right" | "left" | "top left" | "top right" | "bottom left" | "bottom right" | "right top" | "right bottom" | "left top" | "left bottom"`}
+
+
+ bottom left
+
+
+ {`Tooltip placement`}
+
+
+
+
+
+ children
+
+
+
+ any
+
+
+ -
+
+
+
+ The content to display inside the tooltip.
+
+
+
+
+
+
+ closeOnClick
+
+
+
+ boolean
+
+
+ true
+
+
+
+ Whether tooltip should be closed on Trigger click.
+
+
+
+
+
+
+ trigger
+
+
+
+ {`() => any`}
+
+
+ -
+
+
+ {`Function that returns a React Element. This element will be used as a Trigger for the tooltip.`}
+
+
+
+
+
+ offset
+
+
+
+ number
+
+
+ 10
+
+
+
+ Distance between the trigger and the tooltip.
+
+
+
+
+
+
+ crossOffset
+
+
+
+ number
+
+
+ -
+
+
+
+ The additional offset applied along the cross axis between the
+ element and its trigger element.
+
+
+
+
+
+
+ shouldOverlapWithTrigger
+
+
+
+ boolean
+
+
+ false
+
+
+
+ Determines whether tooltip content should overlap with the
+ trigger.
+
+
+
+
+
+
+ shouldFlip
+
+
+
+ boolean
+
+
+ true
+
+
+
+ Whether the element should flip its orientation (e.g. top to
+ bottom or left to right) when there is insufficient room for it to
+ render completely.
+
+
+
+
+
+
+ closeOnOverlayClick
+
+
+
+ boolean
+
+
+ true
+
+
+ {`Closes tooltip when clicked outside.`}
+
+
+
+
+
+
+
+#### TooltipText
+
+Contains all text related layout style props and actions. It inherits all the properties of React Native's Text component.
+
+#### TooltipContent
+
+Contains all backdrop related layout style props and actions. It inherits all the properties of React Native's [View](https://reactnative.dev/docs/view) component.
+
+### Accessibility
+
+We have outlined the various features that ensure the Tooltip component is accessible to all users, including those with disabilities. These features help ensure that your application is inclusive and meets accessibility standards. It adheres to the [ WAI-ARIA design pattern](https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/).
+
+### Examples
+
+#### Tooltip with Heading
+
+A tooltip component with an avatar is a user interface element that displays a small pop-up box of additional information when the user hovers over or interacts with an avatar or an icon.
+
+
+
+
+ {
+ return (
+
+ + 3
+
+ )
+ }}
+ >
+
+
+ View all members of this channel
+