@atlaskit/checkbox 12.5.0 → 12.6.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/checkbox
 
+## 12.6.0
+
+### Minor Changes
+
+- [`8d0fd2d3f6c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8d0fd2d3f6c) - [ux] reduce stroke width from 2px to 1px with new color to meet contrast requirement
+
 ## 12.5.0
 
 ### Minor Changes

package/dist/cjs/checkbox.js

@@ -12,6 +12,7 @@ var _react = require("react");
 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 _internal = require("./internal");
 var _excluded = ["isChecked", "isDisabled", "isInvalid", "defaultChecked", "isIndeterminate", "size", "onChange", "analyticsContext", "label", "name", "value", "isRequired", "testId"];
 /**  @jsx jsx */
@@ -42,7 +43,7 @@ var checkboxStyles = (0, _react2.css)({
     transition: 'color 0.2s ease-in-out, fill 0.2s ease-in-out',
     'rect:first-of-type': {
       stroke: 'var(--checkbox-border-color)',
-      strokeWidth: 2,
+      strokeWidth: (0, _platformFeatureFlags.getBooleanFF)('platform.design-system-team.update-border-input_ff9l1') ? 1 : 2,
       transition: 'stroke 0.2s ease-in-out'
     }
   },
@@ -160,7 +161,7 @@ var Checkbox = /*#__PURE__*/(0, _react.memo)( /*#__PURE__*/(0, _react.forwardRef
     analyticsData: analyticsContext,
     componentName: 'checkbox',
     packageName: "@atlaskit/checkbox",
-    packageVersion: "12.5.0"
+    packageVersion: "12.6.0"
   });
   var internalRef = (0, _react.useRef)(null);
   var mergedRefs = (0, _mergeRefs.default)([internalRef, ref]);

package/dist/cjs/internal/theme.js

@@ -4,12 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _colors = require("@atlaskit/theme/colors");
 var theme = {
   light: {
     borderColor: {
-      rest: "var(--ds-border-input, ".concat(_colors.N40, ")"),
-      hovered: "var(--ds-border-input, ".concat(_colors.N40, ")"),
+      rest: "var(--ds-border-input, ".concat((0, _platformFeatureFlags.getBooleanFF)('platform.design-system-team.update-border-input_ff9l1') ? _colors.N100 : _colors.N40, ")"),
+      hovered: "var(--ds-border-input, ".concat((0, _platformFeatureFlags.getBooleanFF)('platform.design-system-team.update-border-input_ff9l1') ? _colors.N100 : _colors.N40, ")"),
       disabled: "var(--ds-background-disabled, ".concat(_colors.N20, ")"),
       checked: "var(--ds-background-selected-bold, ".concat(_colors.B400, ")"),
       active: "var(--ds-border, ".concat(_colors.B50, ")"),
@@ -34,7 +35,7 @@ var theme = {
   },
   dark: {
     borderColor: {
-      rest: "var(--ds-border-input, ".concat(_colors.DN80, ")"),
+      rest: "var(--ds-border-input, ".concat((0, _platformFeatureFlags.getBooleanFF)('platform.design-system-team.update-border-input_ff9l1') ? _colors.DN200 : _colors.DN80, ")"),
       hovered: "var(--ds-border-input, ".concat(_colors.DN200, ")"),
       disabled: "var(--ds-background-disabled, ".concat(_colors.DN10, ")"),
       checked: "var(--ds-background-selected-bold, ".concat(_colors.B400, ")"),

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/checkbox",
-	"version": "12.5.0",
+	"version": "12.6.0",
 	"sideEffects": false
 }

package/dist/es2019/checkbox.js

@@ -4,6 +4,7 @@ import { forwardRef, memo, useCallback, useRef, useState } from 'react';
 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 { CheckboxIcon, Label, LabelText, RequiredIndicator } from './internal';
 /* eslint-disable @repo/internal/styles/no-nested-styles */
 const checkboxStyles = css({
@@ -32,7 +33,7 @@ const checkboxStyles = css({
     transition: 'color 0.2s ease-in-out, fill 0.2s ease-in-out',
     'rect:first-of-type': {
       stroke: 'var(--checkbox-border-color)',
-      strokeWidth: 2,
+      strokeWidth: getBooleanFF('platform.design-system-team.update-border-input_ff9l1') ? 1 : 2,
       transition: 'stroke 0.2s ease-in-out'
     }
   },
@@ -144,7 +145,7 @@ const Checkbox = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function Checkbox(pr
     analyticsData: analyticsContext,
     componentName: 'checkbox',
     packageName: "@atlaskit/checkbox",
-    packageVersion: "12.5.0"
+    packageVersion: "12.6.0"
   });
   const internalRef = useRef(null);
   const mergedRefs = mergeRefs([internalRef, ref]);

package/dist/es2019/internal/theme.js

@@ -1,9 +1,10 @@
-import { B100, B200, B300, B400, B50, B75, DN10, DN200, DN30, DN80, DN90, N10, N20, N30, N40, N70, R300 } from '@atlaskit/theme/colors';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { B100, B200, B300, B400, B50, B75, DN10, DN200, DN30, DN80, DN90, N10, N100, N20, N30, N40, N70, R300 } from '@atlaskit/theme/colors';
 const theme = {
   light: {
     borderColor: {
-      rest: `var(--ds-border-input, ${N40})`,
-      hovered: `var(--ds-border-input, ${N40})`,
+      rest: `var(--ds-border-input, ${getBooleanFF('platform.design-system-team.update-border-input_ff9l1') ? N100 : N40})`,
+      hovered: `var(--ds-border-input, ${getBooleanFF('platform.design-system-team.update-border-input_ff9l1') ? N100 : N40})`,
       disabled: `var(--ds-background-disabled, ${N20})`,
       checked: `var(--ds-background-selected-bold, ${B400})`,
       active: `var(--ds-border, ${B50})`,
@@ -28,7 +29,7 @@ const theme = {
   },
   dark: {
     borderColor: {
-      rest: `var(--ds-border-input, ${DN80})`,
+      rest: `var(--ds-border-input, ${getBooleanFF('platform.design-system-team.update-border-input_ff9l1') ? DN200 : DN80})`,
       hovered: `var(--ds-border-input, ${DN200})`,
       disabled: `var(--ds-background-disabled, ${DN10})`,
       checked: `var(--ds-background-selected-bold, ${B400})`,

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/checkbox",
-	"version": "12.5.0",
+	"version": "12.6.0",
 	"sideEffects": false
 }

package/dist/esm/checkbox.js

@@ -7,6 +7,7 @@ import { forwardRef, memo, useCallback, useRef, useState } from 'react';
 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 { CheckboxIcon, Label, LabelText, RequiredIndicator } from './internal';
 /* eslint-disable @repo/internal/styles/no-nested-styles */
 var checkboxStyles = css({
@@ -35,7 +36,7 @@ var checkboxStyles = css({
     transition: 'color 0.2s ease-in-out, fill 0.2s ease-in-out',
     'rect:first-of-type': {
       stroke: 'var(--checkbox-border-color)',
-      strokeWidth: 2,
+      strokeWidth: getBooleanFF('platform.design-system-team.update-border-input_ff9l1') ? 1 : 2,
       transition: 'stroke 0.2s ease-in-out'
     }
   },
@@ -153,7 +154,7 @@ var Checkbox = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function Checkbox(prop
     analyticsData: analyticsContext,
     componentName: 'checkbox',
     packageName: "@atlaskit/checkbox",
-    packageVersion: "12.5.0"
+    packageVersion: "12.6.0"
   });
   var internalRef = useRef(null);
   var mergedRefs = mergeRefs([internalRef, ref]);

package/dist/esm/internal/theme.js

@@ -1,9 +1,10 @@
-import { B100, B200, B300, B400, B50, B75, DN10, DN200, DN30, DN80, DN90, N10, N20, N30, N40, N70, R300 } from '@atlaskit/theme/colors';
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { B100, B200, B300, B400, B50, B75, DN10, DN200, DN30, DN80, DN90, N10, N100, N20, N30, N40, N70, R300 } from '@atlaskit/theme/colors';
 var theme = {
   light: {
     borderColor: {
-      rest: "var(--ds-border-input, ".concat(N40, ")"),
-      hovered: "var(--ds-border-input, ".concat(N40, ")"),
+      rest: "var(--ds-border-input, ".concat(getBooleanFF('platform.design-system-team.update-border-input_ff9l1') ? N100 : N40, ")"),
+      hovered: "var(--ds-border-input, ".concat(getBooleanFF('platform.design-system-team.update-border-input_ff9l1') ? N100 : N40, ")"),
       disabled: "var(--ds-background-disabled, ".concat(N20, ")"),
       checked: "var(--ds-background-selected-bold, ".concat(B400, ")"),
       active: "var(--ds-border, ".concat(B50, ")"),
@@ -28,7 +29,7 @@ var theme = {
   },
   dark: {
     borderColor: {
-      rest: "var(--ds-border-input, ".concat(DN80, ")"),
+      rest: "var(--ds-border-input, ".concat(getBooleanFF('platform.design-system-team.update-border-input_ff9l1') ? DN200 : DN80, ")"),
       hovered: "var(--ds-border-input, ".concat(DN200, ")"),
       disabled: "var(--ds-background-disabled, ".concat(DN10, ")"),
       checked: "var(--ds-background-selected-bold, ".concat(B400, ")"),

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/checkbox",
-	"version": "12.5.0",
+	"version": "12.6.0",
 	"sideEffects": false
 }

package/dist/types-ts4.0/checkbox.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+/**
+ * __Checkbox__
+ *
+ * A checkbox an input control that allows a user to select one or more options from a number of choices.
+ *
+ * - [Examples](https://atlassian.design/components/checkbox/examples)
+ * - [Code](https://atlassian.design/components/checkbox/code)
+ * - [Usage](https://atlassian.design/components/checkbox/usage)
+ */
+declare const Checkbox: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Omit<Omit<import("react").InputHTMLAttributes<HTMLInputElement>, "disabled" | "required" | "checked" | "css">, keyof import("./types").OwnProps> & import("./types").OwnProps & import("react").RefAttributes<HTMLInputElement>>>;
+export default Checkbox;

package/dist/types-ts4.0/index.d.ts

@@ -0,0 +1,2 @@
+export { default, default as Checkbox } from './checkbox';
+export type { CheckboxProps } from './types';

package/dist/types-ts4.0/internal/checkbox-icon.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import type { Size } from '../types';
+/**
+ * __Checkbox icon__
+ *
+ * A checkbox icon is the visual representation of checkbox state,
+ * which is shown instead of the native input.
+ *
+ * @internal
+ */
+declare const CheckboxIcon: import("react").NamedExoticComponent<{
+    size: Size;
+    isIndeterminate: boolean;
+    isChecked: boolean;
+}>;
+export default CheckboxIcon;

package/dist/types-ts4.0/internal/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const fontFamily: string;
+export declare const gridSize: number;

package/dist/types-ts4.0/internal/index.d.ts

@@ -0,0 +1,4 @@
+export { default as CheckboxIcon } from './checkbox-icon';
+export { default as Label } from './label';
+export { default as LabelText } from './label-text';
+export { default as RequiredIndicator } from './required-indicator';

package/dist/types-ts4.0/internal/label-text.d.ts

@@ -0,0 +1,4 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import { LabelTextProps } from '../types';
+export default function LabelText({ children }: LabelTextProps): jsx.JSX.Element;

package/dist/types-ts4.0/internal/label.d.ts

@@ -0,0 +1,4 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import { LabelProps } from '../types';
+export default function Label({ children, isDisabled, testId, onClick, label, id, }: LabelProps): jsx.JSX.Element;

package/dist/types-ts4.0/internal/required-indicator.d.ts

@@ -0,0 +1,3 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+export default function RequiredIndicator(): jsx.JSX.Element;

package/dist/types-ts4.0/internal/theme.d.ts

@@ -0,0 +1,55 @@
+declare const theme: {
+    light: {
+        borderColor: {
+            rest: "var(--ds-border-input)";
+            hovered: "var(--ds-border-input)";
+            disabled: "var(--ds-background-disabled)";
+            checked: "var(--ds-background-selected-bold)";
+            active: "var(--ds-border)";
+            invalid: "var(--ds-border-danger)";
+            invalidAndChecked: "var(--ds-border-danger)";
+            focused: "var(--ds-border-focused)";
+            hoveredAndChecked: "var(--ds-background-selected-bold-hovered)";
+        };
+        boxColor: {
+            rest: "var(--ds-background-input)";
+            hovered: "var(--ds-background-input-hovered)";
+            disabled: "var(--ds-background-disabled)";
+            active: "var(--ds-background-input-pressed)";
+            hoveredAndChecked: "var(--ds-background-selected-bold-hovered)";
+            checked: "var(--ds-background-selected-bold)";
+        };
+        tickColor: {
+            disabledAndChecked: "var(--ds-icon-disabled)";
+            activeAndChecked: "var(--ds-icon-inverse)";
+            checked: "var(--ds-icon-inverse)";
+        };
+    };
+    dark: {
+        borderColor: {
+            rest: "var(--ds-border-input)";
+            hovered: "var(--ds-border-input)";
+            disabled: "var(--ds-background-disabled)";
+            checked: "var(--ds-background-selected-bold)";
+            active: "var(--ds-border)";
+            invalid: "var(--ds-border-danger)";
+            invalidAndChecked: "var(--ds-border-danger)";
+            focused: "var(--ds-border-focused)";
+            hoveredAndChecked: "var(--ds-background-selected-bold-hovered)";
+        };
+        boxColor: {
+            rest: "var(--ds-background-input)";
+            hovered: "var(--ds-background-input-hovered)";
+            disabled: "var(--ds-background-disabled)";
+            active: "var(--ds-background-input-pressed)";
+            hoveredAndChecked: "var(--ds-background-selected-bold-hovered)";
+            checked: "var(--ds-background-selected-bold)";
+        };
+        tickColor: {
+            disabledAndChecked: "var(--ds-icon-disabled)";
+            activeAndChecked: "var(--ds-icon-inverse)";
+            checked: "var(--ds-icon-inverse)";
+        };
+    };
+};
+export default theme;

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

@@ -0,0 +1,103 @@
+import React from 'react';
+import type UIAnalyticsEvent from '@atlaskit/analytics-next/UIAnalyticsEvent';
+export declare type Size = 'small' | 'medium' | 'large' | 'xlarge';
+/**
+ *
+ *
+ * CHECKBOX PROPTYPES
+ *
+ *
+ */
+export declare type OwnProps = {
+    /**
+     * Sets whether the checkbox begins checked.
+     */
+    defaultChecked?: boolean;
+    /**
+     * id assigned to input
+     */
+    id?: string;
+    /**
+     * Sets whether the checkbox is checked or unchecked.
+     */
+    isChecked?: boolean;
+    /**
+     * Sets whether the checkbox is disabled.
+     */
+    isDisabled?: boolean;
+    /**
+     * Sets whether the checkbox is indeterminate. This only affects the
+     * style and does not modify the isChecked property.
+     */
+    isIndeterminate?: boolean;
+    /**
+     * Marks the field as invalid. Changes style of unchecked component.
+     */
+    isInvalid?: boolean;
+    /**
+     * Marks the field as required & changes the label style.
+     */
+    isRequired?: boolean;
+    /**
+     * The label to be displayed to the right of the checkbox. The label is part
+     * of the clickable element to select the checkbox.
+     */
+    label?: React.ReactChild;
+    /**
+     * The name of the submitted field in a checkbox.
+     */
+    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
+     */
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent) => void;
+    /**
+     * The value to be used in the checkbox input. This is the value that will be returned on form submission.
+     */
+    value?: number | string;
+    /**
+     * The size of the Checkbox
+     */
+    size?: Size;
+    /**
+     * 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
+     * we have generated testid based on the one you pass to the Checkbox component:
+     * - `{testId}--hidden-checkbox` to check if it got changed to checked/unchecked.
+     */
+    testId?: string;
+    /**
+     * Additional information to be included in the `context` of analytics events that come from radio
+     */
+    analyticsContext?: Record<string, any>;
+};
+declare type Combine<First, Second> = Omit<First, keyof Second> & Second;
+export declare type CheckboxProps = Combine<Omit<React.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.
+ */
+'disabled' | 'required' | 'checked' | 'css'>, OwnProps>;
+export interface LabelTextProps extends React.HTMLProps<HTMLSpanElement> {
+    children: React.ReactNode;
+}
+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
+     */
+    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
+     */
+    onClick?: React.MouseEventHandler;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/checkbox",
-  "version": "12.5.0",
+  "version": "12.6.0",
   "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/"
@@ -29,6 +29,7 @@
     "@atlaskit/analytics-next": "^9.1.0",
     "@atlaskit/ds-lib": "^2.2.0",
     "@atlaskit/icon": "^21.12.0",
+    "@atlaskit/platform-feature-flags": "^0.2.0",
     "@atlaskit/theme": "^12.5.0",
     "@atlaskit/tokens": "^1.3.0",
     "@babel/runtime": "^7.0.0",
@@ -47,6 +48,7 @@
     "@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",
     "jscodeshift": "^0.13.0",
     "react-dom": "^16.8.0",
@@ -79,6 +81,11 @@
       ]
     }
   },
+  "platform-feature-flags": {
+    "platform.design-system-team.update-border-input_ff9l1": {
+      "type": "boolean"
+    }
+  },
   "homepage": "https://atlassian.design/components/checkbox/",
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
 }