@vobs/ui 0.2.0 → 1.0.0

package/dist/overlay.d.ts

@@ -1,304 +0,0 @@
-/** @license MIT
- * Copyright (c) 2026 vobsjs
- * @vobs/ui
- */
-import { type UiAttributes, type UiDomPlan } from './primitives.js';
-export type OverlayCloseReason = 'escape' | 'outside' | 'programmatic';
-export type OverlayKind = 'context-menu' | 'dialog' | 'dropdown' | 'popover' | 'tooltip';
-export type OverlayPlacement = 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'right' | 'top' | 'top-start' | 'top-end';
-export type DialogSize = 'lg' | 'md' | 'sm';
-export type OverlayActionTone = 'danger' | 'default' | 'primary';
-export type TooltipOpenStrategy = 'focus' | 'hover' | 'manual' | 'touch';
-export type DropdownItemKind = 'checkbox' | 'item' | 'radio' | 'separator' | 'submenu';
-export type DropdownMenuItemPermission = 'allowed' | 'denied';
-export type DropdownMenuPermissionRemoteState = 'empty' | 'permission-limited' | 'remote-pending' | 'submenu-error' | 'ready';
-export type DropdownMenuItemRemoteActionState = 'available' | 'disabled' | 'pending';
-export type DropdownMenuItemSubmenuState = 'closed' | 'error' | 'loading' | 'open' | 'ready';
-export type DropdownMenuSubmenuPortalState = 'closed' | 'mounted' | 'open' | 'portal-missing';
-export type DropdownMenuSubmenuPortalContractState = 'closed' | 'empty' | 'mounted' | 'open' | 'portal-missing';
-export interface OverlayStackOptions {
-    readonly document: Document;
-    readonly portalTarget?: HTMLElement;
-    readonly scrollLockTarget?: HTMLElement;
-}
-export interface OpenOverlayOptions {
-    readonly id: string;
-    readonly kind?: OverlayKind;
-    readonly modal?: boolean;
-    readonly restoreFocus?: boolean;
-    readonly closeOnEscape?: boolean;
-    readonly closeOnOutside?: boolean;
-    readonly element?: HTMLElement;
-    readonly initialFocus?: HTMLElement;
-    readonly onClose?: (reason: OverlayCloseReason) => void;
-}
-export interface OverlayHandle {
-    readonly id: string;
-    readonly kind: OverlayKind;
-    readonly modal: boolean;
-    readonly layer: number;
-    readonly plans: OverlayPlans;
-    readonly element?: HTMLElement;
-    close(reason?: OverlayCloseReason): void;
-    destroy(): void;
-}
-export interface OverlayPlans {
-    readonly root: UiDomPlan<'div'>;
-    readonly backdrop?: UiDomPlan<'div'>;
-    readonly surface: UiDomPlan<'div'>;
-}
-export interface DialogPlanOptions {
-    readonly id: string;
-    readonly titleId: string;
-    readonly descriptionId?: string;
-    readonly modal?: boolean;
-}
-export interface PositionedOverlayPlanOptions {
-    readonly id: string;
-    readonly kind: Exclude<OverlayKind, 'dialog'>;
-    readonly placement?: OverlayPlacement;
-}
-export interface DialogAction {
-    readonly id: string;
-    readonly label: string;
-    readonly tone?: OverlayActionTone;
-    readonly disabled?: boolean;
-}
-export interface ProductDialogPlanOptions extends DialogPlanOptions {
-    readonly size?: DialogSize;
-    readonly tone?: OverlayActionTone;
-    readonly closeLabel?: string;
-    readonly actions?: readonly DialogAction[];
-}
-export interface ProductDialogPlans extends OverlayPlans {
-    readonly header: UiDomPlan<'header'>;
-    readonly title: UiDomPlan<'h2'>;
-    readonly description?: UiDomPlan<'p'>;
-    readonly closeButton?: UiDomPlan<'button'>;
-    readonly body: UiDomPlan<'div'>;
-    readonly footer?: UiDomPlan<'footer'>;
-    readonly actions: readonly UiDomPlan<'button'>[];
-}
-export interface OverlayTriggerPlanOptions {
-    readonly id: string;
-    readonly controlsId: string;
-    readonly label: string;
-    readonly open?: boolean;
-    readonly disabled?: boolean;
-    readonly kind?: Exclude<OverlayKind, 'dialog'>;
-}
-export interface TooltipPlanOptions {
-    readonly id: string;
-    readonly triggerId: string;
-    readonly label: string;
-    readonly placement?: OverlayPlacement;
-    readonly open?: boolean;
-    readonly strategy?: TooltipOpenStrategy;
-    readonly delayMs?: number;
-    readonly disabled?: boolean;
-}
-export interface TooltipPlans extends OverlayPlans {
-    readonly trigger: UiDomPlan<'button'>;
-    readonly arrow: UiDomPlan<'span'>;
-}
-export interface PopoverPlanOptions {
-    readonly id: string;
-    readonly triggerId: string;
-    readonly label: string;
-    readonly titleId?: string;
-    readonly descriptionId?: string;
-    readonly placement?: OverlayPlacement;
-    readonly open?: boolean;
-}
-export interface PopoverPlans extends OverlayPlans {
-    readonly trigger: UiDomPlan<'button'>;
-    readonly arrow: UiDomPlan<'span'>;
-    readonly header?: UiDomPlan<'header'>;
-    readonly title?: UiDomPlan<'h3'>;
-    readonly body: UiDomPlan<'div'>;
-    readonly footer?: UiDomPlan<'footer'>;
-}
-export interface DropdownMenuItem {
-    readonly id: string;
-    readonly label: string;
-    readonly kind?: DropdownItemKind;
-    readonly disabled?: boolean;
-    readonly danger?: boolean;
-    readonly checked?: boolean;
-    readonly expanded?: boolean;
-    readonly shortcut?: string;
-    readonly groupId?: string;
-    readonly disabledReason?: string;
-    readonly permission?: DropdownMenuItemPermission;
-    readonly remoteAction?: boolean;
-    readonly remoteActionDisabled?: boolean;
-    readonly remoteActionDisabledReason?: string;
-    readonly remoteActionError?: string;
-    readonly remoteActionLoading?: boolean;
-    readonly submenuError?: string;
-    readonly submenuItemCount?: number;
-    readonly submenuLoading?: boolean;
-    readonly submenuPortalState?: DropdownMenuSubmenuPortalState;
-    readonly submenuPortalTargetId?: string;
-    readonly submenuOpenPathIndex?: number;
-    readonly submenuFocusReturnId?: string;
-    readonly submenuParentOverlayId?: string;
-    readonly submenuPlacement?: OverlayPlacement;
-}
-export interface DropdownMenuPlanOptions {
-    readonly id: string;
-    readonly triggerId: string;
-    readonly label: string;
-    readonly items: readonly DropdownMenuItem[];
-    readonly activeId?: string;
-    readonly placement?: OverlayPlacement;
-    readonly open?: boolean;
-}
-export interface DropdownMenuPlans extends OverlayPlans {
-    readonly trigger: UiDomPlan<'button'>;
-    readonly menu: UiDomPlan<'div'>;
-    readonly items: readonly UiDomPlan<'div'>[];
-    readonly shortcuts: readonly UiDomPlan<'kbd'>[];
-}
-export interface ContextMenuPlanOptions extends Omit<DropdownMenuPlanOptions, 'triggerId'> {
-    readonly x?: number;
-    readonly y?: number;
-}
-export interface ContextMenuPlans extends OverlayPlans {
-    readonly menu: UiDomPlan<'div'>;
-    readonly items: readonly UiDomPlan<'div'>[];
-    readonly shortcuts: readonly UiDomPlan<'kbd'>[];
-}
-export interface DropdownMenuPermissionRemoteActionContractOptions {
-    readonly items: readonly DropdownMenuItem[];
-    readonly allowedIds?: ReadonlySet<string> | readonly string[];
-    readonly deniedIds?: ReadonlySet<string> | readonly string[];
-    readonly disabledReasons?: Readonly<Record<string, string | undefined>>;
-    readonly remoteActionIds?: ReadonlySet<string> | readonly string[];
-    readonly remoteActionDisabledIds?: ReadonlySet<string> | readonly string[];
-    readonly remoteActionDisabledReasons?: Readonly<Record<string, string | undefined>>;
-    readonly remoteActionLoadingIds?: ReadonlySet<string> | readonly string[];
-    readonly remoteActionErrors?: Readonly<Record<string, string | undefined>>;
-    readonly submenuLoadingIds?: ReadonlySet<string> | readonly string[];
-    readonly submenuErrors?: Readonly<Record<string, string | undefined>>;
-    readonly submenuItemCounts?: Readonly<Record<string, number | undefined>>;
-    readonly disabled?: boolean;
-}
-export interface DropdownMenuPermissionRemoteActionItemContract {
-    readonly id: string;
-    readonly item: DropdownMenuItem;
-    readonly permission: DropdownMenuItemPermission;
-    readonly disabled: boolean;
-    readonly disabledReason: string;
-    readonly remoteAction: boolean;
-    readonly remoteActionState: DropdownMenuItemRemoteActionState;
-    readonly remoteActionDisabledReason: string;
-    readonly remoteActionError: string;
-    readonly submenuState: DropdownMenuItemSubmenuState | undefined;
-    readonly submenuError: string;
-    readonly submenuItemCount: number | undefined;
-    readonly attrs: UiAttributes;
-}
-export interface DropdownMenuPermissionRemoteActionContract {
-    readonly state: DropdownMenuPermissionRemoteState;
-    readonly disabled: boolean;
-    readonly itemCount: number;
-    readonly allowedCount: number;
-    readonly deniedCount: number;
-    readonly disabledReasonCount: number;
-    readonly remoteActionCount: number;
-    readonly remoteActionDisabledCount: number;
-    readonly remoteActionLoadingCount: number;
-    readonly remoteActionErrorCount: number;
-    readonly submenuLoadingCount: number;
-    readonly submenuErrorCount: number;
-    readonly allowedIds: readonly string[];
-    readonly deniedIds: readonly string[];
-    readonly remoteActionIds: readonly string[];
-    readonly remoteActionDisabledIds: readonly string[];
-    readonly remoteActionLoadingIds: readonly string[];
-    readonly remoteActionErrorIds: readonly string[];
-    readonly submenuLoadingIds: readonly string[];
-    readonly submenuErrorIds: readonly string[];
-    readonly items: readonly DropdownMenuPermissionRemoteActionItemContract[];
-    readonly attrs: UiAttributes;
-}
-export interface DropdownMenuSubmenuPortalStateContractOptions {
-    readonly items: readonly DropdownMenuItem[];
-    readonly openPathIds?: readonly string[];
-    readonly mountedIds?: ReadonlySet<string> | readonly string[];
-    readonly portalTargetIds?: Readonly<Record<string, string | undefined>>;
-    readonly focusReturnIds?: Readonly<Record<string, string | undefined>>;
-    readonly parentOverlayIds?: Readonly<Record<string, string | undefined>>;
-    readonly placements?: Readonly<Record<string, OverlayPlacement | undefined>>;
-}
-export interface DropdownMenuSubmenuPortalItemContract {
-    readonly id: string;
-    readonly item: DropdownMenuItem;
-    readonly state: DropdownMenuSubmenuPortalState;
-    readonly open: boolean;
-    readonly mounted: boolean;
-    readonly portalTargetId: string;
-    readonly focusReturnId: string;
-    readonly parentOverlayId: string;
-    readonly placement: OverlayPlacement | undefined;
-    readonly openPathIndex: number | undefined;
-    readonly attrs: UiAttributes;
-}
-export interface DropdownMenuSubmenuPortalStateContract {
-    readonly state: DropdownMenuSubmenuPortalContractState;
-    readonly submenuCount: number;
-    readonly openCount: number;
-    readonly mountedCount: number;
-    readonly portalMissingCount: number;
-    readonly openPathIds: readonly string[];
-    readonly mountedIds: readonly string[];
-    readonly portalMissingIds: readonly string[];
-    readonly portalTargetIds: readonly string[];
-    readonly items: readonly DropdownMenuSubmenuPortalItemContract[];
-    readonly attrs: UiAttributes;
-}
-export interface PopconfirmPlanOptions {
-    readonly id: string;
-    readonly triggerId: string;
-    readonly label: string;
-    readonly titleId: string;
-    readonly descriptionId?: string;
-    readonly placement?: OverlayPlacement;
-    readonly open?: boolean;
-    readonly tone?: OverlayActionTone;
-    readonly confirmLabel?: string;
-    readonly cancelLabel?: string;
-}
-export interface PopconfirmPlans extends OverlayPlans {
-    readonly trigger: UiDomPlan<'button'>;
-    readonly arrow: UiDomPlan<'span'>;
-    readonly title: UiDomPlan<'h3'>;
-    readonly description?: UiDomPlan<'p'>;
-    readonly footer: UiDomPlan<'footer'>;
-    readonly cancelButton: UiDomPlan<'button'>;
-    readonly confirmButton: UiDomPlan<'button'>;
-}
-export interface OverlayStack {
-    readonly size: number;
-    readonly top: OverlayHandle | undefined;
-    open(options: OpenOverlayOptions): OverlayHandle;
-    destroy(): void;
-}
-export declare function createOverlayStack(options: OverlayStackOptions): OverlayStack;
-export declare function createDialogOverlayPlans(options: DialogPlanOptions): OverlayPlans;
-export declare function createModalOverlayPlans(options: Omit<DialogPlanOptions, 'modal'>): OverlayPlans;
-export declare function createPositionedOverlayPlans(options: PositionedOverlayPlanOptions): OverlayPlans;
-export declare function createDialogPlans(options: ProductDialogPlanOptions): ProductDialogPlans;
-export declare function createOverlayTriggerPlan(options: OverlayTriggerPlanOptions): UiDomPlan<'button'>;
-export declare function createTooltipPlans(options: TooltipPlanOptions): TooltipPlans;
-export declare function createPopoverPlans(options: PopoverPlanOptions): PopoverPlans;
-export declare function createDropdownMenuPlans(options: DropdownMenuPlanOptions): DropdownMenuPlans;
-export declare function createContextMenuPlans(options: ContextMenuPlanOptions): ContextMenuPlans;
-export declare function createDropdownMenuPermissionRemoteActionContract(options: DropdownMenuPermissionRemoteActionContractOptions): DropdownMenuPermissionRemoteActionContract;
-export declare function createDropdownMenuSubmenuPortalStateContract(options: DropdownMenuSubmenuPortalStateContractOptions): DropdownMenuSubmenuPortalStateContract;
-export declare function createPopconfirmPlans(options: PopconfirmPlanOptions): PopconfirmPlans;
-export declare function getNextDropdownItemId(items: readonly DropdownMenuItem[], activeId: string | undefined, key: string): string | undefined;
-export declare function shouldOpenOverlayForTriggerKey(key: string): boolean;
-export declare function shouldCloseOverlayForKey(key: string): boolean;
-export declare function shouldSelectDropdownItem(key: string): boolean;