@atlaskit/checkbox 13.0.0 → 13.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/checkbox
 
+## 13.0.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 13.0.0
 
 ### Major Changes

package/dist/cjs/checkbox.js

@@ -161,7 +161,7 @@ var Checkbox = /*#__PURE__*/(0, _react.memo)( /*#__PURE__*/(0, _react.forwardRef
     analyticsData: analyticsContext,
     componentName: 'checkbox',
     packageName: "@atlaskit/checkbox",
-    packageVersion: "13.0.0"
+    packageVersion: "13.0.1"
   });
   var internalRef = (0, _react.useRef)(null);
   var mergedRefs = (0, _mergeRefs.default)([internalRef, ref]);

package/dist/es2019/checkbox.js

@@ -145,7 +145,7 @@ const Checkbox = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function Checkbox(pr
     analyticsData: analyticsContext,
     componentName: 'checkbox',
     packageName: "@atlaskit/checkbox",
-    packageVersion: "13.0.0"
+    packageVersion: "13.0.1"
   });
   const internalRef = useRef(null);
   const mergedRefs = mergeRefs([internalRef, ref]);

package/dist/esm/checkbox.js

@@ -154,7 +154,7 @@ var Checkbox = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function Checkbox(prop
     analyticsData: analyticsContext,
     componentName: 'checkbox',
     packageName: "@atlaskit/checkbox",
-    packageVersion: "13.0.0"
+    packageVersion: "13.0.1"
   });
   var internalRef = useRef(null);
   var mergedRefs = mergeRefs([internalRef, ref]);

package/dist/types/types.d.ts

@@ -10,11 +10,11 @@ export type Size = 'small' | 'medium' | 'large' | 'xlarge';
  */
 export type OwnProps = {
     /**
-     * Sets whether the checkbox begins checked.
+     * Sets whether the checkbox begins as checked or unchecked.
      */
     defaultChecked?: boolean;
     /**
-     * id assigned to input
+     * The ID assigned to the input.
      */
     id?: string;
     /**
@@ -22,7 +22,7 @@ export type OwnProps = {
      */
     isChecked?: boolean;
     /**
-     * Sets whether the checkbox is disabled.
+     * Sets whether the checkbox is disabled. Don’t use a disabled checkbox if it needs to remain in the tab order for assistive technologies.
      */
     isDisabled?: boolean;
     /**
@@ -49,7 +49,7 @@ export type OwnProps = {
     name?: string;
     /**
      * Function that is called whenever the state of the checkbox changes. It will
-     * be called with an object containing the react synthetic event. Use currentTarget to get value, name and checked
+     * be called with an object containing the react synthetic event. Use `currentTarget` to get value, name and checked.
      */
     onChange?: (e: React.ChangeEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent) => void;
     /**
@@ -57,7 +57,7 @@ export type OwnProps = {
      */
     value?: number | string;
     /**
-     * The size of the Checkbox
+     * The size of the checkbox.
      */
     size?: Size;
     /**
@@ -67,7 +67,7 @@ export type OwnProps = {
      */
     testId?: string;
     /**
-     * Additional information to be included in the `context` of analytics events that come from radio
+     * Additional information to be included in the `context` of analytics events that come from radio.
      */
     analyticsContext?: Record<string, any>;
 };
@@ -91,12 +91,12 @@ export interface LabelTextProps extends React.HTMLProps<HTMLSpanElement> {
 export interface LabelProps extends React.HTMLProps<HTMLInputElement> {
     isDisabled?: boolean;
     /**
-     * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
+     * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests.
      */
     testId?: string;
     /**
      * Click handler that is conditionally applied for Firefox
-     * as Firefox does not dispatch modified click events (e.g. Ctrl+Click) down to the underlying input element
+     * as Firefox does not dispatch modified click events (e.g. Ctrl+Click) down to the underlying input element.
      */
     onClick?: React.MouseEventHandler;
 }

package/dist/types-ts4.5/types.d.ts

@@ -10,11 +10,11 @@ export type Size = 'small' | 'medium' | 'large' | 'xlarge';
  */
 export type OwnProps = {
     /**
-     * Sets whether the checkbox begins checked.
+     * Sets whether the checkbox begins as checked or unchecked.
      */
     defaultChecked?: boolean;
     /**
-     * id assigned to input
+     * The ID assigned to the input.
      */
     id?: string;
     /**
@@ -22,7 +22,7 @@ export type OwnProps = {
      */
     isChecked?: boolean;
     /**
-     * Sets whether the checkbox is disabled.
+     * Sets whether the checkbox is disabled. Don’t use a disabled checkbox if it needs to remain in the tab order for assistive technologies.
      */
     isDisabled?: boolean;
     /**
@@ -49,7 +49,7 @@ export type OwnProps = {
     name?: string;
     /**
      * Function that is called whenever the state of the checkbox changes. It will
-     * be called with an object containing the react synthetic event. Use currentTarget to get value, name and checked
+     * be called with an object containing the react synthetic event. Use `currentTarget` to get value, name and checked.
      */
     onChange?: (e: React.ChangeEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent) => void;
     /**
@@ -57,7 +57,7 @@ export type OwnProps = {
      */
     value?: number | string;
     /**
-     * The size of the Checkbox
+     * The size of the checkbox.
      */
     size?: Size;
     /**
@@ -67,7 +67,7 @@ export type OwnProps = {
      */
     testId?: string;
     /**
-     * Additional information to be included in the `context` of analytics events that come from radio
+     * Additional information to be included in the `context` of analytics events that come from radio.
      */
     analyticsContext?: Record<string, any>;
 };
@@ -91,12 +91,12 @@ export interface LabelTextProps extends React.HTMLProps<HTMLSpanElement> {
 export interface LabelProps extends React.HTMLProps<HTMLInputElement> {
     isDisabled?: boolean;
     /**
-     * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
+     * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests.
      */
     testId?: string;
     /**
      * Click handler that is conditionally applied for Firefox
-     * as Firefox does not dispatch modified click events (e.g. Ctrl+Click) down to the underlying input element
+     * as Firefox does not dispatch modified click events (e.g. Ctrl+Click) down to the underlying input element.
      */
     onClick?: React.MouseEventHandler;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/checkbox",
-  "version": "13.0.0",
+  "version": "13.0.1",
   "description": "A checkbox is an input control that allows a user to select one or more options from a number of choices.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -39,7 +39,7 @@
   "dependencies": {
     "@atlaskit/analytics-next": "^9.1.0",
     "@atlaskit/ds-lib": "^2.2.0",
-    "@atlaskit/icon": "^21.12.0",
+    "@atlaskit/icon": "^22.0.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",
     "@atlaskit/theme": "^12.6.0",
     "@atlaskit/tokens": "^1.28.0",