@ui-sdk/vue 0.0.0-stage → 0.1.0-beta.1

package/docs/components/tooltip.md

@@ -0,0 +1,818 @@
+# Tooltip
+
+Name a control or add a short hint on hover and keyboard focus.
+
+A tooltip names a control or adds a short hint when the pointer rests on it or keyboard focus reaches it. Keep it to a few words of plain text.
+
+```vue title="basic.vue"
+<script setup lang="ts">
+import { BookmarkIcon } from "@lucide/vue"
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+</script>
+
+<template>
+  <Tooltip default-open>
+    <TooltipTrigger aria-label="Add to library">
+      <BookmarkIcon aria-hidden="true" />
+    </TooltipTrigger>
+    <TooltipContent>Add to library</TooltipContent>
+  </Tooltip>
+</template>
+```
+
+The tooltip starts open. Hover the button or reach it with Tab to show it again, and Escape closes it while focus stays on the button.
+
+## Installation
+
+```bash
+npm install @ui-sdk/vue @ui-sdk/core
+```
+
+## Composition
+
+Use the following composition to build a `Tooltip`:
+
+```text
+Tooltip
+├── TooltipTrigger
+└── TooltipContent
+    ├── TooltipArrow
+    └── TooltipShortcut
+```
+
+Wrap the trigger and its hint in a tooltip. The arrow and the shortcut are optional.
+
+The content has the `tooltip` role, and it's in the page from the start, hidden, so it names or describes its trigger before focus reaches it. It names a trigger without a name of its own, like a button with only an icon, and describes any other: one with text, an `aria-label` or a `title`. `type="label"` or `type="description"` overrides the guess. Keep it to plain text: a tooltip can't be focused, so links or buttons inside it can't be reached. For anything interactive, use a [Popover](./popover.md) or a [Hover Card](./hover-card.md).
+
+## Usage
+
+Import the parts and put them together:
+
+```vue
+<script setup lang="ts">
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+</script>
+
+<template>
+  <Tooltip>
+    <TooltipTrigger>Share</TooltipTrigger>
+    <TooltipContent>Anyone with the link can view</TooltipContent>
+  </Tooltip>
+</template>
+```
+
+## Side
+
+`side` picks where the tooltip opens: `top` by default. It flips to the other side when there isn't room, and shifts along the trigger to stay on screen. `data-side` says where it landed.
+
+```vue title="side.vue"
+<script setup lang="ts">
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+
+const sides = [
+  { side: "top", label: "Top" },
+  { side: "left", label: "Left" },
+  { side: "right", label: "Right" },
+  { side: "bottom", label: "Bottom" },
+] as const
+</script>
+
+<template>
+  <div data-slot="grid">
+    <Tooltip v-for="{ side, label } in sides" :key="side">
+      <TooltipTrigger>{{ label }}</TooltipTrigger>
+      <TooltipContent :side="side">Add to library</TooltipContent>
+    </Tooltip>
+  </div>
+</template>
+```
+
+Hover Top, Left, Right and Bottom. Each tooltip opens on that side of its button, or flips into the middle when there isn't room.
+
+Add a `TooltipArrow` to point at the trigger. It follows the side the tooltip lands on, including after a flip.
+
+```vue
+<TooltipContent>
+  <TooltipArrow />
+  Add to library
+</TooltipContent>
+```
+
+## Anchor
+
+Position the tooltip against something other than the trigger with `anchor`: an element, a CSS selector, a point like `{ x, y }`, or anything with `getBoundingClientRect()`. Here a small help button inside a field shows its tooltip along the whole field.
+
+```vue title="anchor.vue"
+<script setup lang="ts">
+import { InfoIcon } from "@lucide/vue"
+import { Field, FieldLabel } from "@ui-sdk/vue/field"
+import { Input } from "@ui-sdk/vue/input"
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+import { useTemplateRef } from "vue"
+
+const field = useTemplateRef<HTMLDivElement>("field")
+</script>
+
+<template>
+  <Field>
+    <FieldLabel>Webhook URL</FieldLabel>
+    <div ref="field" data-slot="row">
+      <Input placeholder="https://" />
+      <Tooltip>
+        <TooltipTrigger aria-label="About webhooks">
+          <InfoIcon aria-hidden="true" />
+        </TooltipTrigger>
+        <TooltipContent :anchor="field" side="bottom" align="start">
+          We send a POST request here for every new order.
+        </TooltipContent>
+      </Tooltip>
+    </div>
+  </Field>
+</template>
+```
+
+Hover the help button. The tooltip opens below the Webhook URL field and lines up with its start, not with the button.
+
+## Keyboard Shortcut
+
+`shortcut` on the tooltip, like `"mod+s"`, is a hint for what the trigger's action is bound to, where `mod` is Command on Apple platforms and Control elsewhere. `TooltipShortcut` shows the keys for the platform, `⌘S` or `Ctrl+S`, hidden from screen readers, and the trigger gets `aria-keyshortcuts` so they hear it instead. A `TooltipShortcut` can show other keys with its own `shortcut`.
+
+The tooltip doesn't bind the keys. Register the shortcut yourself with [`registerShortcut`](../utilities/shortcuts.md), as the example does, or use the `shortcut` of a component that binds keys, like a [Dialog](./dialog.md#keyboard-shortcut) trigger.
+
+```vue title="shortcut.vue"
+<script setup lang="ts">
+import { SaveIcon } from "@lucide/vue"
+import { registerShortcut } from "@ui-sdk/core/shortcuts"
+import {
+  Tooltip,
+  TooltipContent,
+  TooltipShortcut,
+  TooltipTrigger,
+} from "@ui-sdk/vue/tooltip"
+import { onMounted, onUnmounted } from "vue"
+import { useLog } from "./log"
+
+const log = useLog()
+const offs: (() => void)[] = []
+
+onMounted(() => {
+  offs.push(
+    registerShortcut("mod+s", () => log("Saved")),
+    registerShortcut("mod+shift+e", () => log("Shared"))
+  )
+})
+onUnmounted(() => offs.forEach((off) => off()))
+</script>
+
+<template>
+  <div data-slot="row">
+    <Tooltip shortcut="mod+s">
+      <TooltipTrigger aria-label="Save" @click="log('Saved')">
+        <SaveIcon aria-hidden="true" />
+      </TooltipTrigger>
+      <TooltipContent>
+        Save
+        <TooltipShortcut />
+      </TooltipContent>
+    </Tooltip>
+    <Tooltip shortcut="mod+shift+e">
+      <TooltipTrigger @click="log('Shared')">Share</TooltipTrigger>
+      <TooltipContent>
+        Share with your team
+        <TooltipShortcut />
+      </TooltipContent>
+    </Tooltip>
+  </div>
+</template>
+```
+
+Hover Save or Share to read its shortcut, then press the button or the keys. The console logs Saved or Shared.
+
+## Disabled Buttons
+
+A natively disabled button can't receive focus, and some browsers send it no pointer events, so its tooltip never shows. When the tooltip explains why an action is unavailable, use `aria-disabled="true"` instead and ignore the button's presses yourself. The button stays in the Tab order, screen readers announce it as dimmed, and the tooltip explains what's missing. `disabled` on the tooltip turns the explanation off once the button works.
+
+```vue title="disabled-button.vue"
+<script setup lang="ts">
+import { Field, FieldLabel } from "@ui-sdk/vue/field"
+import { Input } from "@ui-sdk/vue/input"
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+import { computed, ref } from "vue"
+import { useLog } from "./log"
+
+const log = useLog()
+const title = ref("")
+const blocked = computed(() => !title.value.trim())
+
+function publish() {
+  if (!blocked.value) {
+    log(`Published “${title.value.trim()}”`)
+  }
+}
+</script>
+
+<template>
+  <div data-slot="stack">
+    <Field>
+      <FieldLabel>Post title</FieldLabel>
+      <Input v-model:value="title" />
+    </Field>
+    <Tooltip :disabled="!blocked">
+      <TooltipTrigger data-variant="solid" :aria-disabled="blocked || undefined" @click="publish">
+        Publish
+      </TooltipTrigger>
+      <TooltipContent side="right">Add a title to publish</TooltipContent>
+    </Tooltip>
+  </div>
+</template>
+```
+
+Hover or focus Publish to learn what's missing. Type a title, and Publish works and its tooltip goes away.
+
+## Touch
+
+Touch screens have no hover. A tap on a plain tooltip's trigger only presses it, and the tooltip stays closed, so don't hide anything important in a tooltip.
+
+For an info button whose only job is the tip, add `toggleable`: pressing the trigger opens and closes the tooltip, with a finger, a mouse or the keyboard, and its text is announced when a press opens it. An outside press or Escape closes it too.
+
+```vue title="toggleable.vue"
+<script setup lang="ts">
+import { InfoIcon } from "@lucide/vue"
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+</script>
+
+<template>
+  <div data-slot="row">
+    <span data-slot="label">Storage</span>
+    <Tooltip toggleable>
+      <TooltipTrigger aria-label="About storage" data-size="sm">
+        <InfoIcon aria-hidden="true" />
+      </TooltipTrigger>
+      <TooltipContent>Files in the trash still use storage.</TooltipContent>
+    </Tooltip>
+    <span data-slot="hint">12.4 of 15 GB used</span>
+  </div>
+</template>
+```
+
+Press the info button to open the tip, including on a touch screen. Press it again or anywhere else to close it.
+
+## Keep Open on Press
+
+Pressing the trigger closes the tooltip, so it doesn't cover what the press changed, and it stays closed until the pointer leaves. `:close-on-press="false"` keeps it open, like for a copy button whose tooltip turns into "Copied".
+
+```vue title="copy.vue"
+<script setup lang="ts">
+import { CheckIcon, CopyIcon } from "@lucide/vue"
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+import { ref } from "vue"
+
+const command = "npm install @ui-sdk/vue"
+const copied = ref(false)
+
+function copy() {
+  navigator.clipboard?.writeText(command).catch(() => {})
+  copied.value = true
+}
+</script>
+
+<template>
+  <div data-slot="row">
+    <code>{{ command }}</code>
+    <Tooltip
+      :close-on-press="false"
+      @open-change-complete="(open) => !open && (copied = false)"
+    >
+      <TooltipTrigger :aria-label="copied ? 'Copied' : 'Copy'" @click="copy">
+        <CheckIcon v-if="copied" aria-hidden="true" />
+        <CopyIcon v-else aria-hidden="true" />
+      </TooltipTrigger>
+      <TooltipContent>{{ copied ? "Copied" : "Copy" }}</TooltipContent>
+    </Tooltip>
+  </div>
+</template>
+```
+
+Hover the copy button and press it. The tooltip stays open and changes to Copied.
+
+## Truncated Text
+
+To show a tooltip only when text is cut off, cancel the open in `@open-change` when the text fits. Compare `scrollWidth` with `clientWidth` in the callback. The tooltip repeats the name, so `type="label"` keeps screen readers from hearing it twice.
+
+```vue title="truncated.vue"
+<script setup lang="ts">
+import { FileIcon } from "@lucide/vue"
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+
+const files = [
+  "Quarterly report, final revised version for the board.pdf",
+  "Notes.txt",
+  "Design review recording, October 2nd.mp4",
+  "Budget.xlsx",
+]
+
+const names = new Map<string, HTMLElement>()
+
+function fits(file: string) {
+  const span = names.get(file)
+  return !!span && span.scrollWidth <= span.clientWidth
+}
+</script>
+
+<template>
+  <ul>
+    <li v-for="file in files" :key="file">
+      <Tooltip
+        type="label"
+        @open-change="(open, details) => open && fits(file) && details.cancel()"
+      >
+        <TooltipTrigger>
+          <FileIcon aria-hidden="true" />
+          <span :ref="(el) => el && names.set(file, el as HTMLElement)">{{
+            file
+          }}</span>
+        </TooltipTrigger>
+        <TooltipContent>{{ file }}</TooltipContent>
+      </Tooltip>
+    </li>
+  </ul>
+</template>
+```
+
+Hover or focus each file. Only names that are cut off open a tooltip.
+
+## Controlled
+
+Bind `v-model:open`, or pass `open` and update it in `@open-change`. Every change carries a [reason](#reasons), like `trigger-hover`, `trigger-focus`, `trigger-press`, `escape-key` or `outside-press`. Call `details.cancel()` to stop it. To open the tooltip from anywhere, like a step in a guided tour, use a [controller](#controller).
+
+```vue title="controlled.vue"
+<script setup lang="ts">
+import { CheckIcon } from "@lucide/vue"
+import type { ChangeDetails } from "@ui-sdk/core"
+import { Checkbox, CheckboxIndicator } from "@ui-sdk/vue/checkbox"
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+import { ref } from "vue"
+import { useLog } from "./log"
+
+const log = useLog()
+const open = ref(false)
+const controls = ref<HTMLElement | null>(null)
+
+function onOpenChange(next: boolean, details: ChangeDetails) {
+  const target = details.event?.target
+  const inControls = target instanceof Node && controls.value?.contains(target)
+  if (inControls && details.reason !== "escape-key") {
+    return details.cancel()
+  }
+  log(`${next ? "Opened" : "Closed"} (${details.reason})`)
+}
+</script>
+
+<template>
+  <div data-slot="stack">
+    <div ref="controls" data-slot="controls">
+      <label data-slot="label">
+        <Checkbox v-model:checked="open">
+          <CheckboxIndicator>
+            <CheckIcon aria-hidden="true" />
+          </CheckboxIndicator>
+        </Checkbox>
+        Open
+      </label>
+    </div>
+    <Tooltip v-model:open="open" @open-change="onOpenChange">
+      <TooltipTrigger>Export</TooltipTrigger>
+      <TooltipContent>Download as CSV</TooltipContent>
+    </Tooltip>
+  </div>
+</template>
+```
+
+Check Open, or hover Export. The console logs each change and its reason.
+
+## Shared
+
+A toolbar, a chart or a long list can share one tooltip instead of rendering one per item. Connect the triggers and the tooltip to one `createTooltipController<Payload>()`, and the triggers can sit anywhere on the page. Each trigger passes a `payload`, here its label, and the content reads it from its state, since every part's default slot receives its state. A template can't pass a type argument, so `TooltipContent<string>` in the script makes a content part that types the payload. The content renders before the first open, so handle an `undefined` payload.
+
+Only the trigger that opened the tooltip is described by it, so give each trigger a name of its own, like an `aria-label`. The controller's `open()` takes a payload and an `anchor` too, and on an open tooltip, `open({ payload })` replaces the payload, like another trigger taking it over. `@payload-change` reports each change.
+
+```vue title="shared.vue"
+<script setup lang="ts">
+import { BoldIcon, ItalicIcon, UnderlineIcon } from "@lucide/vue"
+import {
+  createTooltipController,
+  Tooltip,
+  TooltipContent,
+  TooltipTrigger,
+} from "@ui-sdk/vue/tooltip"
+
+const formats = [
+  { icon: BoldIcon, label: "Bold" },
+  { icon: ItalicIcon, label: "Italic" },
+  { icon: UnderlineIcon, label: "Underline" },
+]
+
+const tooltip = createTooltipController<string>()
+const LabelTooltipContent = TooltipContent<string>
+</script>
+
+<template>
+  <div data-slot="row" role="group" aria-label="Formatting">
+    <TooltipTrigger
+      v-for="format in formats"
+      :key="format.label"
+      :controller="tooltip"
+      :payload="format.label"
+      :aria-label="format.label"
+    >
+      <component :is="format.icon" aria-hidden="true" />
+    </TooltipTrigger>
+    <Tooltip :controller="tooltip">
+      <LabelTooltipContent v-slot="{ state }">{{
+        state.payload
+      }}</LabelTooltipContent>
+    </Tooltip>
+  </div>
+</template>
+```
+
+Move along Bold, Italic and Underline. One tooltip follows the pointer and shows each button's label.
+
+## Animation
+
+The content has `data-starting-style` while it opens and `data-ending-style` while it closes. Transition from those states, and the tooltip stays mounted until its exit finishes. Put `transform-origin: var(--transform-origin)` on the content so it grows out of its trigger. A tooltip that opens at once, as the next one in a group does, gets `data-instant`, so skip the transition there.
+
+```css
+[data-slot="tooltip-content"] {
+  transform-origin: var(--transform-origin);
+  transition:
+    opacity 150ms ease-out,
+    scale 150ms ease-out;
+
+  &:is([data-starting-style], [data-ending-style]) {
+    opacity: 0;
+    scale: 0.9;
+  }
+
+  &[data-instant] {
+    transition: none;
+  }
+}
+```
+
+For people who ask for less motion, drop the scale in a `prefers-reduced-motion` query and keep the fade. `@open-change-complete` runs once the tooltip has finished opening or closing, after any animation, with the new open state.
+
+```vue title="animation.vue"
+<script setup lang="ts">
+import { ArchiveIcon } from "@lucide/vue"
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+import { useLog } from "./log"
+
+const log = useLog()
+</script>
+
+<template>
+  <Tooltip
+    @open-change="(open) => log(open ? 'Opening' : 'Closing')"
+    @open-change-complete="(open) => log(open ? 'Open' : 'Closed')"
+  >
+    <TooltipTrigger aria-label="Archive">
+      <ArchiveIcon aria-hidden="true" />
+    </TooltipTrigger>
+    <TooltipContent>Archive</TooltipContent>
+  </Tooltip>
+</template>
+```
+
+Hover Archive, then move away. The tooltip grows out of the button and fades, and the console logs Opening, Open, Closing and Closed.
+
+## Delay and Grouping
+
+`delay` is how long the pointer rests on the trigger before the tooltip opens, 600 milliseconds by default. `close-delay` is how long it stays once the pointer leaves the trigger and the tooltip, 0 by default. Keyboard focus opens it at once.
+
+Tooltips group without a provider. Once one is open, or was a moment ago, hovering the next opens it at once, and only one is open at a time, so moving along a toolbar reads like one tooltip that follows the pointer. A tooltip that opened at once gets `data-instant`, so it can skip its animation.
+
+`disabled` stops a tooltip from opening, while its trigger keeps working.
+
+```vue
+<Tooltip :delay="300" :close-delay="150" :disabled="!showHints">
+```
+
+## Offset
+
+`side-offset` is the gap to the trigger, 4 pixels by default. `align-offset` shifts along it, `align` lines it up with the start, center or end of the trigger, and `collision-padding` is the space kept from the edges of the window.
+
+```vue
+<TooltipContent
+  align="start"
+  :side-offset="8"
+  :align-offset="4"
+  :collision-padding="16"
+/>
+```
+
+## Container
+
+Tooltips render in place and show in the top layer, so no ancestor clips or covers them. `container` renders the tooltip somewhere else, for iframes, shadow roots or a specific stacking context. See the shared [popup guide](../popups.md).
+
+```vue
+<TooltipContent :container="shadowRoot" />
+```
+
+## Custom Rendering
+
+Every part takes a `#render` slot, which receives the props to bind and the part's state. See [Parts and Composition](../parts-and-composition.md) for prop merging and state-based rendering.
+
+```vue title="custom-rendering.vue"
+<script setup lang="ts">
+import { Tooltip, TooltipContent, TooltipTrigger } from "@ui-sdk/vue/tooltip"
+</script>
+
+<template>
+  <Tooltip>
+    <TooltipTrigger data-variant="link">
+      <template #render="{ props }">
+        <a v-bind="props" href="https://example.com/changelog">Changelog</a>
+      </template>
+    </TooltipTrigger>
+    <TooltipContent>See what's new in 2.0</TooltipContent>
+  </Tooltip>
+</template>
+```
+
+Hover Changelog. The trigger renders as a link, and its tooltip says where it goes.
+
+A button can be a tooltip's trigger and another component's trigger at once. Render the tooltip's trigger as a `PopoverTrigger`, and the button opens the popover and is named by the tooltip:
+
+```vue
+<Popover>
+  <Tooltip>
+    <TooltipTrigger>
+      <template #render="{ props }">
+        <PopoverTrigger v-bind="props">
+          <BellIcon aria-hidden="true" />
+        </PopoverTrigger>
+      </template>
+    </TooltipTrigger>
+    <TooltipContent>Notifications</TooltipContent>
+  </Tooltip>
+  <PopoverContent>...</PopoverContent>
+</Popover>
+```
+
+## Styling
+
+Use `data-side` and `data-align` to style the content and arrow for where they landed, and `data-instant` to skip the animation of a tooltip that opened at once. The trigger gets no state attributes of its own, since it's often another component's trigger too, like a menu's. Put `transform-origin: var(--transform-origin)` on the content so it scales from the trigger.
+
+Each part has a `data-slot`, such as `tooltip-content`, and its state attributes are listed under [Data Attributes](#data-attributes).
+
+### TooltipContent
+- `--anchor-width`: Width of the anchor, usually the trigger. Use it to match widths.
+- `--anchor-height`: Height of the anchor.
+- `--available-width`: Space beside the popup, up to the viewport edge. Not inherited either.
+- `--available-height`: Space between the anchor and the viewport edge. Use it for max-height. Not inherited, so a child that needs it copies it on the popup, like `[--list-height:var(--available-height)]`, and reads `max-h-(--list-height)`. The first popup registers both names for the whole page with `CSS.registerProperty`, so they don't inherit anywhere. A page that needs them to inherit calls it first, with `inherits: true`. An `@property` rule can't, since a registration in script wins.
+- `--transform-origin`: The point on the anchor the popup opens from. Use it to scale from the right place.
+- `--arrow-offset`: Where the anchor's center falls along the popup's edge, kept `arrowPadding` from the corners. Position a ::before arrow with it.
+
+## Data Attributes
+
+`TooltipTrigger` and `TooltipShortcut` have no state attributes.
+
+### TooltipContent
+`[data-slot="tooltip-content"]`
+
+- `data-closed`: Present while the tooltip is closed, including while it animates out.
+- `data-open`: Present while the tooltip is open.
+- `data-starting-style`: Present for the first frame. Style the state you animate from.
+- `data-ending-style`: Present while the tooltip animates out. Style the state you animate to.
+
+### TooltipArrow
+`[data-slot="tooltip-arrow"]`
+
+- `data-closed`: Present while the tooltip is closed, including while it animates out.
+- `data-open`: Present while the tooltip is open.
+
+## API Reference
+
+Props are the same as below, and callbacks are events.
+
+### Tooltip
+
+- `container?` (`DocumentFragment | Element | null`): Renders the popup into this element instead of in place, like a container inside a shadow root or an iframe. On web components, a CSS selector. Nested popups stay inside their parent.
+- `open?` (`boolean`): Whether the tooltip is open. Pass it to control the tooltip.
+- `defaultOpen?` (`boolean`): Whether the tooltip starts open, when uncontrolled.
+- `@open-change` (`((open: boolean, details: ChangeDetails<TooltipOpenChangeReason>) => void)`): Runs when the tooltip wants to open or close. `details.reason` says why, and `details.cancel()` stops it.
+- `@open-change-complete` (`((open: boolean) => void)`): Runs once the tooltip has finished opening or closing, after any animation.
+- `@payload-change` (`((payload: unknown, details: ChangeDetails<TooltipPayloadChangeReason>) => void)`): Runs when the payload the content shows changes: a trigger with another payload opens the tooltip, or takes the open tooltip over, which fires no `@open-change`, and so does a controller's `open({ payload })` on the open tooltip. `details.cancel()` keeps the previous payload.
+- `delay?` (`number`): Milliseconds the pointer rests on the trigger before the tooltip opens. While another tooltip is open, or was a moment ago, the next one opens at once, without a provider.
+- `closeDelay?` (`number`): Milliseconds before the tooltip closes once the pointer leaves the trigger and the tooltip.
+- `disabled?` (`boolean`): Stops the tooltip from opening. The trigger keeps working.
+- `toggleable?` (`boolean`): Whether pressing the trigger opens and closes the tooltip, so touch screens can show it too. For info buttons whose only job is the tip. The text is announced when a press opens it.
+- `closeOnPress?` (`boolean`): Whether pressing the trigger closes the tooltip. Set it to `false` to keep it open, like for a copy button whose tooltip turns into "Copied".
+- `type?` (`"description" | "label"`): Whether the tooltip names its trigger (`"label"`) or adds a description to it (`"description"`). By default it names a trigger that has no name of its own, like an icon button, and describes any other.
+- `shortcut?` (`string`): The keyboard shortcut of what the trigger does, like `"mod+s"`, as a hint. A `TooltipShortcut` shows it, and the trigger gets `aria-keyshortcuts`. It doesn't bind the keys: the trigger's own `shortcut`, or `registerShortcut`, does.
+- `controller?` (`PopupController<any, TooltipOpenChangeReason, {}, string, TooltipPayloadChangeReason>`): Opens, closes and inspects the tooltip from anywhere, and connects triggers outside it. Create one with `createTooltipController()`.
+- `debug?` (`boolean`): Logs every state change with its reason to the console, in development builds.
+
+### TooltipTrigger
+
+A trigger outside the tooltip also takes `controller`.
+
+- `payload?` (`unknown`): Data for the content to render when this trigger opens the tooltip, like the row it belongs to.
+- `controller?` (`PopupController<any, TooltipOpenChangeReason, {}, string, TooltipPayloadChangeReason>`): Connects a trigger outside the tooltip, like one per table row, to the tooltip with this controller.
+
+### TooltipContent
+
+- `side?` (`Side`): Which side of the anchor the popup opens on. Flips to the other side when there isn't room. Which side of the trigger the tooltip opens on.
+- `align?` (`Align`): How the popup lines up with the anchor along that side. `start` and `end` follow the reading direction. How the tooltip lines up with the trigger along that side.
+- `sideOffset?` (`number`): Gap between the anchor and the popup, in pixels. Gap between the trigger and the tooltip, in pixels.
+- `alignOffset?` (`number`): Shift along the anchor, in pixels. Shift along the trigger, in pixels.
+- `collisionPadding?` (`number`): Space to keep from the viewport edges, in pixels.
+- `arrowPadding?` (`number`): Space to keep between the arrow and the popup's corners, in pixels.
+- `anchor?` (`string | Anchor | null`): Positions the popup against this instead of its trigger: an element, a CSS selector, a point like `{ x, y }`, or anything with `getBoundingClientRect()`. It's read on every check, so it can move. A controller's `open({ anchor })` wins for that open.
+- `container?` (`DocumentFragment | Element | null`): Renders the popup into this element instead of in place, like a container inside a shadow root or an iframe. On web components, a CSS selector. Nested popups stay inside their parent.
+
+### TooltipArrow
+
+Points at the trigger from the side the tooltip landed on. Renders a `div`.
+
+### TooltipShortcut
+
+- `shortcut?` (`string`): The keys to show. By default, the tooltip's `shortcut`.
+
+### State
+
+What render functions, state-based class names and slots receive, per part.
+
+`TooltipTrigger`:
+
+- `open` (`boolean`): Whether the tooltip is open from this trigger.
+
+`TooltipContent`:
+
+- `open` (`boolean`): Whether the tooltip is open. False while it animates out.
+- `instant` (`boolean`): Whether it opened at once, because another tooltip was open a moment ago. Animations can skip.
+- `payload` (`Payload | undefined`): The payload of the last open, from the trigger that opened it or a controller, typed as the controller's `Payload`.
+
+`TooltipArrow`:
+
+- `open` (`boolean`): Whether the tooltip is open. False as soon as it starts closing, while it still animates out.
+
+`TooltipShortcut`:
+
+- `text` (`string`): The shortcut formatted for this platform: `⌘S` on Apple platforms and `Ctrl+S` elsewhere. Empty without one.
+
+### Reasons
+
+`details.reason` says why the tooltip opened or closed.
+
+- `trigger-hover` (`PointerEvent`): The pointer rested on a trigger, or left it, with hover opening.
+- `trigger-focus` (`FocusEvent`): Keyboard focus reached a trigger that opens on focus, like a tooltip's.
+- `trigger-press` (`MouseEvent | KeyboardEvent | TouchEvent`): Click, tap, Enter or Space on the part that opens, closes or toggles. Arrow keys that open a menu or submenu count too. A tap on a combobox's input that opens a sheet reports its `touchend`.
+- `focus-out` (`KeyboardEvent | FocusEvent`): Focus left the layer, or Tab moved it out.
+- `escape-key` (`KeyboardEvent`): Escape, or a submenu's close key (ArrowLeft in left-to-right layouts).
+- `close-press` (`MouseEvent | KeyboardEvent | SubmitEvent`): A Close part was pressed, or a form with `method="dialog"` was submitted.
+- `outside-press` (`MouseEvent`): A press outside the layer.
+- `window-blur` (`FocusEvent`): The window lost focus.
+- `back` (`Event`): Going back: the Android back button or gesture, or Backspace in an empty command input, which returns to the previous page.
+- `imperative` (`none`): A controller or `api` call, or a property set on a web component.
+
+For a payload change, it says what opened the tooltip or took it over.
+
+- `trigger-hover` (`PointerEvent`): The pointer rested on a trigger, or left it, with hover opening.
+- `trigger-focus` (`FocusEvent`): Keyboard focus reached a trigger that opens on focus, like a tooltip's.
+- `trigger-press` (`MouseEvent | KeyboardEvent | TouchEvent`): Click, tap, Enter or Space on the part that opens, closes or toggles. Arrow keys that open a menu or submenu count too. A tap on a combobox's input that opens a sheet reports its `touchend`.
+- `imperative` (`none`): A controller or `api` call, or a property set on a web component.
+
+### Controller
+
+Create one with `createTooltipController<Payload>()` and pass it as `controller`, to the tooltip and to any
+triggers outside it. `Payload` is the type of the data triggers and `open()` pass.
+
+Every write method takes an optional `{ reason, event }`, passed to `@open-change`.
+
+- `isOpen()` (`() => boolean`): Whether it's open. False as soon as it starts closing, while it still animates out.
+- `setOpen(open, options?)` (`(open: boolean, options?: PopupChangeOptions<TooltipOpenChangeReason> | undefined) => boolean`): Opens or closes it. Returns false when the change was canceled or it was already open or closed.
+- `open(options?)` (`(options?: (PopupChangeOptions<TooltipPayloadChangeReason> & { payload?: Payload | undefined; anchor?: Anchor | undefined; signal?: AbortSignal | undefined; }) | undefined) => Promise<...>`): Opens it, and resolves once it closes, with why, how and any return value. Resolves exactly once and never rejects: on the next close from any source, when `signal` aborts, or with reason `"unmount"` when the component leaves the page.
+- `close(options?)` (`(options?: (PopupChangeOptions<TooltipOpenChangeReason> & { returnValue?: string | undefined; }) | undefined) => boolean`): Closes it. `returnValue` is passed to the promise `open()` returned. Returns false when the close was canceled or it was already closed.
+- `toggle(options?)` (`(options?: PopupChangeOptions<TooltipOpenChangeReason> | undefined) => boolean`): Opens it when it's closed, and closes it when it's open. Returns false when the change was canceled.
+- `getPayload()` (`() => Payload | undefined`): The payload of the last open, from a controller or the trigger that opened it.
+- `focus()` (`() => void`): Moves focus to the trigger that opened it last, or the first trigger.
+
+### Events
+
+Events get the new state first, then the details. `v-model` only updates when `@open-change` wasn't canceled.
+
+| Binding                 | On        | Receives                                                                    |
+| ----------------------- | --------- | --------------------------------------------------------------------------- |
+| `v-model:open`          | `Tooltip` | Whether the tooltip is open                                                 |
+| `@open-change`          | `Tooltip` | `(open, details)`: the new state, and the [reason](#reasons)                |
+| `@open-change-complete` | `Tooltip` | `(open)`, after the animation                                               |
+| `@payload-change`       | `Tooltip` | `(payload, details)`: the content's new payload, and the [reason](#reasons) |
+
+## Accessibility
+
+The trigger is named or described by the tooltip, following the [WAI-ARIA tooltip pattern](https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/). It opens on hover and on keyboard focus, and stays open while the pointer moves onto it.
+
+### Keyboard
+
+| Key          | Does                                                                                           |
+| ------------ | ---------------------------------------------------------------------------------------------- |
+| Tab          | Focus on the trigger opens the tooltip at once; focus leaving it closes the tooltip            |
+| Escape       | Closes the tooltip and leaves focus on the trigger, without closing a dialog or menu around it |
+| Enter, Space | Presses the trigger and closes the tooltip; on a `toggleable` trigger, opens and closes it     |
+
+### Tested Behavior
+
+Every line below is an automated test.
+
+**Pointer**
+
+- Resting the pointer on the trigger opens the tooltip.
+- The tooltip waits for its delay before opening.
+- Leaving the trigger before the delay keeps the tooltip closed.
+- Moving the pointer away closes the tooltip.
+- The pointer can move onto the tooltip without closing it.
+- Opening on hover leaves focus where it was.
+- Pressing the trigger closes the tooltip and runs the button.
+- After a press, the tooltip stays closed until the pointer comes back.
+
+**Keyboard**
+
+- Keyboard focus on the trigger opens the tooltip.
+- Focus leaving the trigger closes the tooltip.
+- Escape closes the tooltip and leaves focus on the trigger.
+- Escape closes a tooltip opened by hover.
+- Tab through the toolbar shows each tooltip in turn.
+- A click that focuses the trigger doesn't open the tooltip from focus.
+
+**Several tooltips**
+
+- Only one tooltip is open at a time.
+- Once the pointer has been away a while, the delay applies again.
+
+**Positioning**
+
+- The tooltip opens above the trigger.
+- The tooltip flips below the trigger when there is no room above.
+- The tooltip opens on the requested side.
+- The arrow points at the middle of the trigger.
+
+**A tooltip on a popover trigger**
+
+- Hovering shows the tooltip, and pressing opens the popover instead.
+- Escape closes the tooltip and leaves the popover open.
+
+**Disabled buttons**
+
+- Browsers send hover events to a disabled button.
+- An aria-disabled trigger shows its tooltip on hover and focus and ignores presses.
+
+**Animation**
+
+- The tooltip animates in from its starting style.
+- The tooltip stays in the page while it animates out.
+
+**Hidden while closed**
+
+- A class that sets display on the content doesn't show it while closed.
+
+**Options and dismissal**
+
+- Escape closes only a tooltip that keyboard focus opened inside a popover.
+- The pointer can leave the trigger sideways on its way to the tooltip.
+- With closeOnPress false, pressing the trigger keeps the tooltip open.
+- Disabled tooltips never open.
+- A tap on a plain tooltip's trigger only presses it.
+
+Runs in React, Vue and web components.
+
+Also tested:
+
+**Enhancements**
+
+- Focus returning to the trigger after its popover closes doesn't reopen the tooltip.
+- Tooltips open at once after another one, without a provider.
+- Focus coming back with the window doesn't reopen the tooltip.
+- A controller opens the tooltip without moving focus.
+- A trigger that's a disabled button warns in development.
+
+**Shortcuts**
+
+- A trigger connected through a controller shows its tooltip's shortcut in a Shortcut part.
+
+**Toggleable**
+
+- Pressing a toggleable trigger opens and closes the tooltip.
+- Pressing outside closes a toggleable tooltip.
+- Enter toggles the tooltip from the keyboard and keeps focus on the trigger.
+- A press announces the tooltip's text to screen readers.
+- A tap opens a toggleable tooltip on a touch screen.
+
+Runs in React, Vue and web components.
+
+Screen readers hear the same thing in each tested framework, recorded by a virtual screen reader:
+
+- Announcements while tabbing through triggers with tooltips.
+
+Runs in React, Vue and web components.