neatkit 0.3.1 → 0.4.0

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

@@ -43,6 +43,15 @@ type ButtonOwnProps = {
 type ButtonReference<Component extends ElementType> = ComponentPropsWithRef<Component>["ref"];
 /** A type representing properties for a polymorphic Button element. */
 export type ButtonProps<Component extends ElementType = "button"> = ButtonOwnProps & {
+    /**
+     * The intrinsic element or custom component used as the outer control.
+     *
+     * Intrinsic elements without native interactivity receive Button
+     * semantics. Custom components own their native semantics and complete
+     * unavailable behavior, including suppressing persistent navigation
+     * targets. They must forward the class name, reference, event handlers,
+     * ARIA properties, and tab index to their interactive root.
+     */
     as?: Component;
 } & Omit<ComponentPropsWithoutRef<Component>, keyof ButtonOwnProps | "as">;
 /** A type representing the public polymorphic Button component. */

package/dist/components/Popover/Popover.d.ts

@@ -17,7 +17,10 @@ export type PopoverProps = Omit<HTMLAttributes<HTMLDivElement>, "children" | "de
     closeOnEscape?: boolean;
     /** Whether an uncontrolled Popover is initially open. */
     defaultOpen?: boolean;
-    /** Whether Popover behavior is disabled without removing its trigger. */
+    /**
+     * Whether Popover behavior is disabled while leaving the supplied trigger's
+     * semantics and interaction unchanged.
+     */
     disabled?: boolean;
     /** The preferred element focused when the Popover opens. */
     initialFocusReference?: RefObject<HTMLElement | null>;
@@ -40,7 +43,11 @@ export type PopoverProps = Omit<HTMLAttributes<HTMLDivElement>, "children" | "de
     /**
      * The single element that receives Popover trigger behavior.
      *
-     * Custom components must forward standard DOM properties and a reference.
+     * Intrinsic elements without native interactivity receive Button semantics.
+     * Custom components own their native semantics, keyboard behavior, and
+     * complete unavailable state, including suppressing persistent navigation
+     * targets. They must forward standard DOM properties, composed event
+     * handlers, and a reference to their interactive root.
      */
     trigger: ReactElement;
 };
@@ -63,7 +70,10 @@ declare const Popover: import("react").ForwardRefExoticComponent<Omit<HTMLAttrib
     closeOnEscape?: boolean;
     /** Whether an uncontrolled Popover is initially open. */
     defaultOpen?: boolean;
-    /** Whether Popover behavior is disabled without removing its trigger. */
+    /**
+     * Whether Popover behavior is disabled while leaving the supplied trigger's
+     * semantics and interaction unchanged.
+     */
     disabled?: boolean;
     /** The preferred element focused when the Popover opens. */
     initialFocusReference?: RefObject<HTMLElement | null>;
@@ -86,7 +96,11 @@ declare const Popover: import("react").ForwardRefExoticComponent<Omit<HTMLAttrib
     /**
      * The single element that receives Popover trigger behavior.
      *
-     * Custom components must forward standard DOM properties and a reference.
+     * Intrinsic elements without native interactivity receive Button semantics.
+     * Custom components own their native semantics, keyboard behavior, and
+     * complete unavailable state, including suppressing persistent navigation
+     * targets. They must forward standard DOM properties, composed event
+     * handlers, and a reference to their interactive root.
      */
     trigger: ReactElement;
 } & import("react").RefAttributes<HTMLDivElement>>;

package/dist/components/Portal/utils/focus-restoration.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Restores focus while exposing the restoration to synchronous focus handlers.
+ *
+ * @param element - The element that owned focus before an overlay opened.
+ */
+export declare function restoreElementFocus(element: HTMLElement): void;
+/**
+ * Determines whether an element is receiving restored overlay focus.
+ *
+ * @param element - The focus event target being inspected.
+ *
+ * @returns Whether focus is currently being restored to the element.
+ */
+export declare function isElementFocusRestoration(element: HTMLElement): boolean;

package/dist/components/Table/Table.d.ts

@@ -0,0 +1,287 @@
+import { type HTMLAttributeAnchorTarget, type HTMLAttributes, type MouseEventHandler, type ReactNode, type TableHTMLAttributes, type TdHTMLAttributes, type ThHTMLAttributes } from "react";
+import { type ButtonProps } from "../Button";
+import { type IconType } from "../Icon";
+import "./styles/table.css";
+/** A value rendered directly or formatted by a Table cell. */
+export type TableCellValue = boolean | Date | number | string;
+/** The horizontal alignment applied to Table cell content. */
+export type TableCellAlignment = "left" | "center" | "right";
+/** A type representing properties for the Table component. */
+export type TableProps = TableHTMLAttributes<HTMLTableElement> & {
+    /** The table sections, rows, and cells rendered inside the Table. */
+    children: ReactNode;
+    /** The additional class name applied to the horizontal scroll container. */
+    containerClassName?: string;
+    /** The accessible label announced for the horizontal scroll container. */
+    scrollContainerLabel?: string;
+};
+/** A type representing properties for the Table.Head component. */
+export type TableHeadProps = HTMLAttributes<HTMLTableSectionElement> & {
+    /** The rows rendered inside the Table head. */
+    children: ReactNode;
+};
+/** A type representing properties for the Table.Body component. */
+export type TableBodyProps = HTMLAttributes<HTMLTableSectionElement> & {
+    /** The rows rendered inside the Table body. */
+    children?: ReactNode;
+    /** The number of columns occupied by the generated empty-state cell. */
+    emptyColumnCount?: number;
+    /** The content displayed when children contain no explicit content. */
+    emptyMessage?: ReactNode;
+};
+/** A type representing properties for the Table.Foot component. */
+export type TableFootProps = HTMLAttributes<HTMLTableSectionElement> & {
+    /** The rows rendered inside the Table foot. */
+    children: ReactNode;
+};
+/** Shared native properties for every Table.Row configuration. */
+type TableRowBaseProps = Omit<HTMLAttributes<HTMLTableRowElement>, "children" | "onClick"> & {
+    /** The cells rendered inside the Table row. */
+    children: ReactNode;
+};
+/** A type representing a static Table.Row configuration. */
+type TableStaticRowProps = {
+    /** Static rows do not expose download behavior. */
+    download?: never;
+    /** Static rows do not expose a navigation destination. */
+    href?: never;
+    /** Static rows do not describe a linked resource language. */
+    hrefLang?: never;
+    /** Static rows do not require an action label. */
+    label?: never;
+    /** Static rows do not expose whole-row activation. */
+    onClick?: never;
+    /** Static rows do not expose navigation interception. */
+    onNavigate?: never;
+    /** Static rows do not target a browsing context. */
+    target?: never;
+};
+/** A type representing a button-backed Table.Row configuration. */
+type TableButtonRowProps = {
+    /** Button-backed rows do not expose download behavior. */
+    download?: never;
+    /** Button-backed rows do not expose a navigation destination. */
+    href?: never;
+    /** Button-backed rows do not describe a linked resource language. */
+    hrefLang?: never;
+    /** The accessible name describing the whole-row action. */
+    label: string;
+    /** The callback invoked when the row's button is activated. */
+    onClick: MouseEventHandler<HTMLButtonElement>;
+    /** Button-backed rows do not expose navigation interception. */
+    onNavigate?: never;
+    /** Button-backed rows do not target a browsing context. */
+    target?: never;
+};
+/** A type representing a link-backed Table.Row configuration. */
+type TableLinkRowProps = {
+    /** Whether the linked resource should be downloaded. */
+    download?: boolean | string;
+    /** The destination opened by whole-row activation. */
+    href: string;
+    /** The language of the linked resource. */
+    hrefLang?: string;
+    /** The accessible name describing the whole-row link. */
+    label: string;
+    /** Link-backed rows do not expose button activation. */
+    onClick?: never;
+    /** The callback invoked when the row's link is activated. */
+    onNavigate?: MouseEventHandler<HTMLAnchorElement>;
+    /** The relationship between the table and linked resource. */
+    rel?: string;
+    /** The browsing context used to open the linked resource. */
+    target?: HTMLAttributeAnchorTarget;
+};
+/** A type representing properties for the Table.Row component. */
+export type TableRowProps = TableRowBaseProps & (TableButtonRowProps | TableLinkRowProps | TableStaticRowProps);
+/** Shared properties configuring a Table header cell. */
+type TableHeaderCellOwnProps = {
+    /** The horizontal alignment applied to the header content. */
+    align?: TableCellAlignment;
+    /** The content rendered inside the header cell. */
+    children?: ReactNode;
+    /** Whether the header pins its supported edge column during scrolling. */
+    sticky?: boolean;
+};
+/** A type representing properties for the Table.HeaderCell component. */
+export type TableHeaderCellProps = Omit<ThHTMLAttributes<HTMLTableCellElement>, "align" | "children"> & TableHeaderCellOwnProps;
+/** A type representing properties for the Table.ActionHeaderCell component. */
+export type TableActionHeaderCellProps = Omit<TableHeaderCellProps, "align">;
+/** A type representing properties for the Table.Cell component. */
+export type TableCellProps = Omit<TdHTMLAttributes<HTMLTableCellElement>, "align" | "children"> & {
+    /** The horizontal alignment applied to the cell content. */
+    align?: TableCellAlignment;
+    /** Content rendered when no value is supplied. */
+    children?: ReactNode;
+    /** A function transforming the supplied value into displayed content. */
+    format?: (value: TableCellValue) => ReactNode;
+    /** The maximum CSS width used to truncate overflowing content. */
+    truncate?: string;
+    /** The primitive value displayed or passed to the format function. */
+    value?: TableCellValue;
+};
+/** A type representing properties for the Table.Action component. */
+export type TableActionProps = Omit<ButtonProps<"button">, "as" | "children" | "className" | "fullWidth" | "icon" | "iconAlignment" | "shape" | "style" | "textAlignment" | "type" | "variant"> & {
+    /** The icon identifying the row action. */
+    icon: IconType;
+    /** The short Tooltip label and base accessible name for the row action. */
+    label: string;
+};
+/** A type representing properties for the Table.ActionCell component. */
+export type TableActionCellProps = Omit<TdHTMLAttributes<HTMLTableCellElement>, "align" | "children"> & {
+    /** The consistently styled row actions rendered inside the cell. */
+    children?: ReactNode;
+};
+/** A type representing the complete compound Table component. */
+type TableComponent = typeof TableRoot & {
+    /** A consistently styled control operating on one Table row. */
+    Action: typeof TableAction;
+    /** The cell containing persistent row-level actions. */
+    ActionCell: typeof TableActionCell;
+    /** The header cell labelling the row-actions column. */
+    ActionHeaderCell: typeof TableActionHeaderCell;
+    /** The body section containing Table data rows. */
+    Body: typeof TableBody;
+    /** A standard Table data cell. */
+    Cell: typeof TableCell;
+    /** The footer section containing Table summary rows. */
+    Foot: typeof TableFoot;
+    /** The header cell identifying a Table column. */
+    HeaderCell: typeof TableHeaderCell;
+    /** The head section containing Table column labels. */
+    Head: typeof TableHead;
+    /** A Table row. */
+    Row: typeof TableRow;
+};
+/**
+ * Renders the Table head section.
+ *
+ * @param props - The native section properties and header rows.
+ * @param forwardedReference - The reference assigned to the head element.
+ *
+ * @returns The rendered Table head section.
+ */
+declare const TableHead: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLTableSectionElement> & {
+    /** The rows rendered inside the Table head. */
+    children: ReactNode;
+} & import("react").RefAttributes<HTMLTableSectionElement>>;
+/**
+ * Renders the Table body and its optional empty state.
+ *
+ * @param props - The native section, row, and empty-state properties.
+ * @param forwardedReference - The reference assigned to the body element.
+ *
+ * @returns The rendered Table body section.
+ */
+declare const TableBody: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLTableSectionElement> & {
+    /** The rows rendered inside the Table body. */
+    children?: ReactNode;
+    /** The number of columns occupied by the generated empty-state cell. */
+    emptyColumnCount?: number;
+    /** The content displayed when children contain no explicit content. */
+    emptyMessage?: ReactNode;
+} & import("react").RefAttributes<HTMLTableSectionElement>>;
+/**
+ * Renders the Table foot section.
+ *
+ * @param props - The native section properties and footer rows.
+ * @param forwardedReference - The reference assigned to the foot element.
+ *
+ * @returns The rendered Table foot section.
+ */
+declare const TableFoot: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLTableSectionElement> & {
+    /** The rows rendered inside the Table foot. */
+    children: ReactNode;
+} & import("react").RefAttributes<HTMLTableSectionElement>>;
+/**
+ * Renders a native Table row without replacing its table semantics.
+ *
+ * @param props - The native row properties and cells.
+ * @param forwardedReference - The reference assigned to the row element.
+ *
+ * @returns The rendered Table row.
+ */
+declare const TableRow: import("react").ForwardRefExoticComponent<TableRowProps & import("react").RefAttributes<HTMLTableRowElement>>;
+/**
+ * Renders a column header cell.
+ *
+ * @param props - The native header properties and displayed label.
+ * @param forwardedReference - The reference assigned to the header cell.
+ *
+ * @returns The rendered Table column header.
+ */
+declare const TableHeaderCell: import("react").ForwardRefExoticComponent<Omit<ThHTMLAttributes<HTMLTableCellElement>, "children" | "align"> & TableHeaderCellOwnProps & import("react").RefAttributes<HTMLTableCellElement>>;
+/**
+ * Renders the header for a row-actions column.
+ *
+ * @param props - The native header properties and optional visible label.
+ * @param forwardedReference - The reference assigned to the header cell.
+ *
+ * @returns The rendered Table actions header.
+ */
+declare const TableActionHeaderCell: import("react").ForwardRefExoticComponent<TableActionHeaderCellProps & import("react").RefAttributes<HTMLTableCellElement>>;
+/**
+ * Renders a data cell with optional value formatting and truncation.
+ *
+ * @param props - The native cell, content, and display properties.
+ * @param forwardedReference - The reference assigned to the data cell.
+ *
+ * @returns The rendered Table data cell.
+ */
+declare const TableCell: import("react").ForwardRefExoticComponent<Omit<TdHTMLAttributes<HTMLTableCellElement>, "children" | "align"> & {
+    /** The horizontal alignment applied to the cell content. */
+    align?: TableCellAlignment;
+    /** Content rendered when no value is supplied. */
+    children?: ReactNode;
+    /** A function transforming the supplied value into displayed content. */
+    format?: (value: TableCellValue) => ReactNode;
+    /** The maximum CSS width used to truncate overflowing content. */
+    truncate?: string;
+    /** The primitive value displayed or passed to the format function. */
+    value?: TableCellValue;
+} & import("react").RefAttributes<HTMLTableCellElement>>;
+/**
+ * Renders one consistently styled control operating on a Table row.
+ *
+ * @param props - The short label, icon, and native button properties.
+ * @param forwardedReference - The reference assigned to the action button.
+ *
+ * @returns The rendered Table row action.
+ */
+declare const TableAction: import("react").ForwardRefExoticComponent<Omit<ButtonProps<"button">, "className" | "style" | "children" | "icon" | "variant" | "type" | "as" | "shape" | "fullWidth" | "iconAlignment" | "textAlignment"> & {
+    /** The icon identifying the row action. */
+    icon: IconType;
+    /** The short Tooltip label and base accessible name for the row action. */
+    label: string;
+} & import("react").RefAttributes<HTMLButtonElement>>;
+/**
+ * Renders the cell containing controls for one Table row.
+ *
+ * @param props - The native cell properties and composed Table actions.
+ * @param forwardedReference - The reference assigned to the action cell.
+ *
+ * @returns The rendered Table action cell.
+ */
+declare const TableActionCell: import("react").ForwardRefExoticComponent<Omit<TdHTMLAttributes<HTMLTableCellElement>, "children" | "align"> & {
+    /** The consistently styled row actions rendered inside the cell. */
+    children?: ReactNode;
+} & import("react").RefAttributes<HTMLTableCellElement>>;
+/**
+ * Renders a semantic Table inside a keyboard-scrollable surface.
+ *
+ * @param props - The native table and presentation properties.
+ * @param forwardedReference - The reference assigned to the table element.
+ *
+ * @returns The rendered Table and its horizontal scroll container.
+ */
+declare const TableRoot: import("react").ForwardRefExoticComponent<TableHTMLAttributes<HTMLTableElement> & {
+    /** The table sections, rows, and cells rendered inside the Table. */
+    children: ReactNode;
+    /** The additional class name applied to the horizontal scroll container. */
+    containerClassName?: string;
+    /** The accessible label announced for the horizontal scroll container. */
+    scrollContainerLabel?: string;
+} & import("react").RefAttributes<HTMLTableElement>>;
+/** The compound Table component and its semantic subcomponents. */
+declare const Table: TableComponent;
+export default Table;

package/dist/components/Table/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Table } from "./Table";
+export type { TableActionCellProps, TableActionHeaderCellProps, TableActionProps, TableBodyProps, TableCellAlignment, TableCellProps, TableCellValue, TableFootProps, TableHeaderCellProps, TableHeadProps, TableProps, TableRowProps, } from "./Table";