@atlaskit/checkbox 12.3.19 → 12.3.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @atlaskit/checkbox
2
2
 
3
+ ## 12.3.20
4
+
5
+ ### Patch Changes
6
+
7
+ - [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
8
+
3
9
  ## 12.3.19
4
10
 
5
11
  ### Patch Changes
@@ -174,7 +174,7 @@ var Checkbox = /*#__PURE__*/(0, _react.memo)( /*#__PURE__*/(0, _react.forwardRef
174
174
  analyticsData: analyticsContext,
175
175
  componentName: 'checkbox',
176
176
  packageName: "@atlaskit/checkbox",
177
- packageVersion: "12.3.19"
177
+ packageVersion: "12.3.20"
178
178
  });
179
179
  var internalRef = (0, _react.useRef)(null);
180
180
  var mergedRefs = (0, _mergeRefs.default)([internalRef, ref]); // Use isChecked from the state if it is controlled
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/checkbox",
3
- "version": "12.3.19",
3
+ "version": "12.3.20",
4
4
  "sideEffects": false
5
5
  }
@@ -148,7 +148,7 @@ const Checkbox = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function Checkbox(pr
148
148
  analyticsData: analyticsContext,
149
149
  componentName: 'checkbox',
150
150
  packageName: "@atlaskit/checkbox",
151
- packageVersion: "12.3.19"
151
+ packageVersion: "12.3.20"
152
152
  });
153
153
  const internalRef = useRef(null);
154
154
  const mergedRefs = mergeRefs([internalRef, ref]); // Use isChecked from the state if it is controlled
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/checkbox",
3
- "version": "12.3.19",
3
+ "version": "12.3.20",
4
4
  "sideEffects": false
5
5
  }
@@ -159,7 +159,7 @@ var Checkbox = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function Checkbox(prop
159
159
  analyticsData: analyticsContext,
160
160
  componentName: 'checkbox',
161
161
  packageName: "@atlaskit/checkbox",
162
- packageVersion: "12.3.19"
162
+ packageVersion: "12.3.20"
163
163
  });
164
164
  var internalRef = useRef(null);
165
165
  var mergedRefs = mergeRefs([internalRef, ref]); // Use isChecked from the state if it is controlled
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/checkbox",
3
- "version": "12.3.19",
3
+ "version": "12.3.20",
4
4
  "sideEffects": false
5
5
  }
@@ -0,0 +1,12 @@
1
+ /// <reference types="react" />
2
+ /**
3
+ * __Checkbox__
4
+ *
5
+ * A checkbox an input control that allows a user to select one or more options from a number of choices.
6
+ *
7
+ * - [Examples](https://atlassian.design/components/checkbox/examples)
8
+ * - [Code](https://atlassian.design/components/checkbox/code)
9
+ * - [Usage](https://atlassian.design/components/checkbox/usage)
10
+ */
11
+ 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>>>;
12
+ export default Checkbox;
@@ -0,0 +1,2 @@
1
+ export { default, default as Checkbox } from './checkbox';
2
+ export type { CheckboxProps } from './types';
@@ -0,0 +1,16 @@
1
+ /// <reference types="react" />
2
+ import type { Size } from '../types';
3
+ /**
4
+ * __Checkbox icon__
5
+ *
6
+ * A checkbox icon is the visual representation of checkbox state,
7
+ * which is shown instead of the native input.
8
+ *
9
+ * @internal
10
+ */
11
+ declare const CheckboxIcon: import("react").NamedExoticComponent<{
12
+ size: Size;
13
+ isIndeterminate: boolean;
14
+ isChecked: boolean;
15
+ }>;
16
+ export default CheckboxIcon;
@@ -0,0 +1,2 @@
1
+ export declare const fontFamily: string;
2
+ export declare const gridSize: number;
@@ -0,0 +1,4 @@
1
+ export { default as CheckboxIcon } from './checkbox-icon';
2
+ export { default as Label } from './label';
3
+ export { default as LabelText } from './label-text';
4
+ export { default as RequiredIndicator } from './required-indicator';
@@ -0,0 +1,3 @@
1
+ /// <reference types="react" />
2
+ import { LabelTextProps } from '../types';
3
+ export default function LabelText({ children }: LabelTextProps): JSX.Element;
@@ -0,0 +1,3 @@
1
+ /// <reference types="react" />
2
+ import { LabelProps } from '../types';
3
+ export default function Label({ children, isDisabled, testId, onClick, id, }: LabelProps): JSX.Element;
@@ -0,0 +1,2 @@
1
+ /// <reference types="react" />
2
+ export default function RequiredIndicator(): JSX.Element;
@@ -0,0 +1,55 @@
1
+ declare const theme: {
2
+ light: {
3
+ borderColor: {
4
+ rest: "var(--ds-border-input)";
5
+ hovered: "var(--ds-border-input)";
6
+ disabled: "var(--ds-background-disabled)";
7
+ checked: "var(--ds-background-selected-bold)";
8
+ active: "var(--ds-border)";
9
+ invalid: "var(--ds-border-danger)";
10
+ invalidAndChecked: "var(--ds-border-danger)";
11
+ focused: "var(--ds-border-focused)";
12
+ hoveredAndChecked: "var(--ds-background-selected-bold-hovered)";
13
+ };
14
+ boxColor: {
15
+ rest: "var(--ds-background-input)";
16
+ hovered: "var(--ds-background-input-hovered)";
17
+ disabled: "var(--ds-background-disabled)";
18
+ active: "var(--ds-background-input-pressed)";
19
+ hoveredAndChecked: "var(--ds-background-selected-bold-hovered)";
20
+ checked: "var(--ds-background-selected-bold)";
21
+ };
22
+ tickColor: {
23
+ disabledAndChecked: "var(--ds-icon-disabled)";
24
+ activeAndChecked: "var(--ds-icon-inverse)";
25
+ checked: "var(--ds-icon-inverse)";
26
+ };
27
+ };
28
+ dark: {
29
+ borderColor: {
30
+ rest: "var(--ds-border-input)";
31
+ hovered: "var(--ds-border-input)";
32
+ disabled: "var(--ds-background-disabled)";
33
+ checked: "var(--ds-background-selected-bold)";
34
+ active: "var(--ds-border)";
35
+ invalid: "var(--ds-border-danger)";
36
+ invalidAndChecked: "var(--ds-border-danger)";
37
+ focused: "var(--ds-border-focused)";
38
+ hoveredAndChecked: "var(--ds-background-selected-bold-hovered)";
39
+ };
40
+ boxColor: {
41
+ rest: "var(--ds-background-input)";
42
+ hovered: "var(--ds-background-input-hovered)";
43
+ disabled: "var(--ds-background-disabled)";
44
+ active: "var(--ds-background-input-pressed)";
45
+ hoveredAndChecked: "var(--ds-background-selected-bold-hovered)";
46
+ checked: "var(--ds-background-selected-bold)";
47
+ };
48
+ tickColor: {
49
+ disabledAndChecked: "var(--ds-icon-disabled)";
50
+ activeAndChecked: "var(--ds-icon-inverse)";
51
+ checked: "var(--ds-icon-inverse)";
52
+ };
53
+ };
54
+ };
55
+ export default theme;
@@ -0,0 +1,103 @@
1
+ import React from 'react';
2
+ import type UIAnalyticsEvent from '@atlaskit/analytics-next/UIAnalyticsEvent';
3
+ export declare type Size = 'small' | 'medium' | 'large' | 'xlarge';
4
+ /**
5
+ *
6
+ *
7
+ * CHECKBOX PROPTYPES
8
+ *
9
+ *
10
+ */
11
+ export declare type OwnProps = {
12
+ /**
13
+ * Sets whether the checkbox begins checked.
14
+ */
15
+ defaultChecked?: boolean;
16
+ /**
17
+ * id assigned to input
18
+ */
19
+ id?: string;
20
+ /**
21
+ * Sets whether the checkbox is checked or unchecked.
22
+ */
23
+ isChecked?: boolean;
24
+ /**
25
+ * Sets whether the checkbox is disabled.
26
+ */
27
+ isDisabled?: boolean;
28
+ /**
29
+ * Sets whether the checkbox is indeterminate. This only affects the
30
+ * style and does not modify the isChecked property.
31
+ */
32
+ isIndeterminate?: boolean;
33
+ /**
34
+ * Marks the field as invalid. Changes style of unchecked component.
35
+ */
36
+ isInvalid?: boolean;
37
+ /**
38
+ * Marks the field as required & changes the label style.
39
+ */
40
+ isRequired?: boolean;
41
+ /**
42
+ * The label to be displayed to the right of the checkbox. The label is part
43
+ * of the clickable element to select the checkbox.
44
+ */
45
+ label?: React.ReactChild;
46
+ /**
47
+ * The name of the submitted field in a checkbox.
48
+ */
49
+ name?: string;
50
+ /**
51
+ * Function that is called whenever the state of the checkbox changes. It will
52
+ * be called with an object containing the react synthetic event. Use currentTarget to get value, name and checked
53
+ */
54
+ onChange?: (e: React.ChangeEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent) => void;
55
+ /**
56
+ * The value to be used in the checkbox input. This is the value that will be returned on form submission.
57
+ */
58
+ value?: number | string;
59
+ /**
60
+ * The size of the Checkbox
61
+ */
62
+ size?: Size;
63
+ /**
64
+ * 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
65
+ * we have generated testid based on the one you pass to the Checkbox component:
66
+ * - `{testId}--hidden-checkbox` to check if it got changed to checked/unchecked.
67
+ */
68
+ testId?: string;
69
+ /**
70
+ * Additional information to be included in the `context` of analytics events that come from radio
71
+ */
72
+ analyticsContext?: Record<string, any>;
73
+ };
74
+ declare type Combine<First, Second> = Omit<First, keyof Second> & Second;
75
+ export declare type CheckboxProps = Combine<Omit<React.InputHTMLAttributes<HTMLInputElement>,
76
+ /**
77
+ * 'disabled', 'required', and 'checked' are omitted so that
78
+ * consumers must handle state using our props.
79
+ *
80
+ * 'css' is added globally to element attributes by emotion.
81
+ * This was causing a bug, making the css prop required in
82
+ * some cases. We explicitly omit it to avoid that.
83
+ *
84
+ * Because 'className' (which the css prop uses internally)
85
+ * is still available, this should not break existing usage.
86
+ */
87
+ 'disabled' | 'required' | 'checked' | 'css'>, OwnProps>;
88
+ export interface LabelTextProps extends React.HTMLProps<HTMLSpanElement> {
89
+ children: React.ReactNode;
90
+ }
91
+ export interface LabelProps extends React.HTMLProps<HTMLInputElement> {
92
+ isDisabled?: boolean;
93
+ /**
94
+ * 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
95
+ */
96
+ testId?: string;
97
+ /**
98
+ * Click handler that is conditionally applied for Firefox
99
+ * as Firefox does not dispatch modified click events (e.g. Ctrl+Click) down to the underlying input element
100
+ */
101
+ onClick?: React.MouseEventHandler;
102
+ }
103
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/checkbox",
3
- "version": "12.3.19",
3
+ "version": "12.3.20",
4
4
  "description": "A checkbox is an input control that allows a user to select one or more options from a number of choices.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
12
12
  "module": "dist/esm/index.js",
13
13
  "module:es2019": "dist/es2019/index.js",
14
14
  "types": "dist/types/index.d.ts",
15
+ "typesVersions": {
16
+ ">=4.0 <4.5": {
17
+ "*": [
18
+ "dist/types-ts4.0/*"
19
+ ]
20
+ }
21
+ },
15
22
  "sideEffects": false,
16
23
  "atlaskit:src": "src/index.tsx",
17
24
  "atlassian": {
@@ -29,7 +36,7 @@
29
36
  "@atlaskit/analytics-next": "^8.2.0",
30
37
  "@atlaskit/ds-lib": "^2.1.0",
31
38
  "@atlaskit/icon": "^21.10.0",
32
- "@atlaskit/theme": "^12.1.0",
39
+ "@atlaskit/theme": "^12.2.0",
33
40
  "@atlaskit/tokens": "^0.10.0",
34
41
  "@babel/runtime": "^7.0.0",
35
42
  "@emotion/core": "^10.0.9"
@@ -41,17 +48,17 @@
41
48
  "@atlaskit/button": "^16.3.0",
42
49
  "@atlaskit/docs": "*",
43
50
  "@atlaskit/form": "^8.5.0",
44
- "@atlaskit/section-message": "^6.1.0",
51
+ "@atlaskit/section-message": "^6.2.0",
45
52
  "@atlaskit/ssr": "*",
46
- "@atlaskit/toggle": "^12.4.0",
53
+ "@atlaskit/toggle": "^12.5.0",
47
54
  "@atlaskit/visual-regression": "*",
48
55
  "@atlaskit/webdriver-runner": "*",
49
56
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
50
- "@testing-library/react": "^8.0.1",
57
+ "@testing-library/react": "^12.1.5",
51
58
  "jscodeshift": "^0.13.0",
52
59
  "react-dom": "^16.8.0",
53
60
  "storybook-addon-performance": "^0.16.0",
54
- "typescript": "4.3.5",
61
+ "typescript": "4.5.5",
55
62
  "wait-for-expect": "^1.2.0"
56
63
  },
57
64
  "keywords": [