@instruments/materia-ui 0.4.5 → 0.4.7

package/dist/compositions/product-specifications-selector/product-specifications-selector.d.ts

@@ -14,7 +14,16 @@ interface SiblingWithAttributes {
     variantAttributes: VariantAttributes | null;
 }
 export interface ProductSpecificationsSelectorProps {
+    /**
+     * The current selection, keyed by filter key (`"color"` for `colorName`, otherwise the
+     * dimension name such as `"finish"`) to the selected option's `value`, or `null` for none.
+     */
     filters: Record<string, string | null>;
+    /**
+     * Called when an option is picked, with the filter key and the option's `value`;
+     * picking the selected option again sends `null` to clear it. When `onSiblingSelect` and
+     * `siblingsWithAttributes` find a matching sibling, that fires instead.
+     */
     onFilterChange: (key: string, value: string | null) => void;
     /** Callback when a sibling is selected (fallback variant selection) */
     onSiblingSelect?: (siblingId: string) => void;
@@ -26,6 +35,11 @@ export interface ProductSpecificationsSelectorProps {
     siblings?: Sibling[];
     /** Full sibling data with variant attributes for computing compatible options on hover */
     siblingsWithAttributes?: SiblingWithAttributes[];
+    /**
+     * The options on offer per dimension (`colorName`, `pattern`, `finish`, `size`, `width`,
+     * `length`, `substrate`, `finishType`). Each present dimension becomes one field, ordered
+     * with colourways first; an option with `available: false` is shown as unavailable.
+     */
     variantOptions: VariantOptions;
 }
 /**

package/dist/compositions/sidebar/sidebar-group.d.ts

@@ -7,6 +7,10 @@ export declare const SidebarGroup: ({ className, ...props }: React.ComponentProp
 export declare const SidebarGroupLabel: ({ className, render, ...props }: useRender.ComponentProps<"div">) => React.ReactElement<unknown, string | React.JSXElementConstructor<any>>;
 /** Icon button pinned to a group's top-right corner (defaults to a `+`); hidden when collapsed unless `showWhenCollapsed`. */
 export declare const SidebarGroupAction: ({ className, icon, size, radius, emphasis, showWhenCollapsed, ...props }: React.ComponentProps<typeof Button> & {
+    /** Size token, as on Button. @default "icon-sm" */
+    size?: React.ComponentProps<typeof Button>["size"];
+    /** Visual weight, as on Button. @default "ghost" */
+    emphasis?: React.ComponentProps<typeof Button>["emphasis"];
     /** Show the action button even when sidebar is collapsed */
     showWhenCollapsed?: boolean;
 }) => React.JSX.Element;

package/dist/compositions/sidebar/sidebar-menu-button.d.ts

@@ -10,16 +10,27 @@ type SidebarMenuButtonProps = Omit<useRender.ComponentProps<"button">, "children
     tooltip?: string | React.ComponentProps<typeof TooltipContent>;
     /** Control tooltip visibility. Use `false` to hide tooltip (e.g., when a dropdown is open). */
     tooltipOpen?: boolean;
+    /**
+     * Row height and text size. Use `"xl"` in an icon-collapsible sidebar so the collapsed square centres on the rail.
+     * @default "base"
+     */
     size?: ComponentSize;
+    /**
+     * Surface treatment: `"input"` uses the sidebar's accent fill on hover and when active, `"default"` the standard accent tint, `"outline"` adds a ring.
+     * @default "input"
+     */
     variant?: "default" | "input" | "outline";
+    /** Leading icon component. When the sidebar collapses to the rail it is the only thing shown, unless `collapsedIcon` or `collapsedContent` replaces it. */
     icon?: IconComponent;
     /** Icon to show when sidebar is collapsed (overrides icon) */
     collapsedIcon?: IconComponent;
     /** Custom content to show when sidebar is collapsed (e.g., Avatar). Takes precedence over collapsedIcon. */
     collapsedContent?: React.ReactNode;
+    /** Trailing icon component, such as a chevron for a submenu. Replaces the `kbd` hint when both are set, and hides when the sidebar collapses. */
     suffixIcon?: IconComponent;
     /** Keep label/suffix visible even when the sidebar provider is collapsed. */
     forceExpanded?: boolean;
+    /** Keyboard shortcut keys shown as keycaps at the end of the row, one string per key (e.g. `["⌘", "K"]`). Hidden when collapsed or when `suffixIcon` is set. */
     kbd?: string[];
     children?: React.ReactNode;
 };

package/dist/compositions/sidebar/sidebar-menu-sub.d.ts

@@ -26,6 +26,10 @@ type SidebarMenuSubButtonProps = Omit<MenuItemProps, "icon" | "dot"> & {
     icon?: IconComponent;
     /** Additional className for the icon */
     iconClassName?: string;
+    /** Row size, as on MenuItem. @default "xl" */
+    size?: MenuItemProps["size"];
+    /** Row style, as on MenuItem. @default "input" */
+    variant?: MenuItemProps["variant"];
 };
 /**
  * SidebarMenuSubButton UI component.

package/dist/compositions/sidebar/sidebar-trigger.d.ts

@@ -4,6 +4,8 @@ import type { IconComponent } from "../../tokens/icon-component.js";
 type SidebarTriggerProps = Omit<React.ComponentProps<typeof Button>, "icon"> & {
     /** Icon to display. Defaults to PanelLeftCloseIcon. */
     icon?: IconComponent;
+    /** Visual weight, as on Button. @default "ghost" */
+    emphasis?: React.ComponentProps<typeof Button>["emphasis"];
 };
 /** Icon button that toggles the sidebar open/collapsed via {@link useSidebar}; must render inside a {@link SidebarProvider}. Any `onClick` runs before the toggle. */
 export declare const SidebarTrigger: ({ className, emphasis, onClick, icon, ...props }: SidebarTriggerProps) => React.JSX.Element;

package/dist/compositions/variant-selector/variant-selector-item.d.ts

@@ -8,6 +8,7 @@ export interface VariantSelectorItemProps {
     disabled?: boolean;
     /** Whether this option is highlighted (compatible with a hovered unavailable option) */
     highlighted?: boolean;
+    /** Picture shown inside the tile, such as an `<img>` of the variant; omit it for a plain `color` tile. */
     image?: ReactNode;
     /** Label text */
     label: string;