@trackunit/react-components 0.0.55 → 0.0.57

package/components/Checkbox/Checkbox.d.ts

@@ -28,8 +28,19 @@ export interface CheckboxProps extends CommonProps, React.InputHTMLAttributes<HT
     indeterminate?: boolean;
 }
 /**
- * A base checkbox component that can be used for boolean inputs, selectors etc.
- * A reference to the input element is provided as the `ref` prop.
- * Extends props from [React.InputHTMLAttributes](https://reactjs.org/docs/dom-elements.html#input)
+ * Checkbox are interactive elements that represent the boolean logical value (true or false) that can be used for boolean inputs, selectors etc.
+ *
+ * Checkboxes are used when there are multiple items to select in a list. Users can select zero, one, or any number of items.
+ *
+ * Checkboxes are used for multiple choices, not for mutually exclusive choices. Each checkbox works independently from other checkboxes in the list, therefore checking an additional box does not affect any other selections.
+ *
+ * _**Do use** checkboxes to allow selection in a form, for filtering, terms and conditions to indicate agreement, and bulk actions in lists or tables._
+ *
+ * _**Do not use** checkboxes if the user can only select one option from a list, radio buttons should be used instead of checkboxes._
+ *
+ * @description A reference to the input element is provided as the `ref` prop.
+ * @augments props from [React.InputHTMLAttributes](https://reactjs.org/docs/dom-elements.html#input)
+ * @param {CheckboxProps} props - The props for the Checkbox component
+ * @returns {JSX.Element} Checkbox component
  */
 export declare const Checkbox: React.ForwardRefExoticComponent<CheckboxProps & React.RefAttributes<HTMLInputElement>>;

package/index.js

@@ -1435,9 +1435,20 @@ const IndeterminateIcon = ({
 }));
 
 /**
- * A base checkbox component that can be used for boolean inputs, selectors etc.
- * A reference to the input element is provided as the `ref` prop.
- * Extends props from [React.InputHTMLAttributes](https://reactjs.org/docs/dom-elements.html#input)
+ * Checkbox are interactive elements that represent the boolean logical value (true or false) that can be used for boolean inputs, selectors etc.
+ *
+ * Checkboxes are used when there are multiple items to select in a list. Users can select zero, one, or any number of items.
+ *
+ * Checkboxes are used for multiple choices, not for mutually exclusive choices. Each checkbox works independently from other checkboxes in the list, therefore checking an additional box does not affect any other selections.
+ *
+ * _**Do use** checkboxes to allow selection in a form, for filtering, terms and conditions to indicate agreement, and bulk actions in lists or tables._
+ *
+ * _**Do not use** checkboxes if the user can only select one option from a list, radio buttons should be used instead of checkboxes._
+ *
+ * @description A reference to the input element is provided as the `ref` prop.
+ * @augments props from [React.InputHTMLAttributes](https://reactjs.org/docs/dom-elements.html#input)
+ * @param {CheckboxProps} props - The props for the Checkbox component
+ * @returns {JSX.Element} Checkbox component
  */
 
 const Checkbox = React.forwardRef((_a, ref) => {
@@ -1515,6 +1526,7 @@ const StyledIndeterminateIcon = tw(IndeterminateIcon)`
 `;
 const CheckboxWrapper = tw.span`
   checkbox
+  transition
   ${({
   $checked,
   $disabled,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-components",
-  "version": "0.0.55",
+  "version": "0.0.57",
   "repository": "https://github.com/Trackunit/manager",
   "license": "MIT",
   "dependencies": {