import type { JSX } from "@solidjs/web"; import { type Accessor, createContext, createMemo, useContext } from "solid-js"; import { createPopupCore } from "../internals/create-popup-core"; import { type MaybeAccessor, readOption } from "../internals/maybe-accessor"; import { SNAPSHOT_KEYS, type Snapshottable, snapshotKeys, } from "../internals/observability/snapshot"; /** * Why the popover's open state changed. * * - `"trigger-press"` — trigger was clicked or keyboard-activated. * - `"escape-key"` — Escape dismissed the popover. * - `"outside-press"` — pointer pressed outside. * - `"close-button"` — `` was pressed. * - `"imperative"` — `p.setOpen()` called programmatically. */ export type PopoverChangeReason = | "trigger-press" | "escape-key" | "outside-press" | "close-button" | "imperative"; import type { PopoverModalKind } from "./popover-root-context"; export type { PopoverModalKind }; /** * Options for {@link createPopover}. */ export interface CreatePopoverOptions { /** * Open state. Consumer-owned signal. */ open: MaybeAccessor; /** * Whether interaction is suppressed. * @default false */ disabled?: MaybeAccessor; /** * Modal surface kind. * @default false */ modal?: MaybeAccessor; /** * Pre-change callback fired via `runWithOwner(null, ...)`. */ onOpenChange?: ( open: boolean, event: Event, reason: PopoverChangeReason, ) => void; } /** * Public API returned by {@link createPopover}. */ export interface PopoverApi { /** Reactive accessor for the current open state. */ open: Accessor; /** Whether interaction is suppressed. */ disabled: Accessor; /** Modal surface kind. */ modal: Accessor; /** Imperative open setter. */ setOpen: (next: boolean, event?: Event, reason?: PopoverChangeReason) => void; /** Flip open (no-op when disabled). */ toggle: (event?: Event, reason?: PopoverChangeReason) => void; /** Context provider. */ Provider: (props: { children: JSX.Element }) => JSX.Element; } const PopoverContext = createContext(null); /** * Read the nearest {@link PopoverApi}. Throws unless `optional` is true. */ export function usePopover(): PopoverApi; export function usePopover(optional: true): PopoverApi | null; export function usePopover(optional?: boolean): PopoverApi | null { const ctx = useContext(PopoverContext); if (ctx == null && !optional) { throw new Error( "Base UI: usePopover() must be called inside a .", ); } return ctx; } /** * Headless primitive for a popover compound. Owns logical state — open, * disabled, modal kind. DOM machinery lives in ``. */ export function createPopover(options: CreatePopoverOptions): PopoverApi { const core = createPopupCore({ open: options.open, disabled: options.disabled, onOpenChange: options.onOpenChange, }); const modal = createMemo( () => readOption(options.modal) ?? false, { name: "popover.modal" }, ); const api: PopoverApi = { open: core.open, disabled: core.disabled, modal, setOpen: core.setOpen, toggle: core.toggle, Provider: (props) => ( {props.children} ), }; (api as PopoverApi & Snapshottable)[SNAPSHOT_KEYS] = POPOVER_SNAPSHOT_KEYS; return api; } const POPOVER_SNAPSHOT_KEYS = snapshotKeys( "open", "disabled", "modal", );