@luscii-healthtech/web-ui 7.6.0 → 7.6.2

package/dist/components/Checkbox/Checkbox.d.ts

@@ -1,17 +1,53 @@
 import React from "react";
 import "./Checkbox.scss";
 export interface CheckboxProps {
+    /**
+     * ID used for semantic targeting, as can be used in attributes like `<label htmlFor="some-id">`.
+     */
     id?: string;
+    /**
+     * The visible text labeling the checkbox element.
+     */
     text?: string;
+    /**
+     * Helper text that adds some more information on what the option means, or inform
+     * the user about the consequences of the checkbox.
+     */
     explanation?: string;
+    /**
+     * Shows a different checkbox variant. `type="switch"` shows a switch-like component
+     * without a visual label.
+     */
     type?: "regular" | "switch";
+    /**
+     * Set the value.
+     * Same as `checked` on `<input type="checkbox" />`.
+     */
     isChecked?: boolean;
+    /**
+     * Value for when it is not clear if the state of this checkbox
+     * is "checked" or not (for hierarchical checkboxes).
+     */
     isIndeterminate?: boolean;
+    /**
+     * Disallow the user to change the checkbox value.
+     * Same as `disabled` on `<input type="checkbox" />`.
+     */
     isDisabled?: boolean;
+    /**
+     * The name that the value of the checkbox will be associated with.
+     * Same as `name` on `<input type="checkbox" />`.
+     */
     name?: string;
+    /**
+     * This can be used to retrieve the value it is referring to through onChange.
+     */
     value?: string;
     onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
     className?: string;
+    /**
+     * Visually show that the currently selected value has an issue the user needs to attend to.
+     */
     error?: boolean;
     innerRef?: React.Ref<HTMLInputElement>;
 }

package/dist/components/Input/Input.d.ts

@@ -53,5 +53,5 @@ export interface InputProps extends CustomHTMLInputProps {
      */
     asFormField?: boolean;
 }
-declare const Input: React.ForwardRefExoticComponent<InputProps & React.RefAttributes<HTMLInputElement>>;
+export declare const Input: React.ForwardRefExoticComponent<InputProps & React.RefAttributes<HTMLInputElement>>;
 export default Input;