react-os-shell 4.21.1 → 4.41.0

package/dist/{index-Czn1re5M.d.ts → index-B4RRJ5bp.d.ts}

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { ButtonHTMLAttributes, ReactNode, InputHTMLAttributes, TextareaHTMLAttributes, SelectHTMLAttributes, LabelHTMLAttributes, ElementType, CSSProperties, RefObject } from 'react';
+import { ButtonHTMLAttributes, ReactNode, InputHTMLAttributes, TextareaHTMLAttributes, SelectHTMLAttributes, LabelHTMLAttributes, ElementType, MouseEvent, CSSProperties, RefObject } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
@@ -10,9 +10,9 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
  * it lets someone tell what the button costs WITHOUT reading it, which under
  * time pressure is what actually happens.
  */
-type ButtonVariant = 'primary' | 'secondary' | 'ghost' | 'ghost-danger' | 'danger';
+type ButtonVariant = 'primary' | 'secondary' | 'ghost' | 'ghost-danger' | 'danger' | 'link';
 /**
- * `sm`/`md` are the desktop scale. The `touch-*` rungs are for a finger on
+ * `sm`/`md`/`lg` are the desktop scale. The `touch-*` rungs are for a finger on
  * glass — a till, a warehouse tablet — and are a SEPARATE ladder on purpose:
  * a till's idea of "medium" is 56px, and naming it `md` would have made the
  * same word mean two sizes depending on which app you were reading.
@@ -20,7 +20,7 @@ type ButtonVariant = 'primary' | 'secondary' | 'ghost' | 'ghost-danger' | 'dange
  * Nothing picks a touch size automatically. An app that wants them asks for
  * them, so a desktop portal cannot grow finger-sized buttons by accident.
  */
-type ButtonSize = 'sm' | 'md' | 'touch-sm' | 'touch' | 'touch-lg' | 'touch-xl';
+type ButtonSize = 'sm' | 'md' | 'lg' | 'touch-sm' | 'touch' | 'touch-lg' | 'touch-xl';
 interface ButtonProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'className'> {
     variant?: ButtonVariant;
     size?: ButtonSize;
@@ -45,6 +45,31 @@ interface ButtonProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'cla
 }
 declare const Button: react.ForwardRefExoticComponent<ButtonProps & react.RefAttributes<HTMLButtonElement>>;
 
+interface IconButtonProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'className' | 'children'> {
+    /** The icon. Sized by the caller — the kit does not resize what it is given. */
+    children: ReactNode;
+    /**
+     * What the button does, in words. Required: there is no text to read, so
+     * without this the control is unusable to anyone not looking at it.
+     */
+    'aria-label': string;
+    /**
+     * Defaults to `ghost`, where `Button` defaults to `primary`. An icon with no
+     * label is almost always a secondary action — a row's overflow menu, a copy
+     * affordance, a close — and a grid of solid blue squares is not what any of
+     * those want. Ask for `primary` on the rare icon-only main action.
+     */
+    /**
+     * `link` is excluded: it exists to shed the box, and a square icon button is
+     * nothing but the box. Asking for it would produce a bare coloured glyph
+     * with a 40px hit area it no longer draws.
+     */
+    variant?: Exclude<ButtonVariant, 'link'>;
+    size?: ButtonSize;
+    className?: string;
+}
+declare const IconButton: react.ForwardRefExoticComponent<IconButtonProps & react.RefAttributes<HTMLButtonElement>>;
+
 /**
  * Shared form-control styling — the single source of truth for the kit's
  * text-input look. Promoted out of SearchableSelect so every form control
@@ -55,15 +80,17 @@ declare const Button: react.ForwardRefExoticComponent<ButtonProps & react.RefAtt
  * so the classes survive both the dark-mode allow-list and the design-sync
  * compiled stylesheet.
  */
-/** `md` is the desktop control; `touch` is a finger on glass. See ButtonSize
- *  for why the touch scale is a separate ladder rather than a bigger `lg`. */
-type InputSize = 'md' | 'touch';
+/** `sm`/`md`/`lg` are the desktop ladder; `touch` is a finger on glass. See
+ *  ButtonSize for why touch is a separate rung rather than the top of this
+ *  ladder — a till's idea of "large" is 56px, and one word cannot mean both. */
+type InputSize = 'sm' | 'md' | 'lg' | 'touch';
 declare const INPUT_SIZES: Record<InputSize, string>;
 /** Base look for a text-bearing form control. Native <input>/<select>/<textarea>
  *  also receive dark styling for free via the global rule in styles.css. */
 declare const INPUT_BASE: string;
-/** Compose the input classes for a control. Omitting `size` yields exactly
- *  `INPUT_BASE`, so every existing caller is unaffected. */
+/** Compose the input classes for a control. Omitting `size` — or passing the
+ *  default `md` — yields exactly `INPUT_BASE`, so every existing caller is
+ *  unaffected. */
 declare function inputClasses(opts?: {
     invalid?: boolean;
     size?: InputSize;
@@ -95,6 +122,8 @@ interface TextareaProps extends Omit<TextareaHTMLAttributes<HTMLTextAreaElement>
     invalid?: boolean;
     /** Grow the field to fit its content instead of scrolling. */
     autoGrow?: boolean;
+    /** Desktop rung, or `touch`. Defaults to `md`. */
+    size?: InputSize;
     className?: string;
 }
 declare const Textarea: react.ForwardRefExoticComponent<TextareaProps & react.RefAttributes<HTMLTextAreaElement>>;
@@ -104,9 +133,18 @@ interface SelectOption {
     label: string;
     disabled?: boolean;
 }
-interface SelectProps extends Omit<SelectHTMLAttributes<HTMLSelectElement>, 'onChange' | 'value' | 'className'> {
+interface SelectProps extends Omit<SelectHTMLAttributes<HTMLSelectElement>, 'onChange' | 'value' | 'className' | 'size'> {
     value: string;
     onChange: (value: string) => void;
+    /**
+     * Desktop rung, or `touch`. Defaults to `md`.
+     *
+     * This shadows the native `size` attribute (the number of rows a select
+     * shows when it is rendered as a list box), which is omitted above rather
+     * than left to collide. Nothing here has ever rendered as a list box — the
+     * kit's Select is a dropdown — so no capability is lost.
+     */
+    size?: InputSize;
     options: SelectOption[];
     /** Shown as a disabled first option when no value is selected. */
     placeholder?: string;
@@ -125,6 +163,20 @@ declare const Select: react.ForwardRefExoticComponent<SelectProps & react.RefAtt
 interface CheckboxProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'type' | 'onChange' | 'checked' | 'className'> {
     checked: boolean;
     onChange: (checked: boolean) => void;
+    /**
+     * Neither checked nor unchecked — the "some of the rows below are selected"
+     * state on a select-all box.
+     *
+     * It has to be a prop because it cannot be an attribute: `indeterminate`
+     * exists only as a DOM property, so passing it through JSX sets a bogus
+     * attribute, logs "Received `true` for a non-boolean attribute", and leaves
+     * the box looking unchecked. Set here through a ref instead.
+     *
+     * A native checkbox in this state reports itself as `mixed` to assistive
+     * technology on its own, so no `aria-checked` is added — writing one would
+     * risk contradicting the element.
+     */
+    indeterminate?: boolean;
     label?: ReactNode;
     description?: ReactNode;
     className?: string;
@@ -333,6 +385,29 @@ interface DateRangePickerProps {
 declare function toISODate(d: Date): string;
 declare function DateRangePicker({ from, to, onChange, formatDisplay, clearable, placeholder, }: DateRangePickerProps): react_jsx_runtime.JSX.Element;
 
+interface DatePickerProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'className' | 'size' | 'type' | 'value' | 'onChange' | 'min' | 'max'> {
+    /** A Date, a `YYYY-MM-DD` string, or nothing. */
+    value?: Date | string | null;
+    /**
+     * The chosen date at local midnight, or `null` when the field is empty.
+     *
+     * A native date input also reports `''` mid-entry, while a partly typed date
+     * is not yet a date. Both arrive here as `null`: "no date yet" and "cleared"
+     * are the same thing to a caller storing a value.
+     */
+    onChange?: (value: Date | null) => void;
+    /** Earliest selectable date. */
+    min?: Date | string | null;
+    /** Latest selectable date. */
+    max?: Date | string | null;
+    /** Error state — red border + ring, matching Input. */
+    invalid?: boolean;
+    /** `touch` gives a 56px field for a finger. Defaults to the desktop size. */
+    size?: InputSize;
+    className?: string;
+}
+declare const DatePicker: react.ForwardRefExoticComponent<DatePickerProps & react.RefAttributes<HTMLInputElement>>;
+
 interface NumericKeypadProps {
     value: string;
     onChange: (next: string) => void;
@@ -405,7 +480,7 @@ interface SegmentedProps<T extends string = string> {
 declare function Segmented<T extends string = string>({ value, onChange, options, name, size, block, label, className, }: SegmentedProps<T>): react_jsx_runtime.JSX.Element;
 
 type SwitchSize = 'sm' | 'md' | 'touch';
-interface SwitchProps {
+interface SwitchProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'onChange' | 'type' | 'className'> {
     checked: boolean;
     onChange: (checked: boolean) => void;
     disabled?: boolean;
@@ -417,7 +492,16 @@ interface SwitchProps {
     id?: string;
     className?: string;
 }
-declare function Switch({ checked, onChange, disabled, size, label, hint, id, className, }: SwitchProps): react_jsx_runtime.JSX.Element;
+/**
+ * Forwards its ref, and spreads the rest onto the button.
+ *
+ * A form library hands a field three things: a change handler, a name, and a
+ * ref it uses to move focus to the field when validation fails. The first was
+ * here; the other two had nowhere to go, so this control could not be a form
+ * field at all — which contradicts the kit's own guidance that its controls
+ * drop into react-hook-form.
+ */
+declare const Switch: react.ForwardRefExoticComponent<SwitchProps & react.RefAttributes<HTMLButtonElement>>;
 
 interface InputNumberProps {
     value: number | null;
@@ -644,10 +728,19 @@ interface DescriptionListProps {
     /** Hairline-separated rows in a bordered panel. */
     bordered?: boolean;
     size?: 'sm' | 'md';
+    /**
+     * Shown in place of a value that is `null`, `undefined` or `''`. Defaults to
+     * an em dash.
+     *
+     * A blank cell answers nothing — and inside `bordered`, where the cell has
+     * an outline of its own, it reads as a rendering fault rather than as "there
+     * is no tracking number". Pass `emptyText={null}` for the old behaviour.
+     */
+    emptyText?: ReactNode;
     title?: ReactNode;
     className?: string;
 }
-declare function DescriptionList({ items, columns, bordered, size, title, className, }: DescriptionListProps): react_jsx_runtime.JSX.Element;
+declare function DescriptionList({ items, columns, bordered, size, title, className, emptyText: empty, }: DescriptionListProps): react_jsx_runtime.JSX.Element;
 
 type ResultStatus = 'success' | 'error' | 'warning' | 'info' | '404' | '403' | '500';
 interface ResultProps {
@@ -699,7 +792,14 @@ type AvatarSize = 'xs' | 'sm' | 'md' | 'lg';
 type AvatarStatus = 'online' | 'offline' | 'busy' | 'away';
 interface AvatarProps {
     src?: string;
-    /** Used for the initials fallback and the image alt text. */
+    /**
+     * Who this is. It names the avatar to assistive technology and supplies the
+     * initials when there is no usable image.
+     *
+     * Without it the avatar is hidden from assistive technology rather than
+     * announced as "question mark" — an avatar nobody can name carries nothing
+     * a screen-reader user needs.
+     */
     name?: string;
     size?: AvatarSize;
     status?: AvatarStatus;
@@ -750,6 +850,16 @@ interface BannerProps {
 }
 declare function Banner({ tone, emphasis, title, children, icon, onDismiss, sticky, className, }: BannerProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * The DOM id of a tab and of the panel it controls, derived from the same
+ * prefix so a consumer rendering the panel cannot mismatch them.
+ *
+ * Exported rather than inlined: the panel is rendered by the CONSUMER, so both
+ * sides have to agree on the string, and agreeing by convention in a comment
+ * is how these drift.
+ */
+declare const tabButtonId: (prefix: string, id: string) => string;
+declare const tabPanelId: (prefix: string, id: string) => string;
 interface TabItem {
     id: string;
     label: ReactNode;
@@ -761,9 +871,27 @@ interface TabsProps {
     value: string;
     onChange: (id: string) => void;
     variant?: 'underline' | 'pill';
+    /**
+     * Enables the tab/panel association. With it each tab gains a stable id and
+     * an `aria-controls` pointing at `tabPanelId(idPrefix, item.id)`; the
+     * consumer gives its panel that id and names it with
+     * `aria-labelledby={tabButtonId(idPrefix, item.id)}`.
+     *
+     * Omitted, nothing is emitted. A tab strip used purely as a filter — no
+     * panel to point at — should not claim to control an element that does not
+     * exist, which is a dangling reference rather than a helpful one.
+     */
+    idPrefix?: string;
+    /**
+     * Names the strip. A page with more than one — order sections above, media
+     * types below — gives a screen-reader user two "tab list"s with nothing to
+     * tell them apart, and there was no way to pass a name at all.
+     */
+    'aria-label'?: string;
+    'aria-labelledby'?: string;
     className?: string;
 }
-declare function Tabs({ items, value, onChange, variant, className }: TabsProps): react_jsx_runtime.JSX.Element;
+declare function Tabs({ items, value, onChange, variant, idPrefix, className, 'aria-label': ariaLabel, 'aria-labelledby': ariaLabelledBy, }: TabsProps): react_jsx_runtime.JSX.Element;
 
 interface AccordionItem {
     id: string;
@@ -791,10 +919,37 @@ interface TooltipProps {
 }
 declare function Tooltip({ content, side, delay, children }: TooltipProps): react_jsx_runtime.JSX.Element;
 
+type SemanticGroup = 'success' | 'active' | 'queued' | 'info' | 'pending' | 'warning' | 'danger' | 'draft' | 'neutral';
+/**
+ * The one table. `ColoredBadge` reads it too, through its `tone` prop, so a
+ * badge given a tone directly and a badge given a status string that maps to
+ * that tone are the same colour — which is the promise this component's
+ * docblock makes and could not keep for anything that was not a status.
+ */
+declare const GROUP_COLORS: Record<SemanticGroup, string>;
+declare function StatusBadgeProvider({ groups, children, }: {
+    groups: Record<string, SemanticGroup>;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+interface StatusBadgeProps {
+    status: string;
+}
+declare function StatusBadge({ status }: StatusBadgeProps): react_jsx_runtime.JSX.Element;
+
 interface ColoredBadgeProps {
+    /**
+     * A semantic tone, resolved through the same table `StatusBadge` uses — so a
+     * badge given `tone="success"` and one given a status string that maps to
+     * success are the same green.
+     *
+     * Prefer this to `colorClass`. Raw classes are the escape hatch for a colour
+     * the system has no name for, and every consumer reaching for them is a
+     * place the theme system cannot follow.
+     */
+    tone?: SemanticGroup;
     /** Tailwind classes for the badge color, e.g. `bg-green-100 text-green-800`.
-     *  Keep a per-app palette map rather than hardcoding colors at call sites. */
-    colorClass: string;
+     *  Wins over `tone` when both are given. */
+    colorClass?: string;
     children: ReactNode;
     /** `xs` = 10px (dense list cells), `sm` = 12px / px-2 (default), `md` =
      *  12px / px-2.5 (matches StatusBadge). */
@@ -802,23 +957,29 @@ interface ColoredBadgeProps {
     /** Capitalize each word — useful for raw status strings like `in_progress`
      *  (rendered as `In Progress`). Default false. */
     capitalize?: boolean;
+    /**
+     * Render a close control — a filter chip the user can drop.
+     *
+     * Its accessible name is derived from the badge's own text: "Remove Winter
+     * tyres", not "Remove". A row of filter chips otherwise gives a screen-reader
+     * user five identical buttons and no way to tell which one drops which
+     * filter. `closeLabel` overrides it, and is required in practice whenever
+     * the children are not plain text — there is nothing to derive from.
+     */
+    closable?: boolean;
+    onClose?: () => void;
+    closeLabel?: string;
+    className?: string;
 }
 /**
- * ColoredBadge — a small rounded-full pill whose colors are supplied as a
- * Tailwind class string. Generic counterpart to StatusBadge (which maps status
- * strings to semantic groups); use this when the caller already knows the color.
+ * ColoredBadge — a small rounded-full pill. Give it a `tone` from the shell's
+ * semantic vocabulary, or raw Tailwind classes when the colour has no name.
+ *
+ * Counterpart to StatusBadge, which takes a domain status STRING and maps it
+ * through a provider. Both read the same colour table, so the two never
+ * disagree about what success looks like.
  */
-declare function ColoredBadge({ colorClass, children, size, capitalize }: ColoredBadgeProps): react_jsx_runtime.JSX.Element;
-
-type SemanticGroup = 'success' | 'active' | 'queued' | 'info' | 'pending' | 'warning' | 'danger' | 'draft' | 'neutral';
-declare function StatusBadgeProvider({ groups, children, }: {
-    groups: Record<string, SemanticGroup>;
-    children: ReactNode;
-}): react_jsx_runtime.JSX.Element;
-interface StatusBadgeProps {
-    status: string;
-}
-declare function StatusBadge({ status }: StatusBadgeProps): react_jsx_runtime.JSX.Element;
+declare function ColoredBadge({ colorClass, tone, children, size, capitalize, closable, onClose, closeLabel, className, }: ColoredBadgeProps): react_jsx_runtime.JSX.Element;
 
 interface EmptyStateProps {
     /** Bold heading, e.g. "No invoices yet". */
@@ -835,8 +996,16 @@ interface EmptyStateProps {
     variant?: 'dashed' | 'card' | 'none';
     /** @deprecated set `variant="none"` instead. */
     frameless?: boolean;
-    /** Show the placeholder icon. Defaults to true (false for `variant="card"`). */
-    icon?: boolean;
+    /**
+     * `true`/omitted shows the placeholder inbox, `false` shows nothing, and an
+     * element shows that instead.
+     *
+     * The boolean alone meant every empty state in every app was an inbox — an
+     * empty catalogue, an empty invoice list and an empty inbox drawn
+     * identically, when the icon is the fastest thing on the screen to read.
+     * Defaults to the placeholder (to nothing for `variant="card"`).
+     */
+    icon?: boolean | ReactNode;
     /** Action(s) rendered under the text. */
     children?: ReactNode;
 }
@@ -847,6 +1016,53 @@ interface EmptyStateProps {
  */
 declare function EmptyState({ title, message, description, hint, variant, frameless, icon, children, }: EmptyStateProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * Generic breadcrumb trail. Self-contained and styled with the same Tailwind
+ * utilities the shell already ships, so consumers get it for free.
+ *
+ * Pass an ordered list of `items` from root → current. Every crumb except the
+ * last renders as a button when it has an `onClick`; the last crumb is treated
+ * as the current location — rendered inert with `aria-current="page"`. When the
+ * trail is long, set `maxItems` to collapse the middle into an ellipsis
+ * (`first … last-n` ), keeping the first and the tail visible.
+ */
+interface BreadcrumbItem {
+    /** Visible label. */
+    label: ReactNode;
+    /** Optional leading icon (typically a 3.5×3.5 svg). */
+    icon?: ReactNode;
+    /**
+     * Navigate to this crumb. Omitted on the current (last) crumb.
+     *
+     * Receives the event, which is what makes `href` usable from a routed app:
+     * the handler calls `preventDefault()` on a plain click and hands the
+     * navigation to its router, while ctrl/middle/right clicks fall through to
+     * the browser untouched. Without the argument an anchor could only ever do a
+     * full page load, which is the thing a single-page app is avoiding.
+     */
+    onClick?: (event: MouseEvent<HTMLAnchorElement | HTMLButtonElement>) => void;
+    /**
+     * Where this crumb goes, when it is a real destination.
+     *
+     * A routed app needs this rather than `onClick` alone: an `<a href>` can be
+     * middle-clicked into a new tab, copied, and read off the status bar before
+     * committing to it — none of which a button offers, however well it behaves
+     * once pressed. Given both, the anchor still calls `onClick`, so a client-side
+     * router can intercept the plain-click case and leave the rest to the browser.
+     */
+    href?: string;
+}
+interface BreadcrumbsProps {
+    items: BreadcrumbItem[];
+    /** Node rendered between crumbs. Defaults to a chevron. */
+    separator?: ReactNode;
+    /** Collapse the middle to an ellipsis when there are more than this many
+     *  crumbs. `0` (default) never collapses. */
+    maxItems?: number;
+    className?: string;
+}
+declare function Breadcrumbs({ items, separator, maxItems, className }: BreadcrumbsProps): react_jsx_runtime.JSX.Element | null;
+
 interface PageHeaderProps {
     title: string;
     /** Muted line under the title. (`subtitle` is an accepted alias.) */
@@ -856,13 +1072,27 @@ interface PageHeaderProps {
     /** Right-aligned actions. (`children` is also accepted.) */
     actions?: ReactNode;
     children?: ReactNode;
+    /**
+     * Icon beside the title — a marker for the page, not a second headline.
+     * Rendered muted and at the title's own size, so it labels the words rather
+     * than competing with them.
+     */
+    icon?: ReactNode;
+    /**
+     * Trail above the title, root → current, rendered with the kit's own
+     * `Breadcrumbs`. Not a second implementation: the collapsing behaviour, the
+     * `aria-current="page"` on the last crumb and the separator all come from
+     * that component, so a trail in a header and a trail anywhere else stay the
+     * same thing.
+     */
+    breadcrumbs?: BreadcrumbItem[];
 }
 /**
  * PageHeader — a page/section title with an optional muted description and a
  * right-aligned actions slot. Accepts both the `description`/`actions` and the
  * `subtitle`/`children` prop shapes the portals previously used locally.
  */
-declare function PageHeader({ title, description, subtitle, actions, children }: PageHeaderProps): react_jsx_runtime.JSX.Element;
+declare function PageHeader({ title, description, subtitle, actions, children, icon, breadcrumbs, }: PageHeaderProps): react_jsx_runtime.JSX.Element;
 
 interface LoadingSpinnerProps {
     /** Ring diameter: `sm` = 20px, `md` = 32px (default), `lg` = 48px. */
@@ -1276,35 +1506,6 @@ interface TopNavProps {
 }
 declare function TopNav({ items, activeKey, onSelect, brand, actions, className }: TopNavProps): react_jsx_runtime.JSX.Element;
 
-/**
- * Generic breadcrumb trail. Self-contained and styled with the same Tailwind
- * utilities the shell already ships, so consumers get it for free.
- *
- * Pass an ordered list of `items` from root → current. Every crumb except the
- * last renders as a button when it has an `onClick`; the last crumb is treated
- * as the current location — rendered inert with `aria-current="page"`. When the
- * trail is long, set `maxItems` to collapse the middle into an ellipsis
- * (`first … last-n` ), keeping the first and the tail visible.
- */
-interface BreadcrumbItem {
-    /** Visible label. */
-    label: ReactNode;
-    /** Optional leading icon (typically a 3.5×3.5 svg). */
-    icon?: ReactNode;
-    /** Navigate to this crumb. Omitted on the current (last) crumb. */
-    onClick?: () => void;
-}
-interface BreadcrumbsProps {
-    items: BreadcrumbItem[];
-    /** Node rendered between crumbs. Defaults to a chevron. */
-    separator?: ReactNode;
-    /** Collapse the middle to an ellipsis when there are more than this many
-     *  crumbs. `0` (default) never collapses. */
-    maxItems?: number;
-    className?: string;
-}
-declare function Breadcrumbs({ items, separator, maxItems, className }: BreadcrumbsProps): react_jsx_runtime.JSX.Element | null;
-
 /**
  * Unified popup menu component — used for all context menus, dropdowns, and flyouts.
  * Reads --menu-density CSS variable: 'tight', 'normal' (default), or 'large'.
@@ -1501,6 +1702,41 @@ declare function ConfirmProvider({ children }: {
     children: React.ReactNode;
 }): react_jsx_runtime.JSX.Element;
 
+interface SearchResult {
+    /** Category label, e.g. "Sales Order". */
+    type: string;
+    /** Primary text shown in the result row. */
+    label: string;
+    /** Optional secondary line. */
+    sub?: string;
+    /** Window-registry key passed to openEntity. */
+    entity_type: string;
+    entity_id: string;
+}
+/** A search provider — given a query, returns matching results. The shell
+ *  calls every provider in parallel and concatenates the responses. */
+type SearchProvider = (query: string) => Promise<SearchResult[]>;
+/** Bundle of search-related consumer config. */
+interface SearchConfig {
+    providers: SearchProvider[];
+    /** Per-result-type icon (SVG path `d` attribute). Unmatched types fall
+     *  back to a generic magnifier glyph. */
+    typeIcons?: Record<string, string>;
+    placeholder?: string;
+}
+interface GlobalSearchProps extends Partial<SearchConfig> {
+    /**
+     * What to do with the chosen result. Called after the overlay closes.
+     *
+     * Supplied by whoever renders the overlay, not by the consumer's
+     * `SearchConfig`: inside the desktop shell `Layout` passes `openEntity`, and
+     * a routed app passes its own navigation. Omitted, selecting a result just
+     * closes the overlay — which is what a search with nowhere to go should do.
+     */
+    onSelect?: (result: SearchResult) => void;
+}
+declare function GlobalSearch({ providers, typeIcons, placeholder, onSelect }?: GlobalSearchProps): react_jsx_runtime.JSX.Element | null;
+
 interface GridColumn {
     key: string;
     title: string;
@@ -1936,4 +2172,4 @@ declare const ALT_SHIFT_N: string;
  *  string when the source is consumed without a build (e.g. tests). */
 declare const VERSION: string;
 
-export { type CountBadgeTone as $, ALT as A, Banner as B, type ColumnDef as C, type ButtonVariant as D, CMD_A as E, CMD_DOT as F, CMD_ENTER as G, CMD_K as H, CMD_S as I, Card as J, type CardPadding as K, type CardProps as L, type CellStyle as M, ChatTemplate as N, Checkbox as O, type PaginatedResponse as P, type CheckboxProps as Q, CheckoutTemplate as R, type SortState as S, ColoredBadge as T, type ColoredBadgeProps as U, ConfirmProvider as V, ContainerFillChart as W, type ContainerFillChartProps as X, type ContainerFillItem as Y, CountBadge as Z, type CountBadgeProps as _, ALT_SHIFT_D as a, ListFooter as a$, DashboardTemplate as a0, DataTable as a1, type DataTableColumn as a2, DataTablePage as a3, type DataTableProps as a4, DateRangePicker as a5, type DateRangePickerProps as a6, type DescriptionColumns as a7, type DescriptionItem as a8, DescriptionList as a9, FormLayoutPage as aA, GLASS_DIVIDER as aB, GLASS_INPUT_BG as aC, GalleryTemplate as aD, type Gap as aE, Grid as aF, type GridCols as aG, type GridColumn as aH, type GridProps as aI, HelpCenter as aJ, type HelpCenterDoc as aK, type HelpCenterProps as aL, INPUT_BASE as aM, INPUT_SIZES as aN, Inline as aO, type InlineProps as aP, Input as aQ, InputNumber as aR, type InputNumberProps as aS, type InputProps as aT, type InputSize as aU, type Justify as aV, Kanban as aW, type KanbanColumn as aX, type KanbanProps as aY, Label as aZ, type LabelProps as a_, type DescriptionListProps as aa, Dialog as ab, type DialogProps as ac, type DialogSize as ad, Divider as ae, type DividerProps as af, type DividerSpacing as ag, DonutChart as ah, type DonutChartProps as ai, type DonutSegment as aj, Drawer as ak, type DrawerProps as al, type DrawerSide as am, type DrawerSize as an, ENTER as ao, EditableGrid as ap, type EditableGridProps as aq, EmailTemplate as ar, EmptyState as as, type EmptyStateProps as at, ErrorPage as au, type ErrorPageProps as av, FilePicker as aw, type FilePickerProps as ax, FormField as ay, type FormFieldProps as az, ALT_SHIFT_E as b, Stack as b$, ListLoadError as b0, type ListLoadErrorProps as b1, LoadingSpinner as b2, type LoadingSpinnerProps as b3, MAX_FRACTION_DIGITS as b4, MOD as b5, Markdown as b6, type MarkdownProps as b7, MediaUploadField as b8, type MediaUploadFieldProps as b9, type ResultStatus as bA, SHIFT as bB, type SearchableOption as bC, SearchableSelect as bD, type SearchableSelectProps as bE, Segmented as bF, type SegmentedOption as bG, type SegmentedProps as bH, type SegmentedSize as bI, Select as bJ, type SelectOption as bK, type SelectProps as bL, type SemanticGroup as bM, type SeverityTone as bN, type ShellPrefsAdapter as bO, ShellPrefsProvider as bP, SidebarActionButton as bQ, type SidebarActionButtonProps as bR, SidebarGroupLabel as bS, SidebarLayout as bT, type SidebarLayoutProps as bU, SidebarNavItem as bV, Skeleton as bW, type SkeletonProps as bX, type SkeletonVariant as bY, Sparkline as bZ, type SparklineProps as b_, MediaUploadGrid as ba, type MediaUploadGridItem as bb, type MediaUploadGridProps as bc, MetricBar as bd, type MetricBarProps as be, type Milestone as bf, type MilestoneKind as bg, MilestoneTimeline as bh, type MilestoneTimelineProps as bi, NativeSelect as bj, NumericKeypad as bk, type NumericKeypadProps as bl, PageHeader as bm, type PageHeaderProps as bn, Pagination as bo, type PaginationProps as bp, Paragraph as bq, type ParagraphProps as br, PopupMenu as bs, PopupMenuDivider as bt, PopupMenuItem as bu, PopupMenuLabel as bv, Radio as bw, type RadioProps as bx, Result as by, type ResultProps as bz, ALT_SHIFT_N as c, type StackProps as c0, StatCard as c1, type StatCardProps as c2, Statistic as c3, type StatisticProps as c4, type StatisticSize as c5, type StatisticTone as c6, StatusBadge as c7, StatusBadgeProvider as c8, Switch as c9, VERSION as cA, appendKey as cB, applyThemePrefs as cC, backspace as cD, confirm as cE, confirmDestructive as cF, formatDate as cG, glassStyle as cH, inputClasses as cI, isMac as cJ, isSeverityTone as cK, mediaFileName as cL, prompt as cM, resolveTheme as cN, severityOf as cO, toISODate as cP, toast as cQ, useClickOutside as cR, useConfirm as cS, useFocusTrap as cT, useIsMobile as cU, useLocalStoragePrefs as cV, useScrollLock as cW, useShellPrefs as cX, useTheme as cY, type SwitchProps as ca, type SwitchSize as cb, type TabItem as cc, Tabs as cd, type TabsProps as ce, Text as cf, type TextProps as cg, type TextSize as ch, type TextTone as ci, type TextWeight as cj, Textarea as ck, type TextareaProps as cl, type Theme as cm, TileButton as cn, type TileButtonProps as co, type TileSize as cp, Title as cq, type TitleLevel as cr, type TitleProps as cs, type ToastOptions as ct, type ToastPlacement as cu, Tooltip as cv, type TooltipProps as cw, TopNav as cx, type TopNavItem as cy, type TopNavProps as cz, Accordion as d, type AccordionItem as e, type AccordionProps as f, type Align as g, AuthScreen as h, type AuthScreenProps as i, Avatar as j, AvatarGroup as k, type AvatarGroupProps as l, type AvatarProps as m, type AvatarSize as n, type AvatarStatus as o, type BannerEmphasis as p, type BannerProps as q, type BannerTone as r, BarChart as s, type BarChartProps as t, type BreadcrumbItem as u, Breadcrumbs as v, type BreadcrumbsProps as w, Button as x, type ButtonProps as y, type ButtonSize as z };
+export { type CountBadgeProps as $, ALT as A, Banner as B, type ColumnDef as C, type ButtonSize as D, type ButtonVariant as E, CMD_A as F, CMD_DOT as G, CMD_ENTER as H, CMD_K as I, CMD_S as J, Card as K, type CardPadding as L, type CardProps as M, type CellStyle as N, ChatTemplate as O, type PaginatedResponse as P, Checkbox as Q, type CheckboxProps as R, type SearchConfig as S, CheckoutTemplate as T, ColoredBadge as U, type ColoredBadgeProps as V, ConfirmProvider as W, ContainerFillChart as X, type ContainerFillChartProps as Y, type ContainerFillItem as Z, CountBadge as _, type SortState as a, type InputProps as a$, type CountBadgeTone as a0, DashboardTemplate as a1, DataTable as a2, type DataTableColumn as a3, DataTablePage as a4, type DataTableProps as a5, DatePicker as a6, type DatePickerProps as a7, DateRangePicker as a8, type DateRangePickerProps as a9, type FilePickerProps as aA, FormField as aB, type FormFieldProps as aC, FormLayoutPage as aD, GLASS_DIVIDER as aE, GLASS_INPUT_BG as aF, GROUP_COLORS as aG, GalleryTemplate as aH, type Gap as aI, GlobalSearch as aJ, type GlobalSearchProps as aK, Grid as aL, type GridCols as aM, type GridColumn as aN, type GridProps as aO, HelpCenter as aP, type HelpCenterDoc as aQ, type HelpCenterProps as aR, INPUT_BASE as aS, INPUT_SIZES as aT, IconButton as aU, type IconButtonProps as aV, Inline as aW, type InlineProps as aX, Input as aY, InputNumber as aZ, type InputNumberProps as a_, type DescriptionColumns as aa, type DescriptionItem as ab, DescriptionList as ac, type DescriptionListProps as ad, Dialog as ae, type DialogProps as af, type DialogSize as ag, Divider as ah, type DividerProps as ai, type DividerSpacing as aj, DonutChart as ak, type DonutChartProps as al, type DonutSegment as am, Drawer as an, type DrawerProps as ao, type DrawerSide as ap, type DrawerSize as aq, ENTER as ar, EditableGrid as as, type EditableGridProps as at, EmailTemplate as au, EmptyState as av, type EmptyStateProps as aw, ErrorPage as ax, type ErrorPageProps as ay, FilePicker as az, ALT_SHIFT_D as b, type SidebarActionButtonProps as b$, type InputSize as b0, type Justify as b1, Kanban as b2, type KanbanColumn as b3, type KanbanProps as b4, Label as b5, type LabelProps as b6, ListFooter as b7, ListLoadError as b8, type ListLoadErrorProps as b9, PopupMenu as bA, PopupMenuDivider as bB, PopupMenuItem as bC, PopupMenuLabel as bD, Radio as bE, type RadioProps as bF, Result as bG, type ResultProps as bH, type ResultStatus as bI, SHIFT as bJ, type SearchProvider as bK, type SearchResult as bL, type SearchableOption as bM, SearchableSelect as bN, type SearchableSelectProps as bO, Segmented as bP, type SegmentedOption as bQ, type SegmentedProps as bR, type SegmentedSize as bS, Select as bT, type SelectOption as bU, type SelectProps as bV, type SemanticGroup as bW, type SeverityTone as bX, type ShellPrefsAdapter as bY, ShellPrefsProvider as bZ, SidebarActionButton as b_, LoadingSpinner as ba, type LoadingSpinnerProps as bb, MAX_FRACTION_DIGITS as bc, MOD as bd, Markdown as be, type MarkdownProps as bf, MediaUploadField as bg, type MediaUploadFieldProps as bh, MediaUploadGrid as bi, type MediaUploadGridItem as bj, type MediaUploadGridProps as bk, MetricBar as bl, type MetricBarProps as bm, type Milestone as bn, type MilestoneKind as bo, MilestoneTimeline as bp, type MilestoneTimelineProps as bq, NativeSelect as br, NumericKeypad as bs, type NumericKeypadProps as bt, PageHeader as bu, type PageHeaderProps as bv, Pagination as bw, type PaginationProps as bx, Paragraph as by, type ParagraphProps as bz, ALT_SHIFT_E as c, toISODate as c$, SidebarGroupLabel as c0, SidebarLayout as c1, type SidebarLayoutProps as c2, SidebarNavItem as c3, Skeleton as c4, type SkeletonProps as c5, type SkeletonVariant as c6, Sparkline as c7, type SparklineProps as c8, Stack as c9, Title as cA, type TitleLevel as cB, type TitleProps as cC, type ToastOptions as cD, type ToastPlacement as cE, Tooltip as cF, type TooltipProps as cG, TopNav as cH, type TopNavItem as cI, type TopNavProps as cJ, VERSION as cK, appendKey as cL, applyThemePrefs as cM, backspace as cN, confirm as cO, confirmDestructive as cP, formatDate as cQ, glassStyle as cR, inputClasses as cS, isMac as cT, isSeverityTone as cU, mediaFileName as cV, prompt as cW, resolveTheme as cX, severityOf as cY, tabButtonId as cZ, tabPanelId as c_, type StackProps as ca, StatCard as cb, type StatCardProps as cc, Statistic as cd, type StatisticProps as ce, type StatisticSize as cf, type StatisticTone as cg, StatusBadge as ch, StatusBadgeProvider as ci, Switch as cj, type SwitchProps as ck, type SwitchSize as cl, type TabItem as cm, Tabs as cn, type TabsProps as co, Text as cp, type TextProps as cq, type TextSize as cr, type TextTone as cs, type TextWeight as ct, Textarea as cu, type TextareaProps as cv, type Theme as cw, TileButton as cx, type TileButtonProps as cy, type TileSize as cz, ALT_SHIFT_N as d, toast as d0, useClickOutside as d1, useConfirm as d2, useFocusTrap as d3, useIsMobile as d4, useLocalStoragePrefs as d5, useScrollLock as d6, useShellPrefs as d7, useTheme as d8, Accordion as e, type AccordionItem as f, type AccordionProps as g, type Align as h, AuthScreen as i, type AuthScreenProps as j, Avatar as k, AvatarGroup as l, type AvatarGroupProps as m, type AvatarProps as n, type AvatarSize as o, type AvatarStatus as p, type BannerEmphasis as q, type BannerProps as r, type BannerTone as s, BarChart as t, type BarChartProps as u, type BreadcrumbItem as v, Breadcrumbs as w, type BreadcrumbsProps as x, Button as y, type ButtonProps as z };