Interface: TooltipProviderProps

Hierarchy

• TooltipStoreProps

  ↳ TooltipProviderProps

Table of contents

Properties

• animated
• children
• defaultOpen
• disclosure
• hideTimeout
• open
• placement
• popover
• setMounted
• setOpen
• showTimeout
• skipTimeout
• store
• timeout
• type

Properties

animated

• Optional animated: number | boolean

Determines whether the content should animate when it is shown or hidden.

• If true, the animating state will be true when the content is shown or hidden and it will wait for stopAnimation to be called or a CSS animation/transition to end before becoming false.
• If it's set to a number, the animating state will be true when the content is shown or hidden and it will wait for the number of milliseconds to pass before becoming false.

Live examples:

• Animated Combobox (opens in a new tab)
• Animated Dialog (opens in a new tab)
• Animated Select (opens in a new tab)

Default

false;

Inherited from

TooltipStoreProps.animated

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts:44

children

• Optional children: ReactNode

Defined in

node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/tooltip/tooltip-provider.d.ts:16

defaultOpen

• Optional defaultOpen: boolean

The default visibility state of the content.

Default

false;

Inherited from

TooltipStoreProps.defaultOpen

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts:115

disclosure

• Optional disclosure: null | DisclosureStore

A reference to another disclosure store that controls another disclosure component to keep them in sync. Element states like contentElement and disclosureElement won't be synced. For that, use the store prop instead.

Inherited from

TooltipStoreProps.disclosure

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts:122

hideTimeout

• Optional hideTimeout: number

Default

0;

Inherited from

TooltipStoreProps.hideTimeout

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tooltip/tooltip-store.d.ts:23

open

• Optional open: boolean

The visibility state of the content.

Live examples:

• Dialog with React Router (opens in a new tab)

Default

false;

Inherited from

TooltipStoreProps.open

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts:16

placement

• Optional placement: Placement

Default

"top";

Inherited from

TooltipStoreProps.placement

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tooltip/tooltip-store.d.ts:21

popover

• Optional popover: null | PopoverStore

A reference to another popover store that's controlling another popover to keep them in sync.

Inherited from

TooltipStoreProps.popover

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/popover/popover-store.d.ts:65

setMounted

• Optional setMounted: (mounted: boolean) => void

Type declaration

▸ (mounted): void

A callback that gets called when the mounted state changes.

Parameters

Returns

void

Example

const [mounted, setMounted] = useState(false);
const disclosure = useDisclosureStore({ setMounted });

Inherited from

TooltipStoreProps.setMounted

Defined in

node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts:33

setOpen

• Optional setOpen: (open: boolean) => void

Type declaration

▸ (open): void

A callback that gets called when the open state changes.

Parameters

Returns

void

Example

const [open, setOpen] = useState(false);
const disclosure = useDisclosureStore({ open, setOpen });

Inherited from

TooltipStoreProps.setOpen

Defined in

node_modules/.pnpm/@ariakit+react-core@0.3.5_react-dom@18.2.0_react@18.2.0/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts:25

showTimeout

• Optional showTimeout: number

The amount of time in milliseconds to wait before showing the popover. It defaults to the value passed to timeout.

Inherited from

TooltipStoreProps.showTimeout

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/hovercard/hovercard-store.d.ts:24

skipTimeout

• Optional skipTimeout: number

The amount of time after a tooltip is hidden while all tooltips on the page can be shown immediately, without waiting for the show timeout.

Default

300;

Inherited from

TooltipStoreProps.skipTimeout

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tooltip/tooltip-store.d.ts:19

store

• Optional store: Store<Partial<TooltipStoreState>>

Another store object that will be kept in sync with the original store.

Inherited from

TooltipStoreProps.store

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/utils/store.d.ts:50

timeout

• Optional timeout: number

The amount of time in milliseconds to wait before showing and hiding the popover. To control the delay for showing and hiding separately, use showTimeout and hideTimeout.

Default

500;

Inherited from

TooltipStoreProps.timeout

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/hovercard/hovercard-store.d.ts:19

type

• Optional type: "label" | "description"

Determines whether the tooltip is being used as a label or a description for the anchor element.

Default

"description";

Inherited from

TooltipStoreProps.type

Defined in

node_modules/.pnpm/@ariakit+core@0.3.4/node_modules/@ariakit/core/cjs/tooltip/tooltip-store.d.ts:13