@luscii-healthtech/web-ui 8.0.1 → 8.0.2

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

@@ -4,34 +4,52 @@ export declare enum CheckboxState {
     UNCHECKED = "unchecked"
 }
 export interface CheckboxListProps {
+    /**
+     * An array of items to render as checkboxes. Each item can be a single item or a group. When the
+     * title isn't specified, the group will render as a non-collapsible list. This is the way to
+     * render a regular list of checkboxes.
+     *
+     * @example
+     * Single list of checkboxes without visual grouping.
+     *
+     * ```tsx
+     * const groups = [{
+     *   items: [
+     *     {
+     *       id: "1",
+     *       label: "Item 1",
+     *     },
+     *     {
+     *       id: "2",
+     *       label: "Item 2",
+     *     },
+     *   ],
+     * }]
+     * ```
+     */
     groups: CheckboxGroup[];
     onChange: (event: CheckboxChangeEvent) => void;
+    /**
+     * Renders dividers between each item, including groups and inside of groups.
+     */
     hasDividers?: boolean;
     className?: string;
 }
 type WithCollapsible = {
     /**
-     * When `false`, will prevent the checkbox list from being collapsed (also disabling clicking to expand/collapse)
+     * When `false` will prevent the checkbox list from being collapsed (also disabling clicking to expand/collapse)
      * in the component and it will be displayed expanded by default.
      * @default true
      */
     collapsible?: boolean;
 };
-export type CheckboxGroupProps = {
-    title?: string;
-    items: CheckboxListItem[];
+export type CheckboxGroupProps = CheckboxGroup & {
     onChange: (event: CheckboxChangeEvent) => void;
     hasDividers?: boolean;
     className?: string;
-    isCollapsed?: boolean;
 } & WithCollapsible;
-export interface CheckboxGroupItemProps {
-    id: string;
-    label: string;
-    isChecked?: boolean;
-    isDisabled?: boolean;
+export interface CheckboxGroupItemProps extends CheckboxListItem {
     onChange: (event: CheckboxChangeEvent) => void;
-    className?: string;
 }
 export interface CheckboxListItem {
     id: string;
@@ -41,8 +59,17 @@ export interface CheckboxListItem {
     className?: string;
 }
 export type CheckboxGroup = {
+    /**
+     * When the title isn't specified, the group will render as a non-collapsible list.
+     */
     title?: string;
+    /**
+     * The checkbox items to be shown inside of this group.
+     */
     items: CheckboxListItem[];
+    /**
+     * Whether the group is initially collapsed or not.
+     */
     isCollapsed?: boolean;
 } & WithCollapsible;
 export interface CheckboxChangeEvent {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luscii-healthtech/web-ui",
-  "version": "8.0.1",
+  "version": "8.0.2",
   "license": "MIT",
   "author": {
     "name": "Joris Janssen"