Tooltip
This component displays information when the user moves the mouse pointer over a trigger element.
Figma Reference
Tooltip Usage
import { Tooltip } from './Tooltip';
export const App = () => {
return (
<Tooltip>
Hover over me
<Tooltip.Content direction='top' background='full'>
Some content
</Tooltip.Content>
</Tooltip>
);
};
Properties
Tooltip
| Property | Type | Default | Description |
|---|---|---|---|
children | ReactNode | - | Child components to be rendered |
style | React.CSSProperties | - | Gives the Tooltip container css properties |
dataTestId | string | tooltip-container | Customizable test identifier |
hideDelay | number | 0ms | Delay to hide tooltip when mouse leaving the target element |
Tooltip.Content
| Property | Type | Default | Description |
|---|---|---|---|
children | ReactNode | - | Content showed on the Tooltip. When content is empty, the tooltip will not be showed. |
direction | TooltipDirection | top | Determines the direction of the tooltip |
background | TooltipBackground | full | Determines the background type of the tooltip |
style | React.CSSProperties | - | Gives the Tooltip Content css properties |
dataTestId | string | tooltip-content | Customizable test identifier |
Stack
- TypeScript for static type checking
- React — JavaScript library for user interfaces
- Emotion — for writing css styles with JavaScript
- Storybook — UI component environment powered by Vite
- Jest - JavaScript Testing Framework
- React Testing Library - to test UI components in a user-centric way
- ESLint for code linting
- Prettier for code formatting
- Tsup — TypeScript bundler powered by esbuild
- Yarn from managing packages
Commands
yarn build- Build the packageyarn dev- Run the package locallyyarn lint- Lint all files within this packageyarn test- Run all unit testsyarn test:report- Open the test coverage reportyarn test:update:snapshot- Run all unit tests and update the snapshot
Compilation
Running yarn build from the root of the package will use tsup to compile the raw TypeScript and React code to plain JavaScript.
The /dist folder contains the compiled output.
tooltip
└── dist
├── index.d.ts <-- Types
├── index.js <-- CommonJS version
└── index.mjs <-- ES Modules version
...
Versioning
Follows semantic versioning
© License
Licensed under MIT License