Surfacesduskmoonimplemented1 demos

Tooltip

Tooltip adds short explanatory text to compact controls.

Import@duskmoon-dev/components/tooltip
3API sections
8documented props
6behavior scenarios
Key API
titleplacementopendefaultOpenonOpenChangearrow

Usage

When to use

  • Use it when supporting content should stay attached to a trigger or task context.
  • Prefer controlled open state when the surrounding workflow needs to react to dismissal.

Implementation notes

StylesheetImport @duskmoon-dev/components/styles.css once in the app or docs shell.
StateStart with default props for static examples, then switch to controlled props when state must be shared.
ThemeThe preview inherits the active DuskMoon data-theme value from the docs layout.

Features

Contextual surface

Documents trigger, placement, and open-state patterns for content rendered above the page.

Dismissal behavior

Highlights controlled state and close callbacks where overlays expose them.

Primary API surface

Tooltip is most often configured through `title`, `placement`, `open`, `defaultOpen`.

Covered behavior

Renders child content

Feature Demos

Feature demos are authored for the component page, then supplemented with behavior scenarios from the component test coverage.

Preview
Review the project settings before publishing.

Tooltip is closed.

Native interest hint

authored

Hover or focus the native button to show a brief noninteractive description. The browser controls hint visibility; the status reflects actual onOpenChange callbacks. Requires browser support for Interest Invokers, hint popovers and CSS Anchor Positioning.

Source
import React, { useState } from "react";
import "@duskmoon-dev/components/styles.css";
import { Tooltip } from "@duskmoon-dev/components/tooltip";

export function TooltipInterestPreview() {
  const [open, setOpen] = useState(false);

  return (
    <div data-overlay-tooltip-demo style={{ display: "grid", gap: "0.75rem", justifyItems: "start" }}>
      <Tooltip
        title="Review the project settings before publishing."
        onOpenChange={setOpen}
      >
        <button className="btn btn-outlined" type="button">Review settings</button>
      </Tooltip>
      <p role="status" aria-atomic="true">Tooltip is {open ? "open" : "closed"}.</p>
    </div>
  );
}

API

The API reference below lists every parsed exported type or interface for Tooltip. Start with `title`, `placement`, `open`, `defaultOpen` for common usage.

Types: packages/components/src/components/tooltip/Tooltip.types.tsScenarios: packages/components/src/components/tooltip/Tooltip.test.tsx
TooltipPropsinterface extends Omit<ComponentProps<"span">, "title">
PropTypeRequiredDescription
titleReactNodeNotitle configures Tooltip.
placementTooltipPlacementNoplacement configures Tooltip.
openbooleanNoopen configures Tooltip.
defaultOpenbooleanNodefaultOpen configures Tooltip.
onOpenChange(open: boolean) => voidNoCalled when native interest changes visibility, or a controlled interaction requests it. Controlled tooltips use manual popovers and stay open until `open` changes.
arrowbooleanNo@deprecated Native tooltips follow Core's arrowless automatic placement.
sizeTooltipSizeNosize configures Tooltip.
childrenReactNodeYeschildren configures Tooltip.
TooltipPlacementtype
Type definition
"top" | "bottom" | "left" | "right"
TooltipSizetype
Type definition
"sm" | "md" | "lg"