Oku Primitives

A popup that displays information related to an element when the element receives keyboard focus or the mouse hovers over it.

vue

<script setup lang="ts">
import { TooltipArrow, TooltipContent, TooltipPortal, TooltipProvider, TooltipRoot, TooltipTrigger } from '@oku-ui/primitives'
import { Icon } from '@iconify/vue'
</script>

<template>
  <TooltipProvider>
    <TooltipRoot>
      <TooltipTrigger
        class="text-mauve12 shadow-blackA7 hover:bg-indigo3 inline-flex h-[35px] w-[35px] items-center justify-center rounded-full bg-white shadow-[0_2px_10px] outline-none focus:shadow-[0_0_0_2px] focus:shadow-black"
      >
        <Icon icon="radix-icons:plus" />
      </TooltipTrigger>
      <TooltipPortal>
        <TooltipContent
          class="data-[state=delayed-open]:data-[side=top]:animate-slideDownAndFade data-[state=delayed-open]:data-[side=right]:animate-slideLeftAndFade data-[state=delayed-open]:data-[side=left]:animate-slideRightAndFade data-[state=delayed-open]:data-[side=bottom]:animate-slideUpAndFade text-mauve12 select-none rounded-[4px] bg-white px-[15px] py-[10px] text-[15px] leading-none shadow-[hsl(206_22%_7%_/_35%)_0px_10px_38px_-10px,_hsl(206_22%_7%_/_20%)_0px_10px_20px_-15px] will-change-[transform,opacity]"
          :side-offset="5"
        >
          Add to library
          <TooltipArrow
            class="fill-white"
            :width="8"
          />
        </TooltipContent>
      </TooltipPortal>
    </TooltipRoot>
  </TooltipProvider>
</template>

Features

Provider to control display delay globally.
Opens when the trigger is focused or hovered.
Closes when the trigger is activated or when pressing escape.
Supports custom timings.

Anatomy

Import all parts and piece them together.

vue

<script setup lang="ts">
import { TooltipArrow, TooltipContent, TooltipPortal, TooltipProvider, TooltipRoot, TooltipTrigger } from '@oku-ui/primitives'
</script>

<template>
  <TooltipProvider>
    <TooltipRoot>
      <TooltipTrigger />
      <TooltipPortal>
        <TooltipContent>
          <TooltipArrow />
        </TooltipContent>
      </TooltipPortal>
    </TooltipRoot>
  </TooltipProvider>
</template>

API Reference

Provider

Wraps your app to provide global functionality to your tooltips.

Prop	Default	Type
`delayDuration`		`number` The duration from when the pointer enters the trigger until the tooltip gets opened.
`disableHoverableContent`		`boolean` When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
`skipDelayDuration`		`number` How much time a user has to enter another trigger without incurring a delay again.

Root

Contains all the parts of a tooltip.

Prop	Default	Type
`defaultOpen`		`boolean`
`delayDuration`		`number` The duration from when the pointer enters the trigger until the tooltip gets opened. This will override the prop with the same name passed to Provider.
`disableHoverableContent`		`boolean` When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
`open`		`boolean`

Emit	Payload
`update:open`	`[open: boolean]`

Trigger

The button that toggles the tooltip. By default, the TooltipContent will position itself against the trigger.

Prop	Default	Type
`as`	`'div'`	`object \| AsTag`
`virtualRef`		`MutableRefObject<Measurable>`

Data Attribute	Value
`[data-state]`	`"closed" \| "delayed-open" \| "instant-open"`

Portal

When used, portals the content part into the body.

Content

The component that pops out when the tooltip is open.

Prop	Default	Type
`forceMount`		`boolean` Used to force mounting when more control is needed. Useful when controlling animation with React animation libraries.

Data Attribute	Value
`[data-state]`	`"closed" \| "delayed-open" \| "instant-open"`
`[data-side]`	`"left" \| "right" \| "bottom" \| "top"`
`[data-align]`	`"start" \| "end" \| "center"`

CSS Variable	Description
`--radix-tooltip-content-transform-origin`	The `transform-origin` computed from the content and arrow positions/offsets
`--radix-tooltip-content-available-width`	The remaining width between the trigger and the boundary edge
`--radix-tooltip-content-available-height`	The remaining height between the trigger and the boundary edge
`--radix-tooltip-trigger-width`	The width of the trigger
`--radix-tooltip-trigger-height`	The height of the trigger

Arrow

An optional arrow element to render alongside the tooltip. This can be used to help visually link the trigger with the TooltipContent. Must be rendered inside TooltipContent.

Examples

Configure globally

Use the Provider to control delayDuration and skipDelayDuration globally.

vue

<script setup>
import { TooltipContent, TooltipProvider, TooltipRoot, TooltipTrigger } from '@oku-ui/primitives'
</script>

<template>
  <TooltipProvider
    :delay-duration="800"
    :skip-delay-duration="500"
  >
    <TooltipRoot>
      <TooltipTrigger>…</TooltipTrigger>
      <TooltipContent>…</TooltipContent>
    </TooltipRoot>
    <TooltipRoot>
      <TooltipTrigger>…</TooltipTrigger>
      <TooltipContent>…</TooltipContent>
    </TooltipRoot>
  </TooltipProvider>
</template>

Show instantly

Use the delayDuration prop to control the time it takes for the tooltip to open.

vue

<script setup>
import { TooltipContent, TooltipProvider, TooltipRoot, TooltipTrigger } from '@oku-ui/primitives'
</script>

<template>
  <TooltipRoot :delay-duration="0">
    <TooltipTrigger>…</TooltipTrigger>
    <TooltipContent>…</TooltipContent>
  </TooltipRoot>
</template>

Since disabled buttons don't fire events, you need to:

Render the Trigger as span.
Ensure the button has no pointerEvents.

vue

<script setup>
import { TooltipContent, TooltipProvider, TooltipRoot, TooltipTrigger } from '@oku-ui/primitives'
</script>

<template>
  <TooltipRoot>
    <TooltipTrigger as-child>
      <span tabindex="0">
        <button
          disabled
          style="{ pointerEvents: 'none' }"
        >…</button>
      </span>
    </TooltipTrigger>
    <TooltipContent>…</TooltipContent>
  </TooltipRoot>
</template>

Constrain the content size

You may want to constrain the width of the content so that it matches the trigger width. You may also want to constrain its height to not exceed the viewport.

We expose several CSS custom properties such as --radix-tooltip-trigger-width and --radix-tooltip-content-available-height to support this. Use them to constrain the content dimensions.

vue

 <!-- index.vue -->
<script setup>
import { TooltipContent, TooltipProvider, TooltipRoot, TooltipTrigger } from '@oku-ui/primitives'
</script>

<template>
  <TooltipRoot>
    <TooltipTrigger>…</TooltipTrigger>
    <TooltipPortal>
      <TooltipContent
        class="TooltipContent"
        :side-offset="5"
      >
        …
      </TooltipContent>
    </TooltipPortal>
  </TooltipRoot>
</template>

css

/* styles.css */
.TooltipContent {
  width: var(--radix-tooltip-trigger-width);
  max-height: var(--radix-tooltip-content-available-height);
}

Origin-aware animations

We expose a CSS custom property --radix-tooltip-content-transform-origin. Use it to animate the content from its computed origin based on side, sideOffset, align, alignOffset and any collisions.

vue

 <!-- index.vue -->
<script setup>
import { TooltipContent, TooltipProvider, TooltipRoot, TooltipTrigger } from '@oku-ui/primitives'
</script>

<template>
  <TooltipRoot>
    <TooltipTrigger>…</TooltipTrigger>
    <TooltipContent class="TooltipContent">
      …
    </TooltipContent>
  </TooltipRoot>
</template>

css

/* styles.css */
.TooltipContent {
  transform-origin: var(--radix-tooltip-content-transform-origin);
  animation: scaleIn 0.5s ease-out;
}

@keyframes scaleIn {
  from {
    opacity: 0;
    transform: scale(0);
  }
  to {
    opacity: 1;
    transform: scale(1);
  }
}

Collision-aware animations

We expose data-side and data-align attributes. Their values will change at runtime to reflect collisions. Use them to create collision and direction-aware animations.

vue

 <!-- index.vue -->
<script setup>
import { TooltipContent, TooltipProvider, TooltipRoot, TooltipTrigger } from '@oku-ui/primitives'
</script>

<template>
  <TooltipRoot>
    <TooltipTrigger>…</TooltipTrigger>
    <TooltipContent class="TooltipContent">
      …
    </TooltipContent>
  </TooltipRoot>
</template>

css

/* styles.css */
.TooltipContent {
  animation-duration: 0.6s;
  animation-timing-function: cubic-bezier(0.16, 1, 0.3, 1);
}
.TooltipContent[data-side="top"] {
  animation-name: slideUp;
}
.TooltipContent[data-side="bottom"] {
  animation-name: slideDown;
}

@keyframes slideDown {
  from {
    opacity: 0;
    transform: translateY(-10px);
  }
  to {
    opacity: 1;
    transform: translateY(0);
  }
}

@keyframes slideUp {
  from {
    opacity: 0;
    transform: translateY(10px);
  }
  to {
    opacity: 1;
    transform: translateY(0);
  }
}

Accessibility

Keyboard Interactions

Key	Description
`Tab`	Opens/closes the tooltip without delay.
`Space`	If open, closes the tooltip without delay.
`Enter`	If open, closes the tooltip without delay.
`Escape`	If open, closes the tooltip without delay.

Custom APIs

Create your own API by abstracting the primitive parts into your own component.

Abstract parts and introduce a content prop

This example abstracts all of the Tooltip parts and introduces a new content prop.

Usage

vue

<script setup lang="ts">
import { Tooltip } from './your-tooltip'
</script>

<template>
  <Tooltip content="Tooltip content">
    <button>Tooltip trigger</button>
  </Tooltip>
</template>

Implementation

Use the asChild prop to convert the trigger part into a slottable area. It will replace the trigger with the child that gets passed to it.

vue

<!-- your-tooltip.vue  -->
<script setup lang="ts">
import { TooltipArrow, TooltipContent, TooltipRoot, type TooltipRootEmits, type TooltipRootProps, TooltipTrigger, useForwardPropsEmits } from '@oku-ui/primitives'

const props = defineProps<TooltipRootProps & { content?: string }>()
const emits = defineEmits<TooltipRootEmits>()

const forward = useForwardPropsEmits(props, emits)
</script>

<template>
  <TooltipRoot v-bind="forward">
    <TooltipTrigger as-child>
      <slot />
    </TooltipTrigger>
    <TooltipContent
      side="top"
      align="center"
    >
      {{ content }}
      <TooltipArrow
        :width="11"
        :height="5"
      />
    </TooltipContent>
  </TooltipRoot>
</template>

Tooltip ​

Features ​

Anatomy ​

API Reference ​

Provider ​

Root ​

Trigger ​

Portal ​

Content ​

Arrow ​

Examples ​

Configure globally ​

Show instantly ​

Displaying a tooltip from a disabled button ​

Constrain the content size ​

Origin-aware animations ​

Collision-aware animations ​

Accessibility ​

Keyboard Interactions ​

Custom APIs ​

Abstract parts and introduce a content prop ​

Usage ​

Implementation ​

Tooltip