@atlaskit/checkbox 13.0.0 → 13.0.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/checkbox
 
+## 13.0.2
+
+### Patch Changes
+
+- [#78598](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/78598) [`cabae83473c3`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/cabae83473c3) - [ux] Focus styles for Checkbox and Radio components
+
+## 13.0.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 13.0.0
 
 ### Major Changes

package/dist/cjs/checkbox.js

@@ -13,6 +13,7 @@ var _react2 = require("@emotion/react");
 var _usePlatformLeafEventHandler = require("@atlaskit/analytics-next/usePlatformLeafEventHandler");
 var _mergeRefs = _interopRequireDefault(require("@atlaskit/ds-lib/merge-refs"));
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _colors = require("@atlaskit/theme/colors");
 var _internal = require("./internal");
 var _excluded = ["isChecked", "isDisabled", "isInvalid", "defaultChecked", "isIndeterminate", "size", "onChange", "analyticsContext", "label", "name", "value", "isRequired", "testId"];
 /**  @jsx jsx */
@@ -26,6 +27,9 @@ var checkboxStyles = (0, _react2.css)({
   gridArea: '1 / 1 / 2 / 2',
   opacity: 0,
   outline: 'none',
+  '&:focus': {
+    opacity: 1
+  },
   '& + svg': {
     /**
      *  Change the variables --checkbox-background-color, --checkbox-border-color
@@ -48,7 +52,9 @@ var checkboxStyles = (0, _react2.css)({
     }
   },
   '&&:focus + svg, &&:checked:focus + svg': {
-    '--checkbox-border-color': 'var(--local-border-focus)'
+    borderRadius: "var(--ds-border-radius, 0.25rem)",
+    outline: "var(--ds-border-width-outline, 2px)".concat(" solid ", "var(--ds-border-focused, ".concat(_colors.B200, ")")),
+    outlineOffset: '-2px'
   },
   '&:hover + svg': {
     '--checkbox-background-color': 'var(--local-background-hover)',
@@ -161,7 +167,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.2"
   });
   var internalRef = (0, _react.useRef)(null);
   var mergedRefs = (0, _mergeRefs.default)([internalRef, ref]);
@@ -173,7 +179,10 @@ var Checkbox = /*#__PURE__*/(0, _react.memo)( /*#__PURE__*/(0, _react.forwardRef
     label: label,
     id: rest.id ? "".concat(rest.id, "-label") : undefined,
     testId: testId && "".concat(testId, "--checkbox-label")
-  }, (0, _react2.jsx)("input", (0, _extends2.default)({}, rest, {
+  }, (0, _react2.jsx)("input", (0, _extends2.default)({
+    // It is necessary only for Safari. It allows to render focus styles.
+    tabIndex: 0
+  }, rest, {
     type: "checkbox",
     ref: mergedRefs,
     disabled: isDisabled,

package/dist/es2019/checkbox.js

@@ -5,6 +5,7 @@ import { css, jsx } from '@emotion/react';
 import { usePlatformLeafEventHandler } from '@atlaskit/analytics-next/usePlatformLeafEventHandler';
 import mergeRefs from '@atlaskit/ds-lib/merge-refs';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { B200 } from '@atlaskit/theme/colors';
 import { CheckboxIcon, Label, LabelText, RequiredIndicator } from './internal';
 /* eslint-disable @atlaskit/design-system/no-nested-styles */
 const checkboxStyles = css({
@@ -16,6 +17,9 @@ const checkboxStyles = css({
   gridArea: '1 / 1 / 2 / 2',
   opacity: 0,
   outline: 'none',
+  '&:focus': {
+    opacity: 1
+  },
   '& + svg': {
     /**
      *  Change the variables --checkbox-background-color, --checkbox-border-color
@@ -38,7 +42,9 @@ const checkboxStyles = css({
     }
   },
   '&&:focus + svg, &&:checked:focus + svg': {
-    '--checkbox-border-color': 'var(--local-border-focus)'
+    borderRadius: "var(--ds-border-radius, 0.25rem)",
+    outline: `${"var(--ds-border-width-outline, 2px)"} solid ${`var(--ds-border-focused, ${B200})`}`,
+    outlineOffset: '-2px'
   },
   '&:hover + svg': {
     '--checkbox-background-color': 'var(--local-background-hover)',
@@ -145,7 +151,7 @@ const Checkbox = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function Checkbox(pr
     analyticsData: analyticsContext,
     componentName: 'checkbox',
     packageName: "@atlaskit/checkbox",
-    packageVersion: "13.0.0"
+    packageVersion: "13.0.2"
   });
   const internalRef = useRef(null);
   const mergedRefs = mergeRefs([internalRef, ref]);
@@ -157,7 +163,10 @@ const Checkbox = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function Checkbox(pr
     label: label,
     id: rest.id ? `${rest.id}-label` : undefined,
     testId: testId && `${testId}--checkbox-label`
-  }, jsx("input", _extends({}, rest, {
+  }, jsx("input", _extends({
+    // It is necessary only for Safari. It allows to render focus styles.
+    tabIndex: 0
+  }, rest, {
     type: "checkbox",
     ref: mergedRefs,
     disabled: isDisabled,

package/dist/esm/checkbox.js

@@ -8,6 +8,7 @@ import { css, jsx } from '@emotion/react';
 import { usePlatformLeafEventHandler } from '@atlaskit/analytics-next/usePlatformLeafEventHandler';
 import mergeRefs from '@atlaskit/ds-lib/merge-refs';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { B200 } from '@atlaskit/theme/colors';
 import { CheckboxIcon, Label, LabelText, RequiredIndicator } from './internal';
 /* eslint-disable @atlaskit/design-system/no-nested-styles */
 var checkboxStyles = css({
@@ -19,6 +20,9 @@ var checkboxStyles = css({
   gridArea: '1 / 1 / 2 / 2',
   opacity: 0,
   outline: 'none',
+  '&:focus': {
+    opacity: 1
+  },
   '& + svg': {
     /**
      *  Change the variables --checkbox-background-color, --checkbox-border-color
@@ -41,7 +45,9 @@ var checkboxStyles = css({
     }
   },
   '&&:focus + svg, &&:checked:focus + svg': {
-    '--checkbox-border-color': 'var(--local-border-focus)'
+    borderRadius: "var(--ds-border-radius, 0.25rem)",
+    outline: "var(--ds-border-width-outline, 2px)".concat(" solid ", "var(--ds-border-focused, ".concat(B200, ")")),
+    outlineOffset: '-2px'
   },
   '&:hover + svg': {
     '--checkbox-background-color': 'var(--local-background-hover)',
@@ -154,7 +160,7 @@ var Checkbox = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function Checkbox(prop
     analyticsData: analyticsContext,
     componentName: 'checkbox',
     packageName: "@atlaskit/checkbox",
-    packageVersion: "13.0.0"
+    packageVersion: "13.0.2"
   });
   var internalRef = useRef(null);
   var mergedRefs = mergeRefs([internalRef, ref]);
@@ -166,7 +172,10 @@ var Checkbox = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function Checkbox(prop
     label: label,
     id: rest.id ? "".concat(rest.id, "-label") : undefined,
     testId: testId && "".concat(testId, "--checkbox-label")
-  }, jsx("input", _extends({}, rest, {
+  }, jsx("input", _extends({
+    // It is necessary only for Safari. It allows to render focus styles.
+    tabIndex: 0
+  }, rest, {
     type: "checkbox",
     ref: mergedRefs,
     disabled: isDisabled,

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.2",
   "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/"
@@ -37,12 +37,12 @@
     ".": "./src/index.tsx"
   },
   "dependencies": {
-    "@atlaskit/analytics-next": "^9.1.0",
+    "@atlaskit/analytics-next": "^9.2.0",
     "@atlaskit/ds-lib": "^2.2.0",
-    "@atlaskit/icon": "^21.12.0",
+    "@atlaskit/icon": "^22.1.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.28.0",
+    "@atlaskit/tokens": "^1.39.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
   },
@@ -51,10 +51,10 @@
   },
   "devDependencies": {
     "@af/accessibility-testing": "*",
+    "@af/integration-testing": "*",
     "@af/visual-regression": "*",
     "@atlaskit/ssr": "*",
     "@atlaskit/visual-regression": "*",
-    "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@atlassian/feature-flags-test-utils": "*",
     "@testing-library/react": "^12.1.5",
@@ -96,4 +96,4 @@
   },
   "homepage": "https://atlassian.design/components/checkbox/",
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
-}
+}

package/tmp/api-report-tmp.d.ts

@@ -1,62 +0,0 @@
-## API Report File for "@atlaskit/checkbox"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-/// <reference types="react" />
-
-import { ForwardRefExoticComponent } from 'react';
-import { InputHTMLAttributes } from 'react';
-import { MemoExoticComponent } from 'react';
-import { default as React_2 } from 'react';
-import { RefAttributes } from 'react';
-import type UIAnalyticsEvent from '@atlaskit/analytics-next/UIAnalyticsEvent';
-
-// @public
-const Checkbox: MemoExoticComponent<ForwardRefExoticComponent<Omit<Omit<InputHTMLAttributes<HTMLInputElement>, "checked" | "css" | "disabled" | "required">, keyof OwnProps> & OwnProps & RefAttributes<HTMLInputElement>>>;
-export { Checkbox }
-export default Checkbox;
-
-// @public (undocumented)
-export type CheckboxProps = Combine<Omit<React_2.InputHTMLAttributes<HTMLInputElement>,
-/**
-* 'disabled', 'required', and 'checked' are omitted so that
-* consumers must handle state using our props.
-*
-* 'css' is added globally to element attributes by emotion.
-* This was causing a bug, making the css prop required in
-* some cases. We explicitly omit it to avoid that.
-*
-* Because 'className' (which the css prop uses internally)
-* is still available, this should not break existing usage.
-*/
-'checked' | 'css' | 'disabled' | 'required'>, OwnProps>;
-
-// @public (undocumented)
-type Combine<First, Second> = Omit<First, keyof Second> & Second;
-
-// @public
-type OwnProps = {
-    defaultChecked?: boolean;
-    id?: string;
-    isChecked?: boolean;
-    isDisabled?: boolean;
-    isIndeterminate?: boolean;
-    isInvalid?: boolean;
-    isRequired?: boolean;
-    label?: React_2.ReactChild;
-    name?: string;
-    onChange?: (e: React_2.ChangeEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent) => void;
-    value?: number | string;
-    size?: Size;
-    testId?: string;
-    analyticsContext?: Record<string, any>;
-};
-
-// @public (undocumented)
-type Size = 'large' | 'medium' | 'small' | 'xlarge';
-
-// (No @packageDocumentation comment for this package)
-
-```