@ostack.tech/ui 0.9.1 → 0.10.0

package/dist/types/components/Alert/Alert.d.ts

@@ -6,6 +6,8 @@ import { Icon, IconProp } from '../Icon';
 export type AlertVariant = "solid" | "subtle" | "outlined";
 /** Alert severities. */
 export type AlertSeverity = "neutral" | "info" | "success" | "danger" | "warning";
+/** Alert type of announcement. */
+export type AlertAnnounce = "off" | "polite" | "assertive";
 /** Properties of the alert component. */
 export interface AlertProps extends ComponentPropsWithoutRef<"div"> {
     /**
@@ -20,6 +22,21 @@ export interface AlertProps extends ComponentPropsWithoutRef<"div"> {
      * @default info
      */
     severity?: AlertSeverity;
+    /**
+     * Controls how the alert is announced to screen reader users:
+     *
+     * - `off`: The alert is silent. Recommended for static messages.
+     * - `polite`: Sets `role="status"`. The screen reader will announce the alert
+     *   at the next available opportunity without interrupting the user
+     *   (recommended for non-critical feedback that appears _after_ a user
+     *   action).
+     * - `assertive`: Sets `role="alert"`. The screen reader will interrupt any
+     *   current speech to announce this immediately (recommended for critical
+     *   errors that appear and should stop the user's flow).
+     *
+     * @default off
+     */
+    announce?: AlertAnnounce;
     /** Alert action. */
     action?: ReactNode;
     /**

package/dist/types/components/Alert/AlertContext.d.ts

@@ -0,0 +1,8 @@
+/** Value of the alert context. */
+export interface AlertContextValue {
+    setTitleId: (id: string | undefined) => void;
+}
+/** Alert context. */
+export declare const AlertContext: import('react').Context<AlertContextValue | null>;
+/** Hook providing access to the alert context. */
+export declare function useAlertContext(): AlertContextValue;

package/dist/types/components/AlertDialog/AlertDialog.d.ts

@@ -5,7 +5,8 @@ import { AlertDialog as AlertDialogPrimitive } from 'radix-ui';
  *
  * Built on top of the [Radix Alert Dialog
  * primitive](https://www.radix-ui.com/primitives/docs/components/alert-dialog),
- * and the `Card` component.
+ * and the [`Card`
+ * component](https://ui.ostack.tech/?path=/docs/ostack-ui-data-display-card--docs).
  *
  * It composes the following subcomponents:
  *

package/dist/types/components/Button/Button.d.ts

@@ -146,7 +146,8 @@ export interface ButtonOwnProps {
 }
 /**
  * The button component is used to trigger actions or events, such as opening a
- * dialog or submitting a form.
+ * dialog or submitting a form. It is built on top of the browser's [`<button>`
+ * element](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button).
  *
  * Example usage:
  *

package/dist/types/components/Calendar/CalendarMonthGrid.d.ts

@@ -0,0 +1 @@
+export declare const CalendarMonthGrid: import('react').NamedExoticComponent<import('react').TableHTMLAttributes<HTMLTableElement>>;

package/dist/types/components/CommandMenu/CommandMenu.d.ts

@@ -1,10 +1,10 @@
-import { Command as CommandPrimitive } from 'cmdk';
 import { ComponentPropsWithoutRef, ComponentPropsWithRef, ReactNode } from 'react';
 import { ControlAddon } from '../ControlAddon';
 import { Icon } from '../Icon';
 import { Input } from '../Input';
 import { MenuList, MenuListIconPlacement, MenuListVariant } from '../MenuList';
 import { Spinner } from '../Spinner';
+import { Command as CommandPrimitive } from './cmdk';
 /** Command menu variants. */
 export type CommandMenuVariant = MenuListVariant;
 /** Placement of icons within command menu items. */
@@ -63,8 +63,9 @@ export interface CommandMenuProps extends ComponentPropsWithoutRef<typeof Comman
  * The command menu renders a menu of selectable items which can be filtered and
  * sorted via a search query.
  *
- * Built on top of the [cmdk Command primitive](https://cmdk.paco.me) and the
- * `MenuList` component.
+ * Built on top of the [cmdk Command primitive](https://github.com/dip/cmdk/)
+ * and the [`MenuList`
+ * component](https://ui.ostack.tech/?path=/docs/ostack-ui-data-display-menu-list--docs).
  *
  * It composes the following subcomponents:
  *

package/dist/types/components/CommandMenu/CommandMenuGroup.d.ts

@@ -1,5 +1,5 @@
-import { Command as CommandPrimitive } from 'cmdk';
 import { ComponentPropsWithoutRef, ReactNode } from 'react';
+import { Command as CommandPrimitive } from './cmdk';
 /** Properties of the command menu group. */
 export interface CommandMenuGroupProps extends Omit<ComponentPropsWithoutRef<typeof CommandPrimitive.Group>, "asChild" | "heading"> {
     /** Optional label of the command menu group. */

package/dist/types/components/CommandMenu/CommandMenuItem.d.ts

@@ -1,6 +1,6 @@
-import { Command as CommandPrimitive } from 'cmdk';
 import { ComponentPropsWithoutRef } from 'react';
 import { MenuListItemProps } from '../MenuList';
+import { Command as CommandPrimitive } from './cmdk';
 export interface CommandMenuItemProps extends Omit<ComponentPropsWithoutRef<typeof CommandPrimitive.Item>, "asChild" | "color">, Pick<MenuListItemProps, "selected" | "color" | "loading" | "loadingContent" | "showSpinner" | "icon" | "iconPlacement" | "keybinds" | "href" | "target" | "rel" | "actionProps" | "contentProps" | "iconProps" | "spinnerProps" | "keybindsProps"> {
     /**
      * Render the item as a link. When set, you can pass `href`, `target`, and

package/dist/types/components/CommandMenu/cmdk/command-score.d.ts

@@ -0,0 +1 @@
+export declare function commandScore(string: string, abbreviation: string, aliases: string[]): number;

package/dist/types/components/CommandMenu/cmdk/index.d.ts

@@ -0,0 +1,320 @@
+import * as React from "react";
+type Children = {
+    children?: React.ReactNode;
+};
+type DivProps = React.ComponentPropsWithoutRef<"div"> & {
+    /**
+     * Change the component to the HTML tag or custom component of the only child.
+     * This will merge the original component props with the props of the supplied
+     * element/component and change the underlying DOM node.
+     */
+    asChild?: boolean;
+};
+type CommandFilter = (value: string, search: string, keywords?: string[]) => number;
+type State = {
+    search: string;
+    value: string;
+    selectedItemId?: string;
+    filtered: {
+        count: number;
+        items: Map<string, number>;
+        groups: Set<string>;
+    };
+};
+type Group = {
+    id: string;
+    forceMount?: boolean;
+};
+declare const defaultFilter: CommandFilter;
+declare const Command: React.ForwardRefExoticComponent<Children & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    /**
+     * Change the component to the HTML tag or custom component of the only child.
+     * This will merge the original component props with the props of the supplied
+     * element/component and change the underlying DOM node.
+     */
+    asChild?: boolean;
+} & {
+    /** Accessible label for this command menu. Not shown visibly. */
+    label?: string;
+    /**
+     * Optionally set to `false` to turn off the automatic filtering and
+     * sorting. If `false`, you must conditionally render valid items based on
+     * the search query yourself.
+     */
+    shouldFilter?: boolean;
+    /**
+     * Custom filter function for whether each command menu item should matches
+     * the given search query. It should return a number between 0 and 1, with 1
+     * being the best match and 0 being hidden entirely. By default, uses the
+     * `command-score` library.
+     */
+    filter?: CommandFilter;
+    /** Optional default item value when it is initially rendered. */
+    defaultValue?: string;
+    /** Optional controlled state of the selected command menu item. */
+    value?: string;
+    /** Event handler called when the selected item of the menu changes. */
+    onValueChange?: (value: string) => void;
+    /**
+     * Optionally set to `true` to turn on looping around when using the arrow
+     * keys.
+     */
+    loop?: boolean;
+    /** Optionally set to `true` to disable selection via pointer events. */
+    disablePointerSelection?: boolean;
+} & React.RefAttributes<HTMLDivElement>>;
+/**
+ * Command menu item. Becomes active on pointer enter or through keyboard
+ * navigation. Preferably pass a `value`, otherwise the value will be inferred
+ * from `children` or the rendered item's `textContent`.
+ */
+declare const Item: React.ForwardRefExoticComponent<Children & Omit<DivProps, "disabled" | "value" | "onSelect"> & {
+    /** Whether this item is currently disabled. */
+    disabled?: boolean;
+    /**
+     * Event handler for when this item is selected, either via click or
+     * keyboard selection.
+     */
+    onSelect?: (value: string) => void;
+    /**
+     * A unique value for this item. If no value is provided, it will be
+     * inferred from `children` or the rendered `textContent`. If your
+     * `textContent` changes between renders, you _must_ provide a stable,
+     * unique `value`.
+     */
+    value?: string;
+    /** Optional keywords to match against when filtering. */
+    keywords?: string[];
+    /** Whether this item is forcibly rendered regardless of filtering. */
+    forceMount?: boolean;
+} & React.RefAttributes<HTMLDivElement>>;
+/**
+ * Group command menu items together with a heading. Grouped items are always
+ * shown together.
+ */
+declare const Group: React.ForwardRefExoticComponent<Children & Omit<DivProps, "value" | "heading"> & {
+    /** Optional heading to render for this group. */
+    heading?: React.ReactNode;
+    /**
+     * If no heading is provided, you must provide a value that is unique for
+     * this group.
+     */
+    value?: string;
+    /** Whether this group is forcibly rendered regardless of filtering. */
+    forceMount?: boolean;
+} & React.RefAttributes<HTMLDivElement>>;
+/**
+ * A visual and semantic separator between items or groups. Visible when the
+ * search query is empty or `alwaysRender` is true, hidden otherwise.
+ */
+declare const Separator: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    /**
+     * Change the component to the HTML tag or custom component of the only child.
+     * This will merge the original component props with the props of the supplied
+     * element/component and change the underlying DOM node.
+     */
+    asChild?: boolean;
+} & {
+    /**
+     * Whether this separator should always be rendered. Useful if you disable
+     * automatic filtering.
+     */
+    alwaysRender?: boolean;
+} & React.RefAttributes<HTMLDivElement>>;
+/**
+ * Command menu input. All props are forwarded to the underyling `input`
+ * element.
+ */
+declare const Input: React.ForwardRefExoticComponent<Omit<Omit<React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref">, "type" | "value" | "onChange"> & {
+    /**
+     * Change the component to the HTML tag or custom component of the only child.
+     * This will merge the original component props with the props of the supplied
+     * element/component and change the underlying DOM node.
+     */
+    asChild?: boolean;
+    /** Optional controlled state for the value of the search input. */
+    value?: string;
+    /** Event handler called when the search value changes. */
+    onValueChange?: (search: string) => void;
+} & React.RefAttributes<HTMLInputElement>>;
+/**
+ * Contains `Item`, `Group`, and `Separator`. Use the `--cmdk-list-height` CSS
+ * variable to animate height based on the number of results.
+ */
+declare const List: React.ForwardRefExoticComponent<Children & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    /**
+     * Change the component to the HTML tag or custom component of the only child.
+     * This will merge the original component props with the props of the supplied
+     * element/component and change the underlying DOM node.
+     */
+    asChild?: boolean;
+} & {
+    /** Accessible label for this List of suggestions. Not shown visibly. */
+    label?: string;
+} & React.RefAttributes<HTMLDivElement>>;
+/** Automatically renders when there are no results for the search query. */
+declare const Empty: React.ForwardRefExoticComponent<Children & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    /**
+     * Change the component to the HTML tag or custom component of the only child.
+     * This will merge the original component props with the props of the supplied
+     * element/component and change the underlying DOM node.
+     */
+    asChild?: boolean;
+} & React.RefAttributes<HTMLDivElement>>;
+/**
+ * You should conditionally render this with `progress` while loading
+ * asynchronous items.
+ */
+declare const Loading: React.ForwardRefExoticComponent<Children & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    /**
+     * Change the component to the HTML tag or custom component of the only child.
+     * This will merge the original component props with the props of the supplied
+     * element/component and change the underlying DOM node.
+     */
+    asChild?: boolean;
+} & {
+    /** Estimated progress of loading asynchronous options. */
+    progress?: number;
+    /** Accessible label for this loading progressbar. Not shown visibly. */
+    label?: string;
+} & React.RefAttributes<HTMLDivElement>>;
+declare const pkg: React.ForwardRefExoticComponent<Children & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    /**
+     * Change the component to the HTML tag or custom component of the only child.
+     * This will merge the original component props with the props of the supplied
+     * element/component and change the underlying DOM node.
+     */
+    asChild?: boolean;
+} & {
+    /** Accessible label for this command menu. Not shown visibly. */
+    label?: string;
+    /**
+     * Optionally set to `false` to turn off the automatic filtering and
+     * sorting. If `false`, you must conditionally render valid items based on
+     * the search query yourself.
+     */
+    shouldFilter?: boolean;
+    /**
+     * Custom filter function for whether each command menu item should matches
+     * the given search query. It should return a number between 0 and 1, with 1
+     * being the best match and 0 being hidden entirely. By default, uses the
+     * `command-score` library.
+     */
+    filter?: CommandFilter;
+    /** Optional default item value when it is initially rendered. */
+    defaultValue?: string;
+    /** Optional controlled state of the selected command menu item. */
+    value?: string;
+    /** Event handler called when the selected item of the menu changes. */
+    onValueChange?: (value: string) => void;
+    /**
+     * Optionally set to `true` to turn on looping around when using the arrow
+     * keys.
+     */
+    loop?: boolean;
+    /** Optionally set to `true` to disable selection via pointer events. */
+    disablePointerSelection?: boolean;
+} & React.RefAttributes<HTMLDivElement>> & {
+    List: React.ForwardRefExoticComponent<Children & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        /**
+         * Change the component to the HTML tag or custom component of the only child.
+         * This will merge the original component props with the props of the supplied
+         * element/component and change the underlying DOM node.
+         */
+        asChild?: boolean;
+    } & {
+        /** Accessible label for this List of suggestions. Not shown visibly. */
+        label?: string;
+    } & React.RefAttributes<HTMLDivElement>>;
+    Item: React.ForwardRefExoticComponent<Children & Omit<DivProps, "disabled" | "value" | "onSelect"> & {
+        /** Whether this item is currently disabled. */
+        disabled?: boolean;
+        /**
+         * Event handler for when this item is selected, either via click or
+         * keyboard selection.
+         */
+        onSelect?: (value: string) => void;
+        /**
+         * A unique value for this item. If no value is provided, it will be
+         * inferred from `children` or the rendered `textContent`. If your
+         * `textContent` changes between renders, you _must_ provide a stable,
+         * unique `value`.
+         */
+        value?: string;
+        /** Optional keywords to match against when filtering. */
+        keywords?: string[];
+        /** Whether this item is forcibly rendered regardless of filtering. */
+        forceMount?: boolean;
+    } & React.RefAttributes<HTMLDivElement>>;
+    Input: React.ForwardRefExoticComponent<Omit<Omit<React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref">, "type" | "value" | "onChange"> & {
+        /**
+         * Change the component to the HTML tag or custom component of the only child.
+         * This will merge the original component props with the props of the supplied
+         * element/component and change the underlying DOM node.
+         */
+        asChild?: boolean;
+        /** Optional controlled state for the value of the search input. */
+        value?: string;
+        /** Event handler called when the search value changes. */
+        onValueChange?: (search: string) => void;
+    } & React.RefAttributes<HTMLInputElement>>;
+    Group: React.ForwardRefExoticComponent<Children & Omit<DivProps, "value" | "heading"> & {
+        /** Optional heading to render for this group. */
+        heading?: React.ReactNode;
+        /**
+         * If no heading is provided, you must provide a value that is unique for
+         * this group.
+         */
+        value?: string;
+        /** Whether this group is forcibly rendered regardless of filtering. */
+        forceMount?: boolean;
+    } & React.RefAttributes<HTMLDivElement>>;
+    Separator: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        /**
+         * Change the component to the HTML tag or custom component of the only child.
+         * This will merge the original component props with the props of the supplied
+         * element/component and change the underlying DOM node.
+         */
+        asChild?: boolean;
+    } & {
+        /**
+         * Whether this separator should always be rendered. Useful if you disable
+         * automatic filtering.
+         */
+        alwaysRender?: boolean;
+    } & React.RefAttributes<HTMLDivElement>>;
+    Empty: React.ForwardRefExoticComponent<Children & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        /**
+         * Change the component to the HTML tag or custom component of the only child.
+         * This will merge the original component props with the props of the supplied
+         * element/component and change the underlying DOM node.
+         */
+        asChild?: boolean;
+    } & React.RefAttributes<HTMLDivElement>>;
+    Loading: React.ForwardRefExoticComponent<Children & Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        /**
+         * Change the component to the HTML tag or custom component of the only child.
+         * This will merge the original component props with the props of the supplied
+         * element/component and change the underlying DOM node.
+         */
+        asChild?: boolean;
+    } & {
+        /** Estimated progress of loading asynchronous options. */
+        progress?: number;
+        /** Accessible label for this loading progressbar. Not shown visibly. */
+        label?: string;
+    } & React.RefAttributes<HTMLDivElement>>;
+};
+export { useCmdk as useCommandState };
+export { pkg as Command };
+export { defaultFilter };
+export { Command as CommandRoot };
+export { List as CommandList };
+export { Item as CommandItem };
+export { Input as CommandInput };
+export { Group as CommandGroup };
+export { Separator as CommandSeparator };
+export { Empty as CommandEmpty };
+export { Loading as CommandLoading };
+/** Run a selector against the store state. */
+declare function useCmdk<T = any>(selector: (state: State) => T): T;

package/dist/types/components/DataTable/DataTable.d.ts

@@ -187,6 +187,10 @@ export interface DataTableProps<T = any> extends ComponentPropsWithoutRef<"div">
      * identifiers provided will have their selection checkboxes disabled).
      */
     disabledSelections?: Key[];
+    /** Visually hidden label of the “select all rows” checkbox. */
+    selectAllRowsLabel?: ReactNode;
+    /** Visually hidden label of a “select row” checkbox. */
+    selectRowLabel?: ReactNode;
     /**
      * Function used to render each row. This function should typically return a
      * `DataTableRow` with the provided properties. This function is useful to

package/dist/types/components/DataTable/DataTableContext.d.ts

@@ -16,6 +16,8 @@ export interface DataTableContextValue<T = any> {
     dynamicRowHeight: boolean;
     estimatedRowHeight: number | ((index: number) => number);
     overscan: number;
+    selectAllRowsLabel?: ReactNode;
+    selectRowLabel?: ReactNode;
     generatedId: string;
     showAllRowsWhilePrinting?: boolean;
     apiRef?: Ref<DataTableApi<T> | undefined>;
@@ -105,9 +107,11 @@ export interface UseCreateDataTableContextOptions<T> extends Omit<DataTableConte
     selectedRows?: Key[];
     onSelectedRowsChange?: (selectedRows: Key[]) => void;
     disabledSelections?: Key[];
+    selectAllRowsLabel?: ReactNode;
+    selectRowLabel?: ReactNode;
 }
 /** Hook which creates the data table context value. */
-export declare function useCreateDataTableContext<T>({ displayMode, columns, rows, getRows, rowKey, loadingCount, required, loading, renderRow, renderCell, dynamicRowHeight, estimatedRowHeight, overscan, showAllRowsWhilePrinting, apiRef, leafColumns, headCount, defaultOffset, offset, onOffsetChange, defaultLimit, limit, onLimitChange, defaultFilter, filter, onFilterChange, defaultSortBy, sortBy, defaultSortDirection, sortDirection, onSort, showSelectionColumn, defaultSelectedRows, selectedRows, onSelectedRowsChange, disabledSelections, }: UseCreateDataTableContextOptions<T>): {
+export declare function useCreateDataTableContext<T>({ displayMode, columns, rows, getRows, rowKey, loadingCount, required, loading, renderRow, renderCell, dynamicRowHeight, estimatedRowHeight, overscan, showAllRowsWhilePrinting, apiRef, leafColumns, headCount, defaultOffset, offset, onOffsetChange, defaultLimit, limit, onLimitChange, defaultFilter, filter, onFilterChange, defaultSortBy, sortBy, defaultSortDirection, sortDirection, onSort, showSelectionColumn, defaultSelectedRows, selectedRows, onSelectedRowsChange, disabledSelections, selectAllRowsLabel, selectRowLabel, }: UseCreateDataTableContextOptions<T>): {
     displayMode: DataTableDisplayMode;
     rowKey: string | number | symbol | ((row: any) => Key);
     required: boolean | undefined;
@@ -117,6 +121,8 @@ export declare function useCreateDataTableContext<T>({ displayMode, columns, row
     dynamicRowHeight: boolean;
     estimatedRowHeight: number | ((index: number) => number);
     overscan: number;
+    selectAllRowsLabel: ReactNode;
+    selectRowLabel: ReactNode;
     generatedId: string;
     showAllRowsWhilePrinting: boolean | undefined;
     apiRef: Ref<DataTableApi<any> | undefined> | undefined;

package/dist/types/components/DataTable/DataTablePagination.d.ts

@@ -10,6 +10,8 @@ export interface DataTablePaginationProps extends ComponentPropsWithoutRef<"div"
      * @param total Total number of rows.
      */
     rowsRange?: (range: ReactNode, total: number) => ReactNode;
+    /** Label of the rows range select (only relevant in paged mode). */
+    rowsRangeSelectLabel?: (total: number) => string;
     /** Label of the previous page button (only relevant in paged mode). */
     previousPageButtonLabel?: string;
     /** Label of the next page button (only relevant in paged mode). */

package/dist/types/components/DataTable/PagedDataTablePagination.d.ts

@@ -1,7 +1,7 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { DataTablePaginationProps } from './DataTablePagination.tsx';
 /** Properties of the scrolled data table pagination. */
-export interface PagedDataTablePaginationProps extends ComponentPropsWithoutRef<"div">, Pick<DataTablePaginationProps, "rowsRange" | "previousPageButtonLabel" | "nextPageButtonLabel" | "preferRightAlignment" | "previousPageButtonProps" | "nextPageButtonProps"> {
+export interface PagedDataTablePaginationProps extends ComponentPropsWithoutRef<"div">, Pick<DataTablePaginationProps, "rowsRange" | "rowsRangeSelectLabel" | "previousPageButtonLabel" | "nextPageButtonLabel" | "preferRightAlignment" | "previousPageButtonProps" | "nextPageButtonProps"> {
 }
 /** Pagination component of the scrolled data table. */
 export declare const PagedDataTablePagination: import('react').ForwardRefExoticComponent<PagedDataTablePaginationProps & import('react').RefAttributes<HTMLDivElement>>;

package/dist/types/components/Dialog/Dialog.d.ts

@@ -5,7 +5,8 @@ import { Dialog as DialogPrimitive } from 'radix-ui';
  *
  * Built on top of the [Radix Dialog
  * primitive](https://www.radix-ui.com/primitives/docs/components/dialog), and
- * the `Card` component.
+ * the [`Card`
+ * component](https://ui.ostack.tech/?path=/docs/ostack-ui-data-display-card--docs).
  *
  * It composes the following subcomponents:
  *

package/dist/types/components/DropdownMenu/DropdownMenu.d.ts

@@ -8,7 +8,8 @@ export interface DropdownMenuProps extends Omit<ComponentPropsWithoutRef<typeof
  *
  * Built on top of the [Radix Dropdown Menu
  * primitive](https://www.radix-ui.com/primitives/docs/components/dropdown-menu)
- * and the `MenuList` component.
+ * and the [`MenuList`
+ * component](https://ui.ostack.tech/?path=/docs/ostack-ui-data-display-menu-list--docs).
  *
  * It composes the following subcomponents:
  *

package/dist/types/components/Field/Field.d.ts

@@ -9,12 +9,41 @@ export interface FieldProps extends ComponentPropsWithoutRef<"div"> {
     asChild?: boolean;
 }
 /**
- * The `Field` component groups form controls such as `Input`, `Select`,
- * `RadioButton`, `Checkbox`, and similar components that are used for user
- * input, with an associated `Label`, `HelperText`, and feedback such as errors
- * or validation messages.
+ * The `Field` component acts as a container that associates a form control with
+ * a label, helper text, and validation feedback.
  *
- * It provides automatic linking of the `Label` to the control, and marks the
- * control as "required" when requested by the control.
+ * Use a `Label` to identify the control, a `HelperText` to provide additional
+ * guidance or descriptions, and `Feedback` to display error, warning, or
+ * success messages.
+ *
+ * It supports the following form controls:
+ *
+ * - `Checkbox`
+ * - `CheckboxGroup`
+ * - `DataTable`
+ * - `DateInput`
+ * - `DateRangeInput`
+ * - `NumericInput`
+ * - `Input`
+ * - `RadioGroup`
+ * - `Select`
+ * - `Table`
+ * - `TextArea`
+ *
+ * Example usage:
+ *
+ * ```tsx
+ * import { Field, HelperText, Label, Input } from "@ostack.tech/ui";
+ *
+ * function UsernameField() {
+ *   return (
+ *     <Field>
+ *       <Label>Username</Label>
+ *       <Input />
+ *       <HelperText>May only contain alphanumeric characters.</HelperText>
+ *     </Field>
+ *   );
+ * }
+ * ```
  */
 export declare const Field: import('react').ForwardRefExoticComponent<FieldProps & import('react').RefAttributes<HTMLDivElement>>;

package/dist/types/components/Field/FieldProvider.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+/** Properties of the field provider component. */
+export interface FieldProviderProps {
+    children?: ReactNode;
+}
+/**
+ * Component providing the context necessary for auto-registration of labels,
+ * controls, helper text, and feedback.
+ *
+ * This is automatically done by the `Field` component, so they shouldn't be
+ * used together.
+ */
+export declare function FieldProvider({ children }: FieldProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Field/index.d.ts

@@ -1,2 +1,3 @@
 export * from './Field.tsx';
 export { type FieldActions, useFieldControlFocused, useFieldControlId, useFieldControlRequired, useFieldControlTagName, useFieldDescriptionIds, useFieldErrorMessageIds, useFieldLabel, useFieldLabelId, useOnFieldLabelChange, useSetFieldControl, useSetFieldControlFocused, useSetFieldFeedback, useSetFieldHelperText, useSetFieldLabel, } from './FieldContext.ts';
+export * from './FieldProvider.tsx';

package/dist/types/components/Heading/Heading.d.ts

@@ -26,7 +26,9 @@ export interface HeadingOwnProps {
     level?: HeadingLevel;
 }
 /**
- * Component used to render semantic HTML heading elements.
+ * Component used to render semantic HTML headings. It is built on top of the
+ * browser's [`<h1>`–`<h6>` heading
+ * elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/Heading_Elements).
  *
  * Example usage:
  *

package/dist/types/components/Icon/Icon.d.ts

@@ -1,6 +1,6 @@
-import { FlipProp, IconProp } from '@fortawesome/fontawesome-svg-core';
+import { IconProp } from '@fortawesome/fontawesome-svg-core';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
-import { ComponentPropsWithoutRef } from 'react';
+import { ComponentPropsWithoutRef, ReactNode } from 'react';
 import { AccentColor } from '../../utils/accent.ts';
 export type { IconProp } from '@fortawesome/fontawesome-svg-core';
 /** Possible sizes of an icon. */
@@ -8,7 +8,7 @@ export type IconSize = "3xs" | "2xs" | "xs" | "sm" | "md" | "lg" | "xl" | "2xl"
 /** Possible colours of an icon. */
 export type IconColor = AccentColor;
 /** Properties of the icon component. */
-export interface IconProps extends Omit<ComponentPropsWithoutRef<typeof FontAwesomeIcon>, "icon" | "size" | "flip"> {
+export interface IconProps extends Omit<ComponentPropsWithoutRef<typeof FontAwesomeIcon>, "icon" | "size"> {
     /** Icon to display. */
     icon: IconProp;
     /**
@@ -27,15 +27,14 @@ export interface IconProps extends Omit<ComponentPropsWithoutRef<typeof FontAwes
      * When provided, a visually hidden label is added so that assistive
      * technologies correctly announce it.
      */
-    label?: string;
-    flip?: boolean | FlipProp;
+    label?: ReactNode;
 }
 /**
  * Icon component extending the FontAwesome's `FontAwesomeIcon` component.
  *
  * Properties supported by FontAwesome are also supported by this component. For
  * more information on all supported properties, see [FontAwesome's React
- * documentation](https://docs.fontawesome.com/v5/web/use-with/react).
+ * documentation](https://docs.fontawesome.com/web/use-with/react/).
  *
  * For a list of existing icons, consult:
  * https://fontawesome.com/search?ic=free.

package/dist/types/components/IconButton/IconButton.d.ts

@@ -149,6 +149,13 @@ export interface IconButtonOwnProps {
  * A `label` property is required for screen-readers to give meaning to the
  * button. This label is also, by default, displayed as a tooltip.
  *
+ * Built on top of the browser's [`<button>`
+ * element](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button),
+ * [`Icon`
+ * component](https://ui.ostack.tech/?path=/docs/ostack-ui-data-display-icon--docs),
+ * and [`Tooltip`
+ * component](https://ui.ostack.tech/?path=/docs/ostack-ui-overlay-tooltip--docs).
+ *
  * Example usage:
  *
  * ```tsx