gridsmith-ui 0.28.0 → 0.29.1

package/dist/index.d.ts

@@ -3,10 +3,10 @@ import { ButtonHTMLAttributes, ReactNode, InputHTMLAttributes, LabelHTMLAttribut
 import { IconSlot, IconName } from './icons.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { M as MentionSuggestion } from './MentionList-CoNBRFGR.js';
-import { C as ColumnKind, B as BreakpointKey } from './table-utils-BkjNEWts.js';
-export { a as BreakpointWidthProvider, u as useBreakpoint } from './table-utils-BkjNEWts.js';
-import { P as Pager, A as AppShellPreferences } from './use-pagination-BxcRlNQG.js';
-export { a as PaginationOptions, b as PreferencesContext, R as ResolvedPreferences, p as preferenceActionKey, u as usePagination, c as usePreferences } from './use-pagination-BxcRlNQG.js';
+import { C as ColumnKind, B as BreakpointKey } from './table-utils-CxnpFHRF.js';
+export { a as BreakpointWidthProvider, u as useBreakpoint } from './table-utils-CxnpFHRF.js';
+import { P as Pager, A as AppShellPreferences } from './use-pagination-QykGSREv.js';
+export { a as PaginationOptions, b as PreferencesContext, R as ResolvedPreferences, p as preferenceActionKey, u as usePagination, c as usePreferences } from './use-pagination-QykGSREv.js';
 export { B as BreadcrumbItem, a as Breadcrumbs, b as BreadcrumbsSeparator, c as BreadcrumbsSize, d as BreadcrumbsVariant } from './Breadcrumbs-CGS8GKl-.js';
 
 type ButtonVariant = "default" | "secondary" | "tertiary" | "outline" | "ghost" | "destructive" | "success" | "warning" | "link";
@@ -343,12 +343,8 @@ interface CheckboxGroupItemProps {
     value: string;
     label: string;
     disabled?: boolean;
-    /** @deprecated Use CheckboxGroup's value/onChange via context instead. */
-    groupValue?: string[];
-    /** @deprecated Use CheckboxGroup's value/onChange via context instead. */
-    onGroupChange?: (value: string[]) => void;
 }
-declare function CheckboxGroupItem({ value, label, disabled, groupValue, onGroupChange }: CheckboxGroupItemProps): react_jsx_runtime.JSX.Element;
+declare function CheckboxGroupItem({ value, label, disabled }: CheckboxGroupItemProps): react_jsx_runtime.JSX.Element;
 
 interface RadioOption {
     value: string;
@@ -890,6 +886,11 @@ interface FormContextValue {
      */
     register: (field: string, check: FieldCheck) => () => void;
 }
+/**
+ * The FormWrapper a field sits in: its errors with `setError` and `clearErrors`, the project's validation timing
+ * (`validationMode`, forms.validationTiming through FormWrapper), whether it has been submitted, and `register` for a
+ * field's own check, which the form runs on each submit. Throws outside a FormWrapper.
+ */
 declare function useFormContext(): FormContextValue;
 
 /** An invalid field as the form finds it in its own DOM after a submit. */
@@ -1485,11 +1486,6 @@ interface AvatarGroupItem {
     initials?: string;
     src?: string;
     alt?: string;
-    /**
-     * @deprecated Ignored: a group draws no status (the owner, 30 September 2026: dots on overlapping avatars read as
-     * broken). Show someone's status with a single Avatar.
-     */
-    status?: AvatarStatus;
     color?: AvatarColor;
 }
 interface AvatarGroupProps {
@@ -1937,7 +1933,7 @@ interface AsidePanelProps {
     navbarFloating?: boolean;
     /** Whether the sidebar is floating — a left-docked floating column then drops its outer gutter, because the sidebar's own gutter is the gap (as PageHeader does). */
     sidebarFloating?: boolean;
-    /** Below this breakpoint the page is too narrow to share: the panel renders as a non-modal Drawer instead (and as the modal Sheet at or below sm, as Drawer does). Default "lg". */
+    /** Below this breakpoint the page is too narrow to share: the panel renders as a non-modal Drawer instead (and as the modal Sheet below sm, as Drawer does). Default "lg". */
     collapseBelow?: BreakpointKey;
     /** Keep the content mounted while closed (hidden) so drafts and scroll survive. Default true — the column exists for persistent assistants. */
     keepMounted?: boolean;
@@ -1994,10 +1990,6 @@ interface StackedListProps {
     /** The current row in a master-detail list. Its treatment follows the theme's in-page vertical active style (rail, tint or pill), like Tabs. */
     selectedId?: string | number;
     className?: string;
-    /** @deprecated Sprint 25.4: use variant="articles". Accepted for one version. */
-    flush?: boolean;
-    /** @deprecated Sprint 25.4: use variant="articles" (hover="title") — the default variant tints the row. */
-    hover?: "tint" | "title";
     /**
      * The list's pager (Sprint 25.13 A3), from `usePagination(items)` over the same items: the list draws the pager's
      * part of every item and, beneath it, the control in the project's style. Draw no <Pagination> of your own.
@@ -2873,6 +2865,10 @@ interface SidebarContextValue {
     navbarFloating: boolean;
     navSize?: "sm" | "md";
 }
+/**
+ * The Sidebar around this component, or null outside one: whether it is collapsed (with `onCollapsedChange`), its type
+ * and position, whether the navbar beside it floats, and the element its popovers portal into.
+ */
 declare function useSidebar(): SidebarContextValue | null;
 type SidebarVariant = "default" | "dark";
 interface SidebarProps {
@@ -3078,7 +3074,7 @@ interface DockProps {
 declare function Dock({ items, magnification, baseSize, className, }: DockProps): react_jsx_runtime.JSX.Element;
 
 /** `tint` (soft accent fill), `underline`, `minimal`, `pill` (solid accent fill). `default` is the deprecated pre-20.8 name for `tint`. */
-type NavbarType = "tint" | "underline" | "minimal" | "pill" | "default";
+type NavbarType = "tint" | "underline" | "minimal" | "pill";
 type NavbarAlign = "left" | "center" | "right";
 type NavbarVariant = "default" | "transparent" | "compact" | "elevated" | "blurred";
 type NavbarSize = "sm" | "md" | "lg";
@@ -3107,12 +3103,10 @@ interface NavbarProps {
 declare const Navbar: react.ForwardRefExoticComponent<NavbarProps & react.RefAttributes<HTMLElement>>;
 
 /**
- * Navbar active style. `tint` is the soft accent fill (the pre-20.8 `default`),
- * `underline` the bottom indicator, `minimal` a text-only change, `pill` a solid
- * accent fill with on-primary text. `default` is accepted as a deprecated alias
- * for `tint` for one release.
+ * Navbar active style. `tint` is the soft accent fill, `underline` the bottom indicator, `minimal` a text-only
+ * change, `pill` a solid accent fill with on-primary text.
  */
-type NavItemType = "tint" | "underline" | "minimal" | "pill" | "default";
+type NavItemType = "tint" | "underline" | "minimal" | "pill";
 interface NavItemProps {
     label: string;
     icon?: IconName;
@@ -3147,8 +3141,8 @@ interface NavMenuProps {
 }
 declare function NavMenu({ label, items, active, type: typeProp, onItemClick, className, }: NavMenuProps): react_jsx_runtime.JSX.Element;
 
-/** Mirrors NavbarType. `default` is the deprecated pre-20.8 name for `tint`. */
-type MobileHeaderMenuType = "tint" | "underline" | "minimal" | "pill" | "default";
+/** Mirrors NavbarType. */
+type MobileHeaderMenuType = "tint" | "underline" | "minimal" | "pill";
 interface MobileHeaderMenuItemData {
     label: string;
     icon?: IconName;
@@ -3210,8 +3204,9 @@ interface DrawerProps {
     topOffset?: string;
     /**
      * What the drawer becomes at phone width (≤ the sm breakpoint).
-     * "sheet" (default for right and bottom): a draggable bottom Sheet with snap points.
-     * "panel" (default for left, which is the navigation convention): a full-height side panel.
+     * "sheet" (default for right and bottom, and for a non-modal drawer on any side): a draggable bottom Sheet with snap
+     * points, always modal.
+     * "panel" (default for a modal left drawer, which is the navigation convention): a full-height side panel.
      * lightBackdrop and topOffset do not apply in sheet mode.
      */
     mobile?: "sheet" | "panel";
@@ -3268,7 +3263,7 @@ interface TooltipProps extends Omit<HTMLAttributes<HTMLElement>, "content"> {
      */
     ref?: Ref<HTMLElement>;
 }
-declare function Tooltip({ content, children, side, delay, className, container, disabled, ref: forwardedRef, ...slotProps }: TooltipProps): react_jsx_runtime.JSX.Element;
+declare function Tooltip({ content, children, side, delay, className, container, disabled, ref, ...slotProps }: TooltipProps): react_jsx_runtime.JSX.Element;
 
 interface PopoverProps {
     open: boolean;
@@ -3533,6 +3528,13 @@ interface ToastProviderProps {
     /** Pause every toast's time while the stack is hovered (focus inside it always pauses). Default true. */
     pauseOnHover?: boolean;
 }
+/**
+ * The app's toasts, from the shell's ToastProvider: `toast`, `success`, `warning` and `error` show one and return its id,
+ * `update` changes one in place, `dismiss` and `dismissAll` remove them, and `promise` shows a loading toast that
+ * resolves to success or error. The provider places every toast and times it by the project's preferences. For a
+ * destructive action's Undo, use `useDestructiveAction`, which shows its own toast for the project's undo window.
+ * Throws outside the ToastProvider.
+ */
 declare function useToast(): ToastApi;
 /** The toast API when a ToastProvider is above, else null — for components that can do without one (useDestructiveAction in dialog mode). */
 declare function useToastOptional(): ToastApi | null;
@@ -3607,7 +3609,7 @@ interface AppShellContextValue {
     /**
      * Effective sidebar collapse for a traditional Sidebar rendered in the shell.
      * The user's explicit choice wins; otherwise the auto tier applies — collapsed
-     * to a rail at or below the `lg` breakpoint, expanded above it. Lives here rather
+     * to a rail below the `lg` breakpoint, expanded from it. Lives here rather
      * than in Sidebar so it survives the sidebar unmounting in the drawer range.
      */
     sidebarCollapsed: boolean;
@@ -3642,8 +3644,10 @@ interface AppShellContextValue {
     registerChrome: (kind: "navbar" | "sidebar", position: ChromePosition) => () => void;
     /** True when the shell renders a Launcher above sm — PageContainer adjusts its bottom padding to clear the launcher. */
     hasLauncher: boolean;
-    /** The bottom corner that launcher occupies (a ribbon occupies none), so the container reads that corner's inset variable. */
+    /** The bottom corner a bubble or pill launcher occupies, so the container's bottom padding reads that corner's inset variable. The page's padding ignores a ribbon, which hugs the window's edge (its claim keeps only toasts off it). */
     launcherCorner: "bottom-right" | "bottom-left" | null;
+    /** Called by a Launcher inside the shell with the corner it occupies (null for a ribbon), so the padding follows the Launcher itself however the slot wraps it. Returns the unregister. */
+    registerLauncher: (corner: "bottom-right" | "bottom-left" | null) => () => void;
     /** The shell renders an app footer under the page. Its children sit in a wrapper whose height is not definite, so a
      *  `fill` SplitView reads `--ds-main-height` (published on the shell element) instead of `h-full`. */
     hasFooter: boolean;
@@ -3681,6 +3685,12 @@ interface AppShellFocus {
     /** What the exit control does: save and log out, or return to where the user came from. */
     onExit?: () => void;
 }
+/**
+ * The app shell around this component, or null outside one: its layout state — whether it has a sidebar, a mobile menu
+ * and a mobile nav, whether the sidebar is open or collapsed and the aside open (each with its setter), the viewport tier
+ * (`isMobile`, `isTablet`), the theme it was given and whether its navbar and sidebar float. For telling the shell about
+ * unsaved changes, use `useUnsavedChanges`.
+ */
 declare function useAppShell(): AppShellContextValue | null;
 /**
  * Tells the shell this page has unsaved changes, so focus mode's Exit asks before it leaves (Sprint 25.7, C1). Pass the
@@ -3712,9 +3722,9 @@ interface AppShellProps {
     /** Which side of the content the aside sits on. Default "right". Pass the same value to the AsidePanel. */
     asideSide?: "right" | "left";
     /**
-     * A Launcher for the assistant. Rendered only above the sm breakpoint — a conditional render,
-     * because the Launcher portals out of any wrapper — so on phones the Navbar button is the entry point
-     * and it never collides with BottomNav.
+     * A Launcher for the assistant. Rendered from the sm breakpoint up, where Tailwind's `sm:` starts — a conditional
+     * render, because the Launcher portals out of any wrapper — so below it, on phones, the Navbar button is the entry
+     * point and it never collides with BottomNav.
      */
     launcher?: ReactNode;
     children: ReactNode;