@highlight-ui/tooltip
Advanced tools
Readme
Using npm:
npm install @highlight-ui/tooltip
Using yarn:
yarn add @highlight-ui/tooltip
Using pnpm:
pnpm install @highlight-ui/tooltip
In your (S)CSS file:
@import url('@highlight-ui/tooltip');
Once the package is installed, you can import the library:
import { Tooltip } from '@highlight-ui/tooltip';
import React from 'react';
import { Tooltip } from '@highlight-ui/tooltip';
export default function TooltipExample() {
return (
<Tooltip
content={<Body>This is the tooltip text.</Body>}
placement="top"
interactive
>
<b>Hover me</b>
</Tooltip>
);
}
| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
content | React.ReactNode | Yes | Content rendered inside the tooltip pop-up | |
children | React.ReactNode | Yes | The element which triggers the tooltip pop-up | |
id | string | No | id of the tooltip | |
component | 'span', 'div' | No | span | Create custom trigger element |
mouseEnterDelay | MouseDelayVariant | No | none | Mouse enter delay specifying how long a tooltip takes before becoming visible |
mouseOutDelay | MouseDelayVariant | No | none | Mouse out delay specifying how long a tooltip stays visible after hovering out |
placement | 'top', 'left', 'bottom', 'right' | No | top | Placement of the tooltip |
interactive | boolean | No | true | Whether tooltip text stays visible when user moves the pointer over its content (requires long mouseOutDelay) |
className | string | No | Allows providing a custom class name |
| Type | Values | Description |
|---|---|---|
MouseDelayVariant | 'none', 'medium', 'long' | Used by the mouseEnterDelay and mouseOutDelay props. none = 0, medium = 375, long = 1000 |
Please visit personio.design for usage guidelines and visual examples.
If you're interested in contributing, please visit our contribution page.
FAQs
Tooltip component for Highlight UI library
The npm package @highlight-ui/tooltip receives a total of 3,991 weekly downloads. As such, @highlight-ui/tooltip popularity was classified as popular.
We found that @highlight-ui/tooltip demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.