react-os-shell 3.3.2 → 3.6.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { W as WindowRegistry } from './types-CTPtgkiG.js';
 export { M as ModalRegistryEntry, P as PageRegistryEntry, a as WindowRegistryEntry, i as isEntityEntry, b as isPageEntry, s as setShellWindowRegistry } from './types-CTPtgkiG.js';
 import * as react from 'react';
-import react__default, { ReactNode, Component, ErrorInfo, CSSProperties, Dispatch, SetStateAction, RefObject } from 'react';
+import react__default, { ReactNode, Component, ErrorInfo, CSSProperties, Dispatch, SetStateAction, RefObject, ButtonHTMLAttributes, InputHTMLAttributes, TextareaHTMLAttributes, SelectHTMLAttributes, LabelHTMLAttributes } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _tanstack_query_core from '@tanstack/query-core';
 import { AxiosInstance } from 'axios';
@@ -1380,6 +1380,315 @@ declare function useSort(defaultField: string, defaultDir?: 'asc' | 'desc'): {
     ordering: string;
 };
 
+/**
+ * Pagination — a numbered page control for classic paginated tables/lists, with
+ * prev/next and optional first/last edges and ellipsis gaps. Controlled: the
+ * consumer owns `page` and updates it in `onPageChange`. Complements ListFooter
+ * (which shows counts/selection for infinite-scroll lists).
+ */
+interface PaginationProps {
+    /** Current page, 1-based. */
+    page: number;
+    pageCount: number;
+    onPageChange: (page: number) => void;
+    /** How many page numbers to show on each side of the current page. */
+    siblingCount?: number;
+    /** Show first/last («/») buttons. */
+    showEdges?: boolean;
+    className?: string;
+}
+declare function Pagination({ page, pageCount, onPageChange, siblingCount, showEdges, className, }: PaginationProps): react_jsx_runtime.JSX.Element | null;
+
+type ButtonVariant = 'primary' | 'secondary' | 'ghost' | 'danger';
+type ButtonSize = 'sm' | 'md';
+interface ButtonProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'className'> {
+    variant?: ButtonVariant;
+    size?: ButtonSize;
+    /** Show a spinner and disable the button while an action is in flight. */
+    loading?: boolean;
+    leftIcon?: ReactNode;
+    rightIcon?: ReactNode;
+    /** Stretch to the full width of the container. */
+    block?: boolean;
+    className?: string;
+}
+declare const Button: react.ForwardRefExoticComponent<ButtonProps & react.RefAttributes<HTMLButtonElement>>;
+
+interface InputProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'className'> {
+    /** Error state — red border + ring. */
+    invalid?: boolean;
+    /** Icon rendered inside the field's left edge (e.g. a search glyph). */
+    leftIcon?: ReactNode;
+    /** Content pinned to the field's right edge (e.g. a unit, a small action). */
+    rightAdornment?: ReactNode;
+    className?: string;
+}
+declare const Input: react.ForwardRefExoticComponent<InputProps & react.RefAttributes<HTMLInputElement>>;
+
+interface TextareaProps extends Omit<TextareaHTMLAttributes<HTMLTextAreaElement>, 'className'> {
+    /** Error state — red border + ring. */
+    invalid?: boolean;
+    /** Grow the field to fit its content instead of scrolling. */
+    autoGrow?: boolean;
+    className?: string;
+}
+declare const Textarea: react.ForwardRefExoticComponent<TextareaProps & react.RefAttributes<HTMLTextAreaElement>>;
+
+interface SelectOption {
+    value: string;
+    label: string;
+    disabled?: boolean;
+}
+interface SelectProps extends Omit<SelectHTMLAttributes<HTMLSelectElement>, 'onChange' | 'value' | 'className'> {
+    value: string;
+    onChange: (value: string) => void;
+    options: SelectOption[];
+    /** Shown as a disabled first option when no value is selected. */
+    placeholder?: string;
+    invalid?: boolean;
+    className?: string;
+}
+declare const Select: react.ForwardRefExoticComponent<SelectProps & react.RefAttributes<HTMLSelectElement>>;
+
+interface CheckboxProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'type' | 'onChange' | 'checked' | 'className'> {
+    checked: boolean;
+    onChange: (checked: boolean) => void;
+    label?: ReactNode;
+    description?: ReactNode;
+    className?: string;
+}
+declare const Checkbox: react.ForwardRefExoticComponent<CheckboxProps & react.RefAttributes<HTMLInputElement>>;
+
+interface RadioProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'type' | 'onChange' | 'checked' | 'className'> {
+    checked: boolean;
+    onChange: (checked: boolean) => void;
+    label?: ReactNode;
+    description?: ReactNode;
+    className?: string;
+}
+declare const Radio: react.ForwardRefExoticComponent<RadioProps & react.RefAttributes<HTMLInputElement>>;
+
+interface FormFieldProps {
+    label?: ReactNode;
+    /** id of the control, for label-for wiring. */
+    htmlFor?: string;
+    /** Greyed helper text below the control. */
+    hint?: ReactNode;
+    /** Red error text below the control — overrides `hint` when present. */
+    error?: ReactNode;
+    /** Append a red asterisk to the label. */
+    required?: boolean;
+    className?: string;
+    children: ReactNode;
+}
+declare function FormField({ label, htmlFor, hint, error, required, className, children, }: FormFieldProps): react_jsx_runtime.JSX.Element;
+
+interface LabelProps extends LabelHTMLAttributes<HTMLLabelElement> {
+    /** Append a red asterisk. */
+    required?: boolean;
+}
+declare function Label({ required, children, className, ...rest }: LabelProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Shared form-control styling — the single source of truth for the kit's
+ * text-input look. Promoted out of SearchableSelect so every form control
+ * (Input, Textarea, Select, SearchableSelect) renders identically and picks
+ * up the same `[data-theme="dark"]` input remaps from styles.css.
+ *
+ * Keep this in the documented Tailwind vocabulary (see .design-sync/conventions.md)
+ * so the classes survive both the dark-mode allow-list and the design-sync
+ * compiled stylesheet.
+ */
+/** 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. */
+declare function inputClasses(opts?: {
+    invalid?: boolean;
+    className?: string;
+}): string;
+
+interface CardProps {
+    children: ReactNode;
+    /** Title row above the body, divided by a hairline. */
+    header?: ReactNode;
+    /** Row below the body, divided by a hairline. */
+    footer?: ReactNode;
+    /** Apply default padding to the body. Default true; set false to fill edge-to-edge. */
+    padded?: boolean;
+    className?: string;
+}
+declare function Card({ children, header, footer, padded, className }: CardProps): react_jsx_runtime.JSX.Element;
+interface StatCardProps {
+    label: ReactNode;
+    value: ReactNode;
+    icon?: ReactNode;
+    /** Trend pill, e.g. `{ value: '12%', direction: 'up' }`. */
+    delta?: {
+        value: ReactNode;
+        direction: 'up' | 'down' | 'flat';
+    };
+    className?: string;
+}
+declare function StatCard({ label, value, icon, delta, className }: StatCardProps): react_jsx_runtime.JSX.Element;
+
+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. */
+    name?: string;
+    size?: AvatarSize;
+    status?: AvatarStatus;
+    className?: string;
+}
+declare function Avatar({ src, name, size, status, className }: AvatarProps): react_jsx_runtime.JSX.Element;
+interface AvatarGroupProps {
+    children: ReactNode;
+    /** Show at most this many avatars; the rest collapse into a +N chip. */
+    max?: number;
+    /** Size of the children — used for the overlap + overflow-chip geometry.
+     *  Give the child Avatars this same size. */
+    size?: AvatarSize;
+    className?: string;
+}
+declare function AvatarGroup({ children, max, size, className }: AvatarGroupProps): react_jsx_runtime.JSX.Element;
+
+type BannerTone = 'info' | 'success' | 'warning' | 'danger';
+interface BannerProps {
+    tone?: BannerTone;
+    title?: ReactNode;
+    children?: ReactNode;
+    /** Override the default tone icon. */
+    icon?: ReactNode;
+    /** When provided, renders a dismiss × that calls this. */
+    onDismiss?: () => void;
+    className?: string;
+}
+declare function Banner({ tone, title, children, icon, onDismiss, className }: BannerProps): react_jsx_runtime.JSX.Element;
+
+interface TabItem {
+    id: string;
+    label: ReactNode;
+    icon?: ReactNode;
+    disabled?: boolean;
+}
+interface TabsProps {
+    items: TabItem[];
+    value: string;
+    onChange: (id: string) => void;
+    variant?: 'underline' | 'pill';
+    className?: string;
+}
+declare function Tabs({ items, value, onChange, variant, className }: TabsProps): react_jsx_runtime.JSX.Element;
+
+interface AccordionItem {
+    id: string;
+    title: ReactNode;
+    content: ReactNode;
+    disabled?: boolean;
+}
+interface AccordionProps {
+    items: AccordionItem[];
+    defaultOpenIds?: string[];
+    /** Controlled open set — when provided, the component stops tracking its own. */
+    openIds?: string[];
+    onOpenChange?: (ids: string[]) => void;
+    allowMultiple?: boolean;
+    className?: string;
+}
+declare function Accordion({ items, defaultOpenIds, openIds, onOpenChange, allowMultiple, className, }: AccordionProps): react_jsx_runtime.JSX.Element;
+
+interface TooltipProps {
+    content: ReactNode;
+    side?: 'top' | 'bottom' | 'left' | 'right';
+    /** Hover delay before showing, in ms. */
+    delay?: number;
+    children: ReactNode;
+}
+declare function Tooltip({ content, side, delay, children }: TooltipProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Shared chart types. The charts are dependency-free inline SVG/CSS — color
+ * defaults to `currentColor` so a parent `text-*` class themes them, and
+ * geometry comes from numeric props (not Tailwind classes), so they sidestep
+ * the design-sync compiled-CSS / arbitrary-value constraints entirely.
+ */
+
+interface SparklineProps {
+    data: number[];
+    width?: number;
+    height?: number;
+    /** Line color. Defaults to `currentColor`. */
+    stroke?: string;
+    /** Area fill under the line. Omit for a bare line. */
+    fill?: string;
+    strokeWidth?: number;
+    showDots?: boolean;
+    className?: string;
+    style?: CSSProperties;
+}
+interface BarChartProps {
+    data: number[];
+    /** Optional labels under each bar. */
+    labels?: string[];
+    height?: number;
+    /** Bar color. Defaults to `currentColor`. */
+    color?: string;
+    /** Per-bar color overrides. */
+    colors?: string[];
+    /** Value mapped to a full-height bar. Defaults to the max of `data`. */
+    max?: number;
+    /** Gap between bars, in px. */
+    gap?: number;
+    className?: string;
+    style?: CSSProperties;
+}
+interface DonutSegment {
+    label: string;
+    value: number;
+    color?: string;
+}
+interface DonutChartProps {
+    segments: DonutSegment[];
+    size?: number;
+    thickness?: number;
+    /** Rendered in the hole, e.g. a total. */
+    centerLabel?: ReactNode;
+    className?: string;
+    style?: CSSProperties;
+}
+
+declare function Sparkline({ data, width, height, stroke, fill, strokeWidth, showDots, className, style, }: SparklineProps): react_jsx_runtime.JSX.Element | null;
+
+declare function BarChart({ data, labels, height, color, colors, max, gap, className, style, }: BarChartProps): react_jsx_runtime.JSX.Element | null;
+
+declare function DonutChart({ segments, size, thickness, centerLabel, className, style }: DonutChartProps): react_jsx_runtime.JSX.Element;
+
+declare function DashboardTemplate(): react_jsx_runtime.JSX.Element;
+
+declare function DataTablePage(): react_jsx_runtime.JSX.Element;
+
+declare function FormLayoutPage(): react_jsx_runtime.JSX.Element;
+
+declare function CheckoutTemplate(): react_jsx_runtime.JSX.Element;
+
+declare function EmailTemplate(): react_jsx_runtime.JSX.Element;
+
+declare function ChatTemplate(): react_jsx_runtime.JSX.Element;
+
+declare function GalleryTemplate(): react_jsx_runtime.JSX.Element;
+
+interface AuthScreenProps {
+    mode?: 'login' | 'register' | 'forgot';
+}
+declare function AuthScreen({ mode }: AuthScreenProps): react_jsx_runtime.JSX.Element;
+
+interface ErrorPageProps {
+    code?: 403 | 404 | 500;
+}
+declare function ErrorPage({ code }: ErrorPageProps): react_jsx_runtime.JSX.Element;
+
 /** Package version, injected by tsup at build time. Stays as an empty
  *  string when the source is consumed without a build (e.g. tests). */
 declare const VERSION: string;
@@ -1537,4 +1846,4 @@ declare function useNewHotkey(callback: () => void): void;
  */
 declare function useEditHotkey(callback: (() => void) | null): void;
 
-export { ALT, ALT_SHIFT_D, ALT_SHIFT_E, ALT_SHIFT_N, BehaviorPanel, type BreadcrumbItem, Breadcrumbs, type BreadcrumbsProps, CMD_A, CMD_DOT, CMD_ENTER, CMD_K, CMD_S, CancelButton, type CellStyle, type ChangelogEntry, type ClockCalendarConfig, type ColumnDef, ConfirmProvider, CopyButton, Customization, type CustomizationOmitSection, type CustomizationProps, type CustomizationSection, DEV_BANNER_TEXT, Desktop, type DesktopContextMenuItem, type DesktopHostConfig, DesktopHostProvider, DevIndicator, DocFavStar, ENTER, EditableGrid, type EditableGridProps, type EntityFetcher, EntityList, type EntityListColumn, type EntityListProps, GLASS_DIVIDER, GLASS_INPUT_BG, GlobalSearch, type GridColumn, HelpCenter, type HelpCenterDoc, type HelpCenterProps, ImageAnnotator, type ImageAnnotatorHandle, type ImageAnnotatorProps, Kanban, type KanbanColumn, type KanbanProps, Layout, type LayoutProps, ListFooter, MOD, Markdown, type MarkdownProps, Modal, ModalActions, NotificationBell, type NotificationsConfig, type PaginatedResponse, PopupMenu, PopupMenuDivider, PopupMenuItem, PopupMenuLabel, ResizableTable, SHIFT, type SearchConfig, type SearchProvider, type SearchResult, type SearchableOption, SearchableSelect, type SearchableSelectProps, type SemanticGroup, type ShellAuth, ShellAuthProvider, ShellEntityFetcherProvider, type ShellNotification, type ShellPrefsAdapter, ShellPrefsProvider, ShortcutHelp, SidebarLayout, type SidebarLayoutProps, type SortState, SoundsPanel, StartMenu, StatusBadge, StatusBadgeProvider, type StickyEntityRef, type StickyResolver, SystemPreferences, type SystemPreferencesProps, type SystemPreferencesSection, type TodoProvider, type TodoTask, TopNav, type TopNavItem, type TopNavProps, VERSION, WidgetManager, WindowCrashedFallback, WindowErrorBoundary, WindowManagerProvider, WindowRegistry, WindowTitle, applyDevTitle, commitExposeHighlight, confirm, confirmDestructive, createWindowRegistry, exitExposeMode, formatDate, getActiveWindowRoute, getExposeHighlight, getWindowPosition, glassStyle, isDevEnv, isMac, prompt, registerModalEscapeInterceptor, setExposeHighlight, setShellApiClient, setShellAuthBridge, setShellNavIcons, setShellTodoProvider, setWindowDefaultPosition, setWindowPosition, subscribeExposeHighlight, toast, toggleExposeMode, useClickOutside, useColumnConfig, useDesktopHost, useEditHotkey, useInfiniteScroll, useLocalStoragePrefs, useModalActive, useNewHotkey, useShellAuth, useShellEntityFetcher, useShellPrefs, useSort, useTableNav, useWidgetSettings, useWindowManager, useWindowMenuItem, useWindowTitle };
+export { ALT, ALT_SHIFT_D, ALT_SHIFT_E, ALT_SHIFT_N, Accordion, type AccordionItem, type AccordionProps, AuthScreen, type AuthScreenProps, Avatar, AvatarGroup, type AvatarGroupProps, type AvatarProps, type AvatarSize, type AvatarStatus, Banner, type BannerProps, type BannerTone, BarChart, type BarChartProps, BehaviorPanel, type BreadcrumbItem, Breadcrumbs, type BreadcrumbsProps, Button, type ButtonProps, type ButtonSize, type ButtonVariant, CMD_A, CMD_DOT, CMD_ENTER, CMD_K, CMD_S, CancelButton, Card, type CardProps, type CellStyle, type ChangelogEntry, ChatTemplate, Checkbox, type CheckboxProps, CheckoutTemplate, type ClockCalendarConfig, type ColumnDef, ConfirmProvider, CopyButton, Customization, type CustomizationOmitSection, type CustomizationProps, type CustomizationSection, DEV_BANNER_TEXT, DashboardTemplate, DataTablePage, Desktop, type DesktopContextMenuItem, type DesktopHostConfig, DesktopHostProvider, DevIndicator, DocFavStar, DonutChart, type DonutChartProps, type DonutSegment, ENTER, EditableGrid, type EditableGridProps, EmailTemplate, type EntityFetcher, EntityList, type EntityListColumn, type EntityListProps, ErrorPage, type ErrorPageProps, FormField, type FormFieldProps, FormLayoutPage, GLASS_DIVIDER, GLASS_INPUT_BG, GalleryTemplate, GlobalSearch, type GridColumn, HelpCenter, type HelpCenterDoc, type HelpCenterProps, INPUT_BASE, ImageAnnotator, type ImageAnnotatorHandle, type ImageAnnotatorProps, Input, type InputProps, Kanban, type KanbanColumn, type KanbanProps, Label, type LabelProps, Layout, type LayoutProps, ListFooter, MOD, Markdown, type MarkdownProps, Modal, ModalActions, NotificationBell, type NotificationsConfig, type PaginatedResponse, Pagination, type PaginationProps, PopupMenu, PopupMenuDivider, PopupMenuItem, PopupMenuLabel, Radio, type RadioProps, ResizableTable, SHIFT, type SearchConfig, type SearchProvider, type SearchResult, type SearchableOption, SearchableSelect, type SearchableSelectProps, Select, type SelectOption, type SelectProps, type SemanticGroup, type ShellAuth, ShellAuthProvider, ShellEntityFetcherProvider, type ShellNotification, type ShellPrefsAdapter, ShellPrefsProvider, ShortcutHelp, SidebarLayout, type SidebarLayoutProps, type SortState, SoundsPanel, Sparkline, type SparklineProps, StartMenu, StatCard, type StatCardProps, StatusBadge, StatusBadgeProvider, type StickyEntityRef, type StickyResolver, SystemPreferences, type SystemPreferencesProps, type SystemPreferencesSection, type TabItem, Tabs, type TabsProps, Textarea, type TextareaProps, type TodoProvider, type TodoTask, Tooltip, type TooltipProps, TopNav, type TopNavItem, type TopNavProps, VERSION, WidgetManager, WindowCrashedFallback, WindowErrorBoundary, WindowManagerProvider, WindowRegistry, WindowTitle, applyDevTitle, commitExposeHighlight, confirm, confirmDestructive, createWindowRegistry, exitExposeMode, formatDate, getActiveWindowRoute, getExposeHighlight, getWindowPosition, glassStyle, inputClasses, isDevEnv, isMac, prompt, registerModalEscapeInterceptor, setExposeHighlight, setShellApiClient, setShellAuthBridge, setShellNavIcons, setShellTodoProvider, setWindowDefaultPosition, setWindowPosition, subscribeExposeHighlight, toast, toggleExposeMode, useClickOutside, useColumnConfig, useDesktopHost, useEditHotkey, useInfiniteScroll, useLocalStoragePrefs, useModalActive, useNewHotkey, useShellAuth, useShellEntityFetcher, useShellPrefs, useSort, useTableNav, useWidgetSettings, useWindowManager, useWindowMenuItem, useWindowTitle };