pixelize-design-library 2.4.2-beta.67 → 2.4.2-beta.69

package/dist/Components/CouponField/CouponFieldProps.d.ts

@@ -3,18 +3,26 @@ import type { PriceFormat } from "../Commerce/commerceTypes";
 export type CouponStatus = "idle" | "applying" | "applied" | "error";
 /** A coupon the shopper can apply with one tap. */
 export interface CouponSuggestion {
+    /** Coupon code, shown in a badge and passed to `onApply` when the suggestion is tapped. */
     code: string;
+    /** Offer headline shown beside the code, e.g. "10% off". */
     title: string;
     /** Terms line, e.g. "Min. order ₹999". */
     detail?: string;
 }
 /** Visible copy; override every string for another language. */
 export interface CouponFieldLabels {
+    /** Text of the collapsed toggle row; default "Have a coupon?". */
     prompt: string;
+    /** Accessible name of the code input; default "Coupon code". */
     inputLabel: string;
+    /** Input placeholder; default "Enter code". */
     placeholder: string;
+    /** Apply button text, also the hint on each suggestion; default "Apply". */
     apply: string;
+    /** Remove button text in the applied state; default "Remove". */
     remove: string;
+    /** Heading above the suggestion list; default "Available offers". */
     suggestionsTitle: string;
     /** Status text once applied, given the code. */
     applied: (code: string) => string;
@@ -25,6 +33,7 @@ export interface CouponFieldLabels {
 }
 /** Controlled coupon entry: a collapsed "Have a coupon?" row that opens into a field, then settles into an applied chip. */
 export interface CouponFieldProps extends PriceFormat {
+    /** Lifecycle state; default "idle". "applying" disables the input and shows a spinner, "error" shows `error`, "applied" collapses to the chip. */
     status?: CouponStatus;
     /** The code shown in the applied state. */
     appliedCode?: string;
@@ -34,16 +43,23 @@ export interface CouponFieldProps extends PriceFormat {
     error?: string;
     /** Called with the upper-cased code from the button, Enter, or a suggestion; set `status` to "applying" while it resolves. */
     onApply?: (code: string) => void;
+    /** Called from the Remove button shown in the applied state; the parent should then reset `status`. */
     onRemove?: () => void;
+    /** Offers listed under the field, each applied in one tap; the list is hidden when empty. */
     suggestions?: CouponSuggestion[];
     /** Input text when controlled. */
     value?: string;
+    /** Initial input text when uncontrolled; default empty. */
     defaultValue?: string;
+    /** Called with the code as typed or picked; whitespace is stripped and letters upper-cased first. */
     onValueChange?: (value: string) => void;
     /** Open state of the collapsed row when controlled; the field is always open while applying or in error. */
     expanded?: boolean;
+    /** Whether the field starts open when `expanded` is not controlled; default false. */
     defaultExpanded?: boolean;
+    /** Called with the new open state when the prompt row is toggled. */
     onExpandedChange?: (expanded: boolean) => void;
+    /** Per-string copy overrides; unset keys keep the English defaults. */
     labels?: Partial<CouponFieldLabels>;
     "data-testid"?: string;
 }

package/dist/Components/CustomModulesTable/CustomModulesTable.d.ts

@@ -1,4 +1,5 @@
 import React from "react";
 import { CustomModulesTableProps } from "./CustomModulesTableProps";
+/** Card with a two-column module list (name, owner) and per-row Edit and Delete dialogs; loading shows skeleton bars, empty shows an empty state. */
 declare const CustomModulesTable: React.FC<CustomModulesTableProps>;
 export default CustomModulesTable;

package/dist/Components/CustomModulesTable/CustomModulesTable.js

@@ -31,6 +31,7 @@ const DEFAULT_LABELS = {
     confirmDeletion: "Confirm Deletion",
     deleteConfirmPrefix: "Are you sure you want to delete",
 };
+/** Card with a two-column module list (name, owner) and per-row Edit and Delete dialogs; loading shows skeleton bars, empty shows an empty state. */
 const CustomModulesTable = ({ modules, isLoading = false, isUpdating = false, isDeleting = false, onUpdateModule, onDeleteModule, labels: labelOverrides, }) => {
     var _a;
     const { colors } = (0, useCustomTheme_1.useCustomTheme)();

package/dist/Components/CustomModulesTable/CustomModulesTableProps.d.ts

@@ -9,7 +9,9 @@ export type ModuleItem = {
 };
 /** Shape passed to onUpdateModule — `moduleId` identifies the item being edited, `moduleName` is the new value from the modal. */
 export type UpdateModulePayload = {
+    /** `module_id` of the row being edited. */
     moduleId: number;
+    /** New name, trimmed; never empty because Update is disabled for a blank name. */
     moduleName: string;
 };
 /**
@@ -19,10 +21,13 @@ export type UpdateModulePayload = {
 export type CustomModulesTableLabels = {
     /** Card heading; defaults to "Custom Modules". */
     title?: string;
+    /** Header of the module name column. */
     moduleName?: string;
+    /** Header of the owner column. */
     moduleOwner?: string;
     /** Header of the right-aligned Edit/Delete column. */
     action?: string;
+    /** Text of each row's Edit button. */
     edit?: string;
     /** Row button label, reused for the delete dialog's confirm button. */
     delete?: string;
@@ -62,19 +67,31 @@ export interface CustomModulesTableProps {
 }
 /** Internal edit-name dialog rendered by CustomModulesTable; `labels` must already be fully resolved, not per-key optional. */
 export interface EditModuleModalProps {
+    /** Shows the dialog. */
     isOpen: boolean;
+    /** Called on Cancel, the close button, Escape or an overlay click. */
     onClose: () => void;
+    /** Seeds the name field each time the dialog opens. */
     initialName: string;
+    /** Spinner on the Update button. */
     isLoading?: boolean;
+    /** Called with the trimmed name when Update is pressed. */
     onSubmit: (name: string) => void | Promise<void>;
+    /** Fully resolved strings; no per-key fallback happens here. */
     labels: Required<Pick<CustomModulesTableLabels, "editModuleTitle" | "moduleNamePlaceholder" | "cancel" | "update">>;
 }
 /** Internal delete-confirmation dialog rendered by CustomModulesTable; `moduleName` is optional since the target can be cleared mid-close. */
 export interface DeleteModuleModalProps {
+    /** Shows the dialog. */
     isOpen: boolean;
+    /** Called on Cancel, the close button, Escape or an overlay click. */
     onClose: () => void;
+    /** Named in the confirmation prompt after `deleteConfirmPrefix`. */
     moduleName?: string;
+    /** Spinner on the confirm button. */
     isLoading?: boolean;
+    /** Called when the confirm button is pressed. */
     onConfirm: () => void;
+    /** Fully resolved strings; no per-key fallback happens here. */
     labels: Required<Pick<CustomModulesTableLabels, "confirmDeletion" | "deleteConfirmPrefix" | "cancel" | "delete">>;
 }

package/dist/Components/CustomModulesTable/DeleteModuleModal.d.ts

@@ -1,4 +1,5 @@
 import React from "react";
 import { DeleteModuleModalProps } from "./CustomModulesTableProps";
+/** Confirmation dialog for deleting a module; used by CustomModulesTable. */
 declare const DeleteModuleModal: React.FC<DeleteModuleModalProps>;
 export default DeleteModuleModal;

package/dist/Components/CustomModulesTable/DeleteModuleModal.js

@@ -9,6 +9,7 @@ const lucide_react_1 = require("lucide-react");
 const useCustomTheme_1 = require("../../Theme/useCustomTheme");
 const accentText_1 = require("../../Theme/tokens/builders/accentText");
 const ConfirmDialog_1 = __importDefault(require("../ConfirmDialog/ConfirmDialog"));
+/** Confirmation dialog for deleting a module; used by CustomModulesTable. */
 const DeleteModuleModal = ({ isOpen, onClose, moduleName, isLoading, onConfirm, labels, }) => {
     const { colors } = (0, useCustomTheme_1.useCustomTheme)();
     return ((0, jsx_runtime_1.jsx)(ConfirmDialog_1.default, { isOpen: isOpen, onClose: onClose, onConfirm: onConfirm, title: labels.confirmDeletion, iconBg: colors.semantic.error[50], iconColor: (0, accentText_1.accentTextOnCanvas)(colors.semantic.error, colors.semantic.error[50]), cancelLabel: labels.cancel, confirmLabel: labels.delete, confirmIcon: (0, jsx_runtime_1.jsx)(lucide_react_1.Trash2, { size: 15 }), isConfirmLoading: isLoading, disableCancelWhilePending: false, focusCancelOnOpen: false, children: (0, jsx_runtime_1.jsxs)(react_1.Text, { color: colors.textMuted, fontSize: "sm", mb: 5, children: [labels.deleteConfirmPrefix, " ", (0, jsx_runtime_1.jsx)(react_1.Text, { as: "span", fontWeight: 600, color: colors.text[800], children: moduleName }), "?"] }) }));

package/dist/Components/CustomModulesTable/EditModuleModal.d.ts

@@ -1,4 +1,5 @@
 import React from "react";
 import { EditModuleModalProps } from "./CustomModulesTableProps";
+/** Dialog with one text field to rename a module; used by CustomModulesTable. */
 declare const EditModuleModal: React.FC<EditModuleModalProps>;
 export default EditModuleModal;

package/dist/Components/CustomModulesTable/EditModuleModal.js

@@ -9,6 +9,7 @@ const react_2 = require("@chakra-ui/react");
 const useCustomTheme_1 = require("../../Theme/useCustomTheme");
 const surfaceRaised_1 = require("../../Theme/tokens/builders/surfaceRaised");
 const Button_1 = __importDefault(require("../Button/Button"));
+/** Dialog with one text field to rename a module; used by CustomModulesTable. */
 const EditModuleModal = ({ isOpen, onClose, initialName, isLoading, onSubmit, labels, }) => {
     const { colors } = (0, useCustomTheme_1.useCustomTheme)();
     const [name, setName] = (0, react_1.useState)(initialName);

package/dist/Components/DatePicker/DatePickerProps.d.ts

@@ -5,6 +5,7 @@ export type PickerType = "date" | "time" | "datetime";
 export type BaseDatePickerProps = {
     id?: string;
     name?: string;
+    /** Label above the field; also the calendar popover's accessible name (falls back to "Choose date" / "Choose date range"). */
     label?: string;
     /** Shows the label asterisk and sets native `required` via FormControl. */
     isRequired?: boolean;
@@ -24,7 +25,7 @@ export type BaseDatePickerProps = {
     placeholderText?: string;
     /** date-fns format; defaults to `dd/MM/yyyy` (`HH:mm` for the time-only picker). Time tokens add time inputs. */
     dateFormat?: string;
-    /** Pass explicitly: inference reads `MM` as minutes, so bare `dd/MM/yyyy` also shows time selects. Ignored when `isRange`. */
+    /** Inferred from `dateFormat` when omitted: `H`/`h`/`mm`/`ss` mean time, so a lowercase `dd/mm/yyyy` is read as minutes and shows time selects while `dd/MM/yyyy` stays date-only. Ignored when `isRange`. */
     pickerType?: PickerType;
     /** Earlier days are disabled in the calendar and rejected when typed. */
     minDate?: Date;
@@ -49,6 +50,7 @@ export type BaseDatePickerProps = {
 };
 /** Single-date variant, Date API (default) — `isRange` must be false or omitted; this is the discriminant the DatePickerProps union switches on. */
 export type SingleDatePickerDateProps = BaseDatePickerProps & {
+    /** Omit or false for a single-date picker; the discriminant `DatePickerProps` switches on. */
     isRange?: false;
     /** Omit, or set `"date"`, for the default Date-object API; `"iso"` switches value/onChange to ISO strings. */
     valueFormat?: "date";
@@ -61,6 +63,7 @@ export type SingleDatePickerDateProps = BaseDatePickerProps & {
 };
 /** Single-date variant, string API — `yyyy-MM-dd` / `HH:mm` / full local ISO datetime by pickerType; an unparsable incoming string reads as `null`. */
 export type SingleDatePickerStringProps = BaseDatePickerProps & {
+    /** Omit or false for a single-date picker; the discriminant `DatePickerProps` switches on. */
     isRange?: false;
     /** `"iso"` opts into the string API for this instance. */
     valueFormat: "iso";
@@ -76,11 +79,14 @@ export type SingleDatePickerProps = SingleDatePickerDateProps | SingleDatePicker
 export declare const isStringValueProps: (props: SingleDatePickerProps) => props is SingleDatePickerStringProps;
 /** A date range's two endpoints, each independently nullable — used for both the controlled value and onChange's payload. */
 export type RangeDate = {
+    /** Range start, `null` until picked. */
     from: Date | null;
+    /** Range end, `null` until picked. */
     to: Date | null;
 };
 /** Range variant — `isRange` must be true; adds dayStates/renderDayContent day-marking on top of the shared base fields. */
 export type RangeDatePickerProps = BaseDatePickerProps & {
+    /** Must be true to render the range picker. */
     isRange: true;
     /** Controlled range; `value` wins when both are set. */
     selectedDate?: RangeDate | null;

package/dist/Components/DetailSections/DetailSectionsProps.d.ts

@@ -2,8 +2,11 @@ import type { ReactNode } from "react";
 import type { SpecItem } from "../SpecTable/SpecTableProps";
 /** One long-form section. */
 export interface DetailSection {
+    /** Unique key and DOM anchor (`detail-section-<id>`); reusing a built-in id replaces that built-in section. */
     id: string;
+    /** Heading of the accordion row or tab label. */
     title: string;
+    /** Body rendered inside the section panel. */
     content: ReactNode;
 }
 /** Indian legal-metrology disclosures; every field is optional and an empty block is not rendered. */
@@ -12,6 +15,7 @@ export interface LegalInfo {
     netQuantity?: string;
     /** Name and address of the manufacturer, packer or importer. */
     manufacturer?: string;
+    /** Row value for the "Country of origin" line. */
     originCountry?: string;
     /** Line printed beside "MRP"; defaults to "Maximum retail price, inclusive of all taxes". */
     mrpNote?: string;
@@ -20,16 +24,27 @@ export interface LegalInfo {
 }
 /** Every string the sections render; override all of them for another language. */
 export interface DetailSectionsLabels {
+    /** Title of the description section. */
     description: string;
+    /** Title of the highlights section. */
     highlights: string;
+    /** Title of the specifications section. */
     specifications: string;
+    /** Title of the care section. */
     care: string;
+    /** Title of the shipping and returns section. */
     shipping: string;
+    /** Title of the legal and manufacturer section. */
     legal: string;
+    /** Row label for `legal.netQuantity`. */
     netQuantity: string;
+    /** Row label for `legal.manufacturer`. */
     manufacturer: string;
+    /** Row label for `legal.originCountry`. */
     originCountry: string;
+    /** Row label for the price note row (`legal.mrpNote` or `mrpIncludesTaxes`). */
     mrp: string;
+    /** Row label for `legal.customerCare`. */
     customerCare: string;
     /** Default `mrpNote`. */
     mrpIncludesTaxes: string;
@@ -38,21 +53,28 @@ export interface DetailSectionsLabels {
 export type DetailSectionsLayout = "accordion" | "tabs";
 /** Long-form product information: description, highlights, specifications, care, shipping and returns, and legal-metrology info. */
 export interface DetailSectionsProps {
+    /** Paragraph shown in the description section; the section is omitted when empty. */
     description?: string;
+    /** Bullet list with check icons in the highlights section; omitted when empty. */
     highlights?: string[];
+    /** Rows of the specifications table; the section is omitted when empty. */
     specs?: SpecItem[];
     /** Care instructions; a list renders as bullets. */
     care?: string | string[];
     /** Shipping and returns copy. */
     shipping?: ReactNode;
+    /** Legal-metrology disclosures; the section is omitted when no field is filled. */
     legal?: LegalInfo;
     /** Extra sections appended after the built-in ones, or replacing a built-in one with the same id (`description`, `highlights`, `specs`, `care`, `shipping`, `legal`). */
     sections?: DetailSection[];
+    /** `accordion` (default) or `tabs`. */
     layout?: DetailSectionsLayout;
     /** Section ids open on mount in `accordion` layout; defaults to the first section. */
     defaultOpenIds?: string[];
     /** Rows of the specifications table shown before "Show all". */
     specCollapsedCount?: number;
+    /** Overrides any subset of the rendered strings; unset keys keep their English default. */
     labels?: Partial<DetailSectionsLabels>;
+    /** Test id placed on the root wrapper. */
     "data-testid"?: string;
 }

package/dist/Components/Drawer/DrawerProps.d.ts

@@ -1,5 +1,5 @@
 import { DrawerProps as ChakraDrawerProps, DrawerContentProps, ModalHeaderProps, ModalBodyProps, ModalFooterProps } from "@chakra-ui/react";
-/** Only DrawerHeader/Body/Footer children render, matched by type one fragment deep; any other child is dropped (dev console.warn) — use `portalChildren`. */
+/** Only DrawerHeader/Body/Footer children render, matched by type through nested Fragments; any other child is dropped (dev console.warn) — use `portalChildren`. */
 export type DrawerProps = Pick<ChakraDrawerProps, "isOpen" | "onClose" | "placement" | "size" | "id" | "variant" | "initialFocusRef" | "finalFocusRef" | "closeOnOverlayClick" | "closeOnEsc"> & {
     /** Defaults to "xl". */
     size?: "xs" | "sm" | "md" | "lg" | "xl" | "full";

package/dist/Components/Dropdown/DropdownProps.d.ts

@@ -3,6 +3,7 @@ import { ButtonProps } from "@chakra-ui/react";
 export type DropdownProps = {
     /** Rendered only for the default dropdownType="button" — has no effect under dropdownType="text" (use `text` there). */
     ButtonText?: string;
+    /** Menu rows in order; `id` and `label` are passed to `handleOptionSelect`, and `image` adds a leading icon. */
     options: Option[];
     /** Fires on click, Enter or Space; the menu closes and focus returns to the trigger. */
     handleOptionSelect: (id: string | number, label: string) => void;

package/dist/Components/Editor/EditorProps.d.ts

@@ -5,6 +5,7 @@ type JoditEditorProps = ComponentProps<typeof JoditEditor>;
 export type EditorMergeField = {
     /** Dotted path the backend resolves, e.g. `candidate.name`. */
     path: string;
+    /** Text shown on the chip and in the Insert field menu. */
     label: string;
     /** Heading the field is listed under in the Insert field menu. */
     group?: string;
@@ -25,45 +26,70 @@ export type EditorMergeField = {
 };
 /** How a token is written in the stored HTML. */
 export type EditorTokenSyntax = {
+    /** Opening delimiter, e.g. `${`; matched literally. */
     open: string;
+    /** Closing delimiter, e.g. `}`; matched literally. */
     close: string;
 };
 /** Imperative handle for toolbar buttons and `apiRef`; every method works on the live editor. */
 export interface EditorApi {
+    /** Inserts raw HTML at the last remembered caret position, or at the cursor if none was recorded. */
     insertHTML(html: string): void;
+    /** Inserts a chip for the merge field `path` (a raw token when `mergeFields` is unset); an unknown path renders as an unknown-field chip. */
     insertField(path: string): void;
+    /** Returns the trimmed text of the last remembered selection, or an empty string when there is none. */
     getSelectionText(): string;
     /** Replaces every plain-text occurrence outside tokens and tags; returns the count. */
     replaceAll(text: string, path: string): number;
+    /** Counts plain-text occurrences of `text` outside tokens and tags that `replaceAll` would replace. */
     countOccurrences(text: string): number;
+    /** Moves keyboard focus into the editing area. */
     focus(): void;
 }
 /** An extra button in the strip above the editor. */
 export type EditorToolbarButton = {
+    /** Unique key; also forms the button's test id `editor-button-<id>`. */
     id: string;
+    /** Visible button text. */
     label: string;
+    /** Icon component reference (e.g. `Star`), not a rendered element; shown before the label. */
     icon?: ElementType;
     /** Read through a ref — a new function each render never re-creates the editor. */
     onClick: (api: EditorApi) => void;
+    /** Disables this button; it is also disabled while the editor is loading or read-only. */
     isDisabled?: boolean;
 };
 /** Every visible string of the merge-field UI; omit a key to keep its English default. */
 export type EditorLabels = Partial<{
     /** Accessible name of the editing area when no visible `label` is given. */
     editor: string;
+    /** Placeholder and accessible name of the Insert field menu. */
     insertField: string;
+    /** Text shown in the Insert field menu when it has no options. */
     noFields: string;
+    /** Text of the Make dynamic toolbar button. */
     makeDynamic: string;
+    /** Title of the Make dynamic dialog. */
     dynamicTitle: string;
+    /** Label of the field picker in the Make dynamic dialog. */
     dynamicField: string;
+    /** Placeholder of the field picker in the Make dynamic dialog. */
     dynamicFieldPlaceholder: string;
+    /** Receives the number of matches and returns the line shown under the picker, e.g. "3 occurrences will be replaced". */
     dynamicCount: (n: number) => string;
+    /** Text of the confirm button in the Make dynamic dialog. */
     dynamicReplace: string;
+    /** Message shown in the Make dynamic dialog when no text was selected. */
     dynamicNoSelection: string;
+    /** Receives the comma-joined unmatched token paths and returns the validation message shown under the editor. */
     unknownTokens: (list: string) => string;
+    /** Text of the cancel button in the Make dynamic dialog. */
     cancel: string;
+    /** Caption above the selected text in the Make dynamic dialog. */
     dynamicSelected: string;
+    /** Accessible name of the toolbar strip above the editor. */
     toolbar: string;
+    /** Receives a field label and returns the accessible name of its chip, e.g. "Field: Name". */
     fieldChip: (label: string) => string;
 }>;
 /** Props for the lazy-loaded Jodit wrapper; a `config.theme`/`config.popupRoot` you pass overrides this library's own dark-mode fix. */
@@ -72,13 +98,17 @@ export type EditorProps = Pick<JoditEditorProps, "value" | "className" | "onChan
     config?: JoditEditorProps["config"];
     /** `key` is dead (React reserves it, never reaches Jodit); `editorRef.current` stays null until the lazy chunk loads. */
     editorRef?: JoditEditorProps["ref"];
+    /** Reserved by React and never reaches Jodit; has no effect, so do not rely on it to remount the editor. */
     key?: string | number;
+    /** Visible label above the editor; clicking it focuses the editor, and it becomes the editor's accessible name. */
     label?: string;
+    /** Shows a required asterisk and sets `aria-required`; does not validate. */
     isRequired?: boolean;
     /** Hint under the editor; replaced by `errorMessage` while `error` is true. */
     helperText?: string;
     /** Marks the editor invalid; `errorMessage` shows only while this is true. */
     error?: boolean;
+    /** Message shown instead of `helperText` while `error` is true. */
     errorMessage?: string;
     /** Enables the Insert field menu, token chips and Make dynamic. */
     mergeFields?: EditorMergeField[];
@@ -92,8 +122,11 @@ export type EditorProps = Pick<JoditEditorProps, "value" | "className" | "onChan
     onUnknownTokens?: (paths: string[]) => void;
     /** Imperative API, available after the lazy chunk loads (`onReady` fires then). */
     apiRef?: Ref<EditorApi>;
+    /** Fires once the lazy Jodit chunk has loaded and the editor is ready, when `apiRef` becomes usable. */
     onReady?: () => void;
+    /** Overrides any subset of the UI strings; unset keys keep their English default. */
     labels?: EditorLabels;
+    /** Test id placed on the root wrapper. */
     "data-testid"?: string;
 };
 export {};

package/dist/Components/Editor/editorTokens.d.ts

@@ -13,8 +13,11 @@ export declare function makeDynamic(html: string, selectedText: string, path: st
 };
 export declare function countOccurrences(html: string, selectedText: string, syntax?: EditorTokenSyntax): number;
 export type ChipContext = {
+    /** Merge fields used to resolve a path to its chip label and hover sample. */
     fields: EditorMergeField[];
+    /** Token delimiters the chips serialize back to. */
     syntax: EditorTokenSyntax;
+    /** Maps a field label to the chip's accessible name. */
     chipLabel: (label: string) => string;
 };
 export declare function chipHtml(path: string, { fields, syntax, chipLabel }: ChipContext): string;

package/dist/Components/EmailCards/VerifyEmailOtp/VerifyEmailOtpProps.d.ts

@@ -10,21 +10,29 @@ type VerifyEmailOtpLabels = {
 };
 /** Props for the full OTP verification card (icon, title, resend link); for a bare input in your own layout use PinInput. */
 export type VerifyEmailOtpProps = {
+    /** Called when the Resend Code button is pressed. */
     resendMail: () => void;
+    /** Called with the digits typed so far on every change. */
     onChange: (value: string) => void;
     /** Fires once all `pins` cells are filled — a `pins` value that doesn't match the actual OTP length blocks or truncates completion. */
     onComplete: (value: string) => void;
+    /** Character shown in each empty cell; none by default. */
     placeholder?: string;
     /** Typed as required, but the implementation silently defaults to 5 if a caller bypasses the type and omits it. */
     pins: number;
+    /** Card heading; also the accessible name of the cell group when set. */
     title: string;
+    /** First line under the heading. */
     description: string;
     /** Second line under `description`. Defaults to "your new Pixel Account"; pass "" to drop the line. */
     subtitle?: string;
     /** Replaces the English UI text; any label left out keeps its default. */
     labels?: VerifyEmailOtpLabels;
+    /** Disables every cell. */
     isDisabled?: boolean;
+    /** Marks the cells invalid. */
     isInvalid?: boolean;
+    /** Inline style on the card's outer box. */
     styles?: React.CSSProperties;
 };
 export {};

package/dist/Components/FilePreview/FilePreviewProps.d.ts

@@ -2,7 +2,9 @@
 export type FilePreviewKind = "image" | "pdf" | "video" | "other";
 /** Props for FilePreview, a modal viewer that infers image/pdf/video/other from the file extension. */
 export interface FilePreviewProps {
+    /** Shows the modal. */
     isOpen: boolean;
+    /** Called on close button, Escape or overlay click. */
     onClose: () => void;
     /** Changing this while isOpen stays true does NOT reset zoom/rotation — remount via key={fileUrl}. */
     fileUrl: string;
@@ -21,10 +23,12 @@ export interface FilePreviewTriggerProps {
     fileUrl: string;
     /** Names the button "Preview <fileName>" ("Preview file" when omitted) and drives kind detection. */
     fileName?: string;
+    /** Forces a renderer; inferred from the file extension when omitted. */
     fileType?: FilePreviewKind;
     /** Thumbnail max width. */
     thumbWidth?: string;
     /** Thumbnail max height. */
     thumbHeight?: string;
+    /** Hides the download action inside the opened preview. */
     hideDownload?: boolean;
 }

package/dist/Components/FileUploader/FileUploaderProps.d.ts

@@ -2,6 +2,7 @@
 export type UploadedFile = {
     /** Random per pick, not derived from the file; the same file re-added gets a new id. */
     id: string;
+    /** Original file name with extension; its extension also labels the tile of a non-image file. */
     name: string;
     /** Bytes, while `maxTotalSize` is in MB. */
     size: number;

package/dist/Components/FilterBar/FilterBarProps.d.ts

@@ -1,7 +1,9 @@
 import type { HTMLAttributes, ReactNode } from "react";
 /** One active filter chip; label is what's shown, id identifies it for removal. */
 export interface FilterBarActiveFilter {
+    /** Passed to `onRemoveFilter` when this chip's remove icon is clicked. */
     id: string | number;
+    /** Chip text. */
     label: string;
 }
 /** Search + filters + actions toolbar row; other `<div>` attributes land on the root. */

package/dist/Components/FormDrawer/FormDrawer.d.ts

@@ -1,2 +1,3 @@
 import type { FormDrawerProps } from "./FormDrawerProps";
+/** Sectioned create/edit form in a Drawer with error summary, sticky footer and discard-changes confirm. */
 export default function FormDrawer({ isOpen, onClose, title, description, sections, errors, isDirty, onSubmit, isSubmitting, isSubmitDisabled, submitLabel, cancelLabel, secondaryAction, size, labels, "data-testid": testId, }: FormDrawerProps): import("react/jsx-runtime").JSX.Element;

package/dist/Components/FormDrawer/FormDrawer.js

@@ -51,6 +51,7 @@ const DEFAULT_LABELS = {
     discard: "Discard",
     keepEditing: "Keep editing",
 };
+/** Sectioned create/edit form in a Drawer with error summary, sticky footer and discard-changes confirm. */
 function FormDrawer({ isOpen, onClose, title, description, sections, errors = [], isDirty, onSubmit, isSubmitting = false, isSubmitDisabled = false, submitLabel = "Save", cancelLabel = "Cancel", secondaryAction, size = "md", labels, "data-testid": testId = "form-drawer", }) {
     const { colors } = (0, useCustomTheme_1.useCustomTheme)();
     const uid = (0, react_1.useId)();

package/dist/Components/FormDrawer/FormDrawerProps.d.ts

@@ -7,6 +7,7 @@ export type FormDrawerSection = {
     title?: string;
     /** Muted line under `title`; ignored without a title. */
     description?: string;
+    /** Body of the section, rendered below its title and description. */
     content: ReactNode;
 };
 /** Every user-facing string FormDrawer owns; pass the ones you localise. */
@@ -24,6 +25,7 @@ export type FormDrawerLabels = {
 };
 /** Sectioned create/edit form in a Drawer: error summary, sticky footer, and a discard-changes confirm when closing while dirty. */
 export interface FormDrawerProps {
+    /** Controlled open state; the drawer stays closed until this is true. */
     isOpen: boolean;
     /** Called once the user has really closed: clean close, or Discard confirmed. Never called while `isSubmitting`. */
     onClose: () => void;
@@ -31,6 +33,7 @@ export interface FormDrawerProps {
     title: string;
     /** Muted line under the title. */
     description?: string;
+    /** Form blocks rendered top to bottom in array order. */
     sections: FormDrawerSection[];
     /** Validation messages shown as a summary above the form; the summary takes focus after a submit that leaves any. */
     errors?: string[];

package/dist/Components/FormField/FormField.d.ts

@@ -1,3 +1,4 @@
 import type { FormFieldProps } from "./FormFieldProps";
+/** Wires a label, required marker, helper and error text to one control through ids and aria attributes. */
 declare const FormField: import("react").ForwardRefExoticComponent<FormFieldProps & import("react").RefAttributes<HTMLDivElement>>;
 export default FormField;

package/dist/Components/FormField/FormField.js

@@ -15,6 +15,7 @@ const joinIds = (...ids) => [...new Set(ids.flatMap((value) => { var _a; return
 const asWirableElement = (children) => typeof children !== "function" && (0, react_1.isValidElement)(children) && children.type !== react_1.Fragment
     ? children
     : undefined;
+/** Wires a label, required marker, helper and error text to one control through ids and aria attributes. */
 const FormField = (0, react_1.forwardRef)(function FormField({ label, id, isRequired = false, error = false, errorMessage, helperText, layout = "vertical", labelWidth = "12rem", children, ...rest }, ref) {
     var _a;
     const { colors } = (0, useCustomTheme_1.useCustomTheme)();

package/dist/Components/FormField/FormFieldProps.d.ts

@@ -1,18 +1,22 @@
 import type { HTMLAttributes, ReactElement, ReactNode } from "react";
 /** The wiring FormField hands its control; spread it onto the focusable element. */
 export interface FormFieldControlProps {
+    /** Id for the control; the label, helper and error ids derive from it. */
     id: string;
     /** Points at the field's label element, so composites that a `<label for>` cannot name still get one. */
     "aria-labelledby": string;
     /** The error when shown, else the helper text, plus any description the child already had. */
     "aria-describedby": string | undefined;
+    /** True while `error` is set, else undefined. */
     "aria-invalid": true | undefined;
+    /** True when the field is required, else undefined. */
     "aria-required": true | undefined;
 }
 /** Where the label sits relative to the control. */
 export type FormFieldLayout = "vertical" | "horizontal";
 /** Label, required marker, helper text and error message around any one control; other `<div>` attributes land on the root. */
 export interface FormFieldProps extends Omit<HTMLAttributes<HTMLDivElement>, "id" | "children" | "color" | "dangerouslySetInnerHTML"> {
+    /** Label text, shown beside or above the control. */
     label: string;
     /** The control's id, which the label and message ids derive from; defaults to the child element's own `id`, else a generated one. */
     id?: string;

package/dist/Components/Header/Header.d.ts

@@ -2,5 +2,6 @@ import { FC } from "react";
 import type { ColorScale } from "../../Theme/tokens/types";
 import { HeaderProps } from "./HeaderProps";
 export declare const pickActiveAccent: (primary: ColorScale, canvas: string) => string;
+/** Sticky top bar with logo, page links, hover dropdowns and a collapsible mobile menu; colours default to the sidebar tokens. */
 declare const Header: FC<HeaderProps>;
 export default Header;

package/dist/Components/Header/Header.js

@@ -58,6 +58,7 @@ const pickActiveAccent = (primary, canvas) => {
     return primary[found !== null && found !== void 0 ? found : order[order.length - 1]];
 };
 exports.pickActiveAccent = pickActiveAccent;
+/** Sticky top bar with logo, page links, hover dropdowns and a collapsible mobile menu; colours default to the sidebar tokens. */
 const Header = ({ logo, menuItems, rightSlot, active, colors, boxShadow, onMobileMenuClose }) => {
     var _a, _b, _c, _d, _e;
     const { isOpen, onOpen, onClose } = (0, react_1.useDisclosure)();