boreal-ui 0.0.74 → 0.0.75

package/dist/core/index.cjs.js

@@ -1400,6 +1400,190 @@ const cardPropDocs = {
     }
   ]
 };
+const checkBoxPropDocs = {
+  "name": "CheckBox",
+  "interfaceName": "CheckBoxProps",
+  "description": "Props for the Checkbox component.",
+  "sourcePath": "src\\components\\Checkbox\\Checkbox.types.ts",
+  "props": [
+    {
+      "name": "aria-describedby",
+      "type": "string",
+      "description": "ID reference(s) to element(s) that describe the checkbox. This may include helper text, error text, or external descriptions.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "aria-errormessage",
+      "type": "string",
+      "description": "ID reference to the element containing the error message. Typically used together with aria-invalid.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "aria-label",
+      "type": "string",
+      "description": "Accessible label for the checkbox when no visible label is present or when a more descriptive label is needed.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "aria-labelledby",
+      "type": "string",
+      "description": "ID reference(s) to element(s) that label the checkbox. If provided, this takes precedence over the internal label association.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "checked",
+      "type": "boolean",
+      "description": "Checked state of the checkbox.",
+      "required": true,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "className",
+      "type": "string",
+      "description": "Custom class name for additional styling.",
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "data-testid",
+      "type": "string",
+      "description": "Optional test ID for testing frameworks.",
+      "required": false,
+      "inherited": false,
+      "category": "testing"
+    },
+    {
+      "name": "description",
+      "type": "ReactNode",
+      "description": "Visible helper text rendered below or beside the checkbox. Should provide extra guidance for the user.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "disabled",
+      "type": "boolean",
+      "description": "Whether the checkbox is disabled.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "errorMessage",
+      "type": "ReactNode",
+      "description": "Visible error message rendered for invalid state. This can also be referenced by assistive technologies.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "indeterminate",
+      "type": "boolean",
+      "description": "Whether the checkbox is in an indeterminate (mixed) state.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "invalid",
+      "type": "boolean",
+      "description": "Marks the checkbox as invalid. Useful when validation fails.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "label",
+      "type": "ReactNode",
+      "description": "Label text displayed beside the checkbox.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "labelPosition",
+      "type": '"left" | "right"',
+      "description": "Position of the label relative to the checkbox ('left' | 'right').",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "onChange",
+      "type": "(checked: boolean) => void",
+      "description": "Callback when the checkbox value changes.",
+      "required": true,
+      "inherited": false,
+      "category": "events"
+    },
+    {
+      "name": "required",
+      "type": "boolean",
+      "description": "Whether the checkbox is required.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "role",
+      "type": '"checkbox"',
+      "description": "Optional role override, though checkbox is the default semantic role.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "rounding",
+      "type": "RoundingType",
+      "description": "Controls the rounding of the checkbox ('none' | 'small' | 'medium' | 'large' | 'full').",
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "shadow",
+      "type": "ShadowType",
+      "description": "Controls the shadow of the checkbox ('none' | 'light' | 'medium' | 'strong' | 'intense').",
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "size",
+      "type": "SizeType",
+      "description": "Size of the checkbox ('xs' | 'small' | 'medium' | 'large' | 'xl').",
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "state",
+      "type": "StateType",
+      "description": "State of the checkbox ('success' | 'error' | 'warning' | 'disabled' | '').",
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "theme",
+      "type": "ThemeType",
+      "description": "Optional theme to style the checkbox ('primary' | 'secondary' | 'tertiary' | 'quaternary' | 'clear').",
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    }
+  ]
+};
 const chipPropDocs = {
   "name": "Chip",
   "interfaceName": "ChipProps",
@@ -1584,6 +1768,70 @@ const chipPropDocs = {
     }
   ]
 };
+const chipGroupPropDocs = {
+  "name": "ChipGroup",
+  "interfaceName": "ChipGroupProps",
+  "description": "",
+  "sourcePath": "src\\components\\Chip\\ChipGroup\\ChipGroup.types.ts",
+  "props": [
+    {
+      "name": "children",
+      "type": "undefined",
+      "description": "Children are not allowed when using `chips`.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "chips",
+      "type": "ChipProps[]",
+      "description": "Chips array is not allowed when using children.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "className",
+      "type": "string",
+      "description": "Optional class name for the chip group container.",
+      "required": false,
+      "inherited": true,
+      "category": "styling"
+    },
+    {
+      "name": "data-testid",
+      "type": "string",
+      "description": "Optional test ID for testing frameworks.",
+      "required": false,
+      "inherited": true,
+      "category": "testing"
+    },
+    {
+      "name": "onRemove",
+      "type": "((id: string) => void)",
+      "description": "Optional callback when a chip is removed.",
+      "required": false,
+      "inherited": true,
+      "category": "events"
+    },
+    {
+      "name": "position",
+      "type": "PositionType",
+      "description": "Default position for chips in the group.",
+      "required": false,
+      "inherited": true,
+      "category": "props"
+    },
+    {
+      "name": "size",
+      "type": "SizeType",
+      "description": "Default size for chips if not individually specified.",
+      "required": false,
+      "inherited": true,
+      "category": "styling"
+    }
+  ]
+};
 const circularProgressPropDocs = {
   "name": "CircularProgress",
   "interfaceName": "CircularProgressProps",
@@ -2422,14 +2670,6 @@ const dateTimePickerPropDocs = {
       "inherited": false,
       "category": "props"
     },
-    {
-      "name": "buttonProps",
-      "type": 'Omit<ButtonHTMLAttributes<HTMLButtonElement>, "disabled" | "title" | "type" | "className" | "aria-label" | "aria-labelledby" | "aria-describedby" | "onClick">',
-      "description": "Optional props passed to the picker trigger button.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
     {
       "name": "className",
       "type": "string",
@@ -2478,14 +2718,6 @@ const dateTimePickerPropDocs = {
       "inherited": false,
       "category": "props"
     },
-    {
-      "name": "inputProps",
-      "type": 'Omit<InputHTMLAttributes<HTMLInputElement>, "disabled" | "name" | "type" | "value" | "defaultValue" | "onChange" | "min" | "max" | ... 10 more ... | "aria-required">',
-      "description": "Optional props passed to the native input element.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
     {
       "name": "label",
       "type": "string",
@@ -2870,14 +3102,6 @@ const dropdownPropDocs = {
       "inherited": false,
       "category": "props"
     },
-    {
-      "name": "menuProps",
-      "type": 'Omit<React.HTMLProps<HTMLDivElement>, "role" | "id" | "children">',
-      "description": "Extra props applied to the menu container.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
     {
       "name": "menuRounding",
       "type": "RoundingType",
@@ -2957,14 +3181,6 @@ const dropdownPropDocs = {
       "required": false,
       "inherited": false,
       "category": "props"
-    },
-    {
-      "name": "triggerProps",
-      "type": 'Omit<IconButtonProps, "aria-label" | "aria-labelledby" | "aria-describedby" | "aria-controls" | "aria-expanded" | "aria-haspopup" | "onClick" | "icon" | ... 4 more ... | "outline">',
-      "description": "Extra props applied to the trigger IconButton. Keeps accessibility flexible without bloating the main API.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
     }
   ]
 };
@@ -3270,14 +3486,6 @@ const fileUploadPropDocs = {
       "inherited": false,
       "category": "props"
     },
-    {
-      "name": "inputProps",
-      "type": 'Omit<React.InputHTMLAttributes<HTMLInputElement>, "disabled" | "type" | "onChange" | "required" | "aria-label" | "aria-labelledby" | "aria-describedby" | ... 4 more ... | "multiple">',
-      "description": "Props passed directly to the native file input.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
     {
       "name": "label",
       "type": "string",
@@ -3350,14 +3558,6 @@ const fileUploadPropDocs = {
       "inherited": false,
       "category": "props"
     },
-    {
-      "name": "progressBarProps",
-      "type": 'Omit<ProgressBarProps, "value" | "theme" | "indeterminate">',
-      "description": "Props passed directly to the progress bar.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
     {
       "name": "rejectedFilesAriaLabel",
       "type": "string",
@@ -3374,14 +3574,6 @@ const fileUploadPropDocs = {
       "inherited": false,
       "category": "events"
     },
-    {
-      "name": "removeButtonProps",
-      "type": 'Omit<IconButtonProps, "aria-label" | "onClick" | "icon" | "state">',
-      "description": "Props passed directly to each remove-file button.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
     {
       "name": "removeFileAriaLabel",
       "type": "((fileName: string, index: number) => string)",
@@ -3406,14 +3598,6 @@ const fileUploadPropDocs = {
       "inherited": false,
       "category": "props"
     },
-    {
-      "name": "selectButtonProps",
-      "type": 'Omit<ButtonProps, "disabled" | "children" | "onClick" | "icon" | "theme" | "state" | "rounding" | "shadow" | "outline">',
-      "description": "Props passed directly to the select-file button.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
     {
       "name": "state",
       "type": "StateType",
@@ -3446,14 +3630,6 @@ const fileUploadPropDocs = {
       "inherited": false,
       "category": "props"
     },
-    {
-      "name": "uploadButtonProps",
-      "type": 'Omit<ButtonProps, "disabled" | "children" | "onClick" | "theme" | "state" | "loading">',
-      "description": "Props passed directly to the upload button.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
     {
       "name": "uploadProgress",
       "type": "number",
@@ -3686,14 +3862,6 @@ const formGroupPropDocs = {
       "inherited": false,
       "category": "props"
     },
-    {
-      "name": "controlProps",
-      "type": "FormGroupControlProps",
-      "description": "Optional props merged into each child control.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
     {
       "name": "data-testid",
       "type": "string",
@@ -3711,25 +3879,9 @@ const formGroupPropDocs = {
       "category": "props"
     },
     {
-      "name": "descriptionProps",
-      "type": "HTMLAttributes<HTMLParagraphElement>",
-      "description": "Optional props applied to the description element.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
-    {
-      "name": "error",
-      "type": "string",
-      "description": "Optional error message shown below the input.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
-    {
-      "name": "errorProps",
-      "type": "HTMLAttributes<HTMLParagraphElement>",
-      "description": "Optional props applied to the error element.",
+      "name": "error",
+      "type": "string",
+      "description": "Optional error message shown below the input.",
       "required": false,
       "inherited": false,
       "category": "props"
@@ -3758,14 +3910,6 @@ const formGroupPropDocs = {
       "inherited": false,
       "category": "props"
     },
-    {
-      "name": "labelProps",
-      "type": 'Omit<LabelHTMLAttributes<HTMLLabelElement>, "id" | "htmlFor">',
-      "description": "Optional props applied to the rendered label element.",
-      "required": false,
-      "inherited": false,
-      "category": "props"
-    },
     {
       "name": "layout",
       "type": '"horizontal" | "vertical"',
@@ -4960,6 +5104,326 @@ const notificationCenterPropDocs = {
     }
   ]
 };
+const pagerPropDocs = {
+  "name": "Pager",
+  "interfaceName": "PagerProps",
+  "description": "Props for the Pager (pagination) component.",
+  "sourcePath": "src\\components\\Pager\\Pager.types.ts",
+  "props": [
+    {
+      "name": "aria-describedby",
+      "type": "string",
+      "description": "Optional description id for the pagination navigation region.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "aria-label",
+      "type": "string",
+      "description": "Accessible label for the pagination navigation region.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "aria-labelledby",
+      "type": "string",
+      "description": "Optional labelledby id for the pagination navigation region.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "className",
+      "type": "string",
+      "description": "Optional extra class name(s) for custom styling.",
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "currentPage",
+      "type": "number",
+      "description": "The currently active page (1-indexed).",
+      "required": true,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "data-testid",
+      "type": "string",
+      "description": "Optional test ID for testing frameworks.",
+      "required": false,
+      "inherited": false,
+      "category": "testing"
+    },
+    {
+      "name": "getLiveRegionMessage",
+      "type": "((currentPage: number, totalPages: number) => string)",
+      "description": "Function used to generate the live region status message.",
+      "required": false,
+      "inherited": false,
+      "category": "events"
+    },
+    {
+      "name": "getPageAriaLabel",
+      "type": "((page: number, isActive: boolean) => string)",
+      "description": "Function used to generate an accessible label for each page button.",
+      "required": false,
+      "inherited": false,
+      "category": "events"
+    },
+    {
+      "name": "itemsPerPage",
+      "type": "number",
+      "description": "Number of items to display per page.",
+      "required": true,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "liveRegionAriaLive",
+      "type": '"off" | "polite" | "assertive"',
+      "description": "ARIA live politeness setting for the status message.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "next-button-aria-label",
+      "type": "string",
+      "description": "Accessible label for the next page button.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "onPageChange",
+      "type": "(page: number) => void",
+      "description": "Callback function invoked when a page change occurs.",
+      "required": true,
+      "inherited": false,
+      "category": "events"
+    },
+    {
+      "name": "page-list-aria-label",
+      "type": "string",
+      "description": "Accessible label for the page list.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "previous-button-aria-label",
+      "type": "string",
+      "description": "Accessible label for the previous page button.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "rounding",
+      "type": "RoundingType",
+      "description": 'Rounding of the controls. One of: "none" | "small" | "medium" | "large" | "full"',
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "serverControlled",
+      "type": "boolean",
+      "description": "Enables server side control of the paging.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "shadow",
+      "type": "ShadowType",
+      "description": 'Shadow of the controls. One of: "none" | "light" | "medium" | "strong" | "intense"',
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "size",
+      "type": "SizeType",
+      "description": 'Optional size modifier for pagination buttons. One of: "xs" | "small" | "medium" | "large" | "xl"',
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "state",
+      "type": "StateType",
+      "description": 'Optional state of the component for feedback styling. One of: "success" | "error" | "warning" | "disabled" | ""',
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "theme",
+      "type": "ThemeType",
+      "description": 'Optional theme to apply for pagination. One of: "primary" | "secondary" | "tertiary" | "quaternary" | "clear"',
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "totalItems",
+      "type": "number",
+      "description": "Total number of items to paginate through.",
+      "required": true,
+      "inherited": false,
+      "category": "props"
+    }
+  ]
+};
+const popoverPropDocs = {
+  "name": "Popover",
+  "interfaceName": "PopoverProps",
+  "description": "Props for the Popover component.",
+  "sourcePath": "src\\components\\PopOver\\PopOver.types.ts",
+  "props": [
+    {
+      "name": "aria-describedby",
+      "type": "string",
+      "description": "Associates the popover content with an external description element ID.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "aria-label",
+      "type": "string",
+      "description": "Accessible label for the popover content region.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "aria-labelledby",
+      "type": "string",
+      "description": "Associates the popover content with an external label element ID.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "aria-modal",
+      "type": "boolean",
+      "description": "Whether the popover should be announced as modal when role is dialog.",
+      "required": false,
+      "inherited": false,
+      "category": "aria"
+    },
+    {
+      "name": "className",
+      "type": "string",
+      "description": "Optional additional class name(s) for custom styling.",
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "content",
+      "type": "ReactNode",
+      "description": "Content to be displayed inside the popover.",
+      "required": true,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "data-testid",
+      "type": "string",
+      "description": "Optional test ID for testing frameworks.",
+      "required": false,
+      "inherited": false,
+      "category": "testing"
+    },
+    {
+      "name": "disabled",
+      "type": "boolean",
+      "description": "Disables interaction with the trigger and popover.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "id",
+      "type": "string",
+      "description": "Optional ID for the popover content element.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "placement",
+      "type": '"left" | "right" | "top" | "bottom"',
+      "description": 'Placement of the popover relative to the trigger element. One of: "top" | "bottom" | "left" | "right"',
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "rounding",
+      "type": "RoundingType",
+      "description": 'Rounding of the popover content. One of: "none" | "small" | "medium" | "large" | "full"',
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "shadow",
+      "type": "ShadowType",
+      "description": 'Shadow of the popover content. One of: "none" | "light" | "medium" | "strong" | "intense"',
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "state",
+      "type": "StateType",
+      "description": 'State of the popover, for feedback styling. One of: "success" | "error" | "warning" | "disabled" | ""',
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "theme",
+      "type": "ThemeType",
+      "description": 'Theme for the popover styling. One of: "primary" | "secondary" | "tertiary" | "quaternary" | "clear"',
+      "required": false,
+      "inherited": false,
+      "category": "styling"
+    },
+    {
+      "name": "trigger",
+      "type": "ReactNode",
+      "description": "Trigger element that toggles the popover's visibility.",
+      "required": true,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "triggerAriaLabel",
+      "type": "string",
+      "description": "Accessible label for the trigger button.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    },
+    {
+      "name": "triggerTitle",
+      "type": "string",
+      "description": "Accessible label for the trigger button when expanded/collapsed state needs custom wording.",
+      "required": false,
+      "inherited": false,
+      "category": "props"
+    }
+  ]
+};
 const progressBarPropDocs = {
   "name": "ProgressBar",
   "interfaceName": "ProgressBarProps",
@@ -8221,6 +8685,8 @@ exports.badgePropDocs = badgePropDocs;
 exports.breadcrumbsPropDocs = breadcrumbsPropDocs;
 exports.buttonPropDocs = buttonPropDocs;
 exports.cardPropDocs = cardPropDocs;
+exports.checkBoxPropDocs = checkBoxPropDocs;
+exports.chipGroupPropDocs = chipGroupPropDocs;
 exports.chipPropDocs = chipPropDocs;
 exports.circularProgressPropDocs = circularProgressPropDocs;
 exports.colorPickerPropDocs = colorPickerPropDocs;
@@ -8240,6 +8706,8 @@ exports.metricBoxPropDocs = metricBoxPropDocs;
 exports.modalPropDocs = modalPropDocs;
 exports.navBarPropDocs = navBarPropDocs;
 exports.notificationCenterPropDocs = notificationCenterPropDocs;
+exports.pagerPropDocs = pagerPropDocs;
+exports.popoverPropDocs = popoverPropDocs;
 exports.progressBarPropDocs = progressBarPropDocs;
 exports.radioButtonPropDocs = radioButtonPropDocs;
 exports.ratingPropDocs = ratingPropDocs;