@atlaskit/checkbox 12.3.19 → 12.4.0
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 +16 -0
- package/dist/cjs/checkbox.js +7 -7
- package/dist/cjs/internal/checkbox-icon.js +6 -6
- package/dist/cjs/internal/label-text.js +3 -3
- package/dist/cjs/internal/label.js +6 -6
- package/dist/cjs/internal/required-indicator.js +3 -3
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/checkbox.js +2 -2
- package/dist/es2019/internal/checkbox-icon.js +1 -1
- package/dist/es2019/internal/label-text.js +1 -1
- package/dist/es2019/internal/label.js +1 -1
- package/dist/es2019/internal/required-indicator.js +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/checkbox.js +2 -2
- package/dist/esm/internal/checkbox-icon.js +1 -1
- package/dist/esm/internal/label-text.js +1 -1
- package/dist/esm/internal/label.js +1 -1
- package/dist/esm/internal/required-indicator.js +1 -1
- package/dist/esm/version.json +1 -1
- package/dist/types/internal/label-text.d.ts +3 -2
- package/dist/types/internal/label.d.ts +3 -2
- package/dist/types/internal/required-indicator.d.ts +3 -2
- package/dist/types-ts4.0/checkbox.d.ts +12 -0
- package/dist/types-ts4.0/index.d.ts +2 -0
- package/dist/types-ts4.0/internal/checkbox-icon.d.ts +16 -0
- package/dist/types-ts4.0/internal/constants.d.ts +2 -0
- package/dist/types-ts4.0/internal/index.d.ts +4 -0
- package/dist/types-ts4.0/internal/label-text.d.ts +4 -0
- package/dist/types-ts4.0/internal/label.d.ts +4 -0
- package/dist/types-ts4.0/internal/required-indicator.d.ts +3 -0
- package/dist/types-ts4.0/internal/theme.d.ts +55 -0
- package/dist/types-ts4.0/types.d.ts +103 -0
- package/package.json +16 -9
- package/report.api.md +4 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @atlaskit/checkbox
|
|
2
2
|
|
|
3
|
+
## 12.4.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [`0944c0e7eed`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0944c0e7eed) - Updates `@emotion/core` to `@emotion/react`; v10 to v11. There is no expected behavior change.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies
|
|
12
|
+
|
|
13
|
+
## 12.3.20
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
|
|
18
|
+
|
|
3
19
|
## 12.3.19
|
|
4
20
|
|
|
5
21
|
### Patch Changes
|
package/dist/cjs/checkbox.js
CHANGED
|
@@ -15,7 +15,7 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
|
|
|
15
15
|
|
|
16
16
|
var _react = require("react");
|
|
17
17
|
|
|
18
|
-
var
|
|
18
|
+
var _react2 = require("@emotion/react");
|
|
19
19
|
|
|
20
20
|
var _usePlatformLeafEventHandler = require("@atlaskit/analytics-next/usePlatformLeafEventHandler");
|
|
21
21
|
|
|
@@ -26,7 +26,7 @@ var _internal = require("./internal");
|
|
|
26
26
|
var _excluded = ["isChecked", "isDisabled", "isInvalid", "defaultChecked", "isIndeterminate", "size", "onChange", "analyticsContext", "label", "name", "value", "isRequired", "testId"];
|
|
27
27
|
|
|
28
28
|
/* eslint-disable @repo/internal/styles/no-nested-styles */
|
|
29
|
-
var checkboxStyles = (0,
|
|
29
|
+
var checkboxStyles = (0, _react2.css)({
|
|
30
30
|
width: '100%',
|
|
31
31
|
height: '100%',
|
|
32
32
|
margin: 0,
|
|
@@ -174,17 +174,17 @@ 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.
|
|
177
|
+
packageVersion: "12.4.0"
|
|
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
|
|
181
181
|
|
|
182
182
|
var isChecked = isCheckedProp === undefined ? isCheckedState : isCheckedProp;
|
|
183
|
-
return (0,
|
|
183
|
+
return (0, _react2.jsx)(_internal.Label, {
|
|
184
184
|
isDisabled: isDisabled,
|
|
185
185
|
id: rest.id ? "".concat(rest.id, "-label") : undefined,
|
|
186
186
|
testId: testId && "".concat(testId, "--checkbox-label")
|
|
187
|
-
}, (0,
|
|
187
|
+
}, (0, _react2.jsx)("input", (0, _extends2.default)({}, rest, {
|
|
188
188
|
type: "checkbox",
|
|
189
189
|
ref: mergedRefs,
|
|
190
190
|
disabled: isDisabled,
|
|
@@ -198,11 +198,11 @@ var Checkbox = /*#__PURE__*/(0, _react.memo)( /*#__PURE__*/(0, _react.forwardRef
|
|
|
198
198
|
"aria-invalid": isInvalid ? 'true' : undefined,
|
|
199
199
|
"data-testid": testId && "".concat(testId, "--hidden-checkbox"),
|
|
200
200
|
"data-invalid": isInvalid ? 'true' : undefined
|
|
201
|
-
})), (0,
|
|
201
|
+
})), (0, _react2.jsx)(_internal.CheckboxIcon, {
|
|
202
202
|
size: size,
|
|
203
203
|
isIndeterminate: isIndeterminate,
|
|
204
204
|
isChecked: isChecked
|
|
205
|
-
}), label && (0,
|
|
205
|
+
}), label && (0, _react2.jsx)(_internal.LabelText, null, label, isRequired && (0, _react2.jsx)(_internal.RequiredIndicator, null)));
|
|
206
206
|
}));
|
|
207
207
|
Checkbox.displayName = 'Checkbox';
|
|
208
208
|
var _default = Checkbox;
|
|
@@ -9,14 +9,14 @@ exports.default = void 0;
|
|
|
9
9
|
|
|
10
10
|
var _react = require("react");
|
|
11
11
|
|
|
12
|
-
var
|
|
12
|
+
var _react2 = require("@emotion/react");
|
|
13
13
|
|
|
14
14
|
var _svg = _interopRequireDefault(require("@atlaskit/icon/svg"));
|
|
15
15
|
|
|
16
16
|
/** @jsx jsx */
|
|
17
17
|
function getIcon(isIndeterminate, isChecked) {
|
|
18
18
|
if (isIndeterminate) {
|
|
19
|
-
return (0,
|
|
19
|
+
return (0, _react2.jsx)("rect", {
|
|
20
20
|
fill: "inherit",
|
|
21
21
|
x: "8",
|
|
22
22
|
y: "11",
|
|
@@ -27,7 +27,7 @@ function getIcon(isIndeterminate, isChecked) {
|
|
|
27
27
|
}
|
|
28
28
|
|
|
29
29
|
if (isChecked) {
|
|
30
|
-
return (0,
|
|
30
|
+
return (0, _react2.jsx)("path", {
|
|
31
31
|
d: "M9.707 11.293a1 1 0 1 0-1.414 1.414l2 2a1 1 0 0 0 1.414 0l4-4a1 1 0 1 0-1.414-1.414L11 12.586l-1.293-1.293z",
|
|
32
32
|
fill: "inherit"
|
|
33
33
|
});
|
|
@@ -53,14 +53,14 @@ var CheckboxIcon = /*#__PURE__*/(0, _react.memo)(function (_ref) {
|
|
|
53
53
|
var icon = (0, _react.useMemo)(function () {
|
|
54
54
|
return getIcon(isIndeterminate, isChecked);
|
|
55
55
|
}, [isIndeterminate, isChecked]);
|
|
56
|
-
return (0,
|
|
56
|
+
return (0, _react2.jsx)(_svg.default, {
|
|
57
57
|
label: "",
|
|
58
58
|
size: size,
|
|
59
59
|
primaryColor: "var(--checkbox-background-color)",
|
|
60
60
|
secondaryColor: "var(--checkbox-tick-color)"
|
|
61
|
-
}, (0,
|
|
61
|
+
}, (0, _react2.jsx)("g", {
|
|
62
62
|
fillRule: "evenodd"
|
|
63
|
-
}, (0,
|
|
63
|
+
}, (0, _react2.jsx)("rect", {
|
|
64
64
|
fill: "currentColor",
|
|
65
65
|
x: "6",
|
|
66
66
|
y: "6",
|
|
@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports.default = LabelText;
|
|
7
7
|
|
|
8
|
-
var
|
|
8
|
+
var _react = require("@emotion/react");
|
|
9
9
|
|
|
10
10
|
/** @jsx jsx */
|
|
11
|
-
var labelTextStyles = (0,
|
|
11
|
+
var labelTextStyles = (0, _react.css)({
|
|
12
12
|
alignSelf: 'center',
|
|
13
13
|
gridArea: '1 / 2 / 2 / 3'
|
|
14
14
|
});
|
|
15
15
|
|
|
16
16
|
function LabelText(_ref) {
|
|
17
17
|
var children = _ref.children;
|
|
18
|
-
return (0,
|
|
18
|
+
return (0, _react.jsx)("span", {
|
|
19
19
|
css: labelTextStyles
|
|
20
20
|
}, children);
|
|
21
21
|
}
|
|
@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
7
7
|
});
|
|
8
8
|
exports.default = Label;
|
|
9
9
|
|
|
10
|
-
var
|
|
10
|
+
var _react = require("@emotion/react");
|
|
11
11
|
|
|
12
12
|
var _colors = require("@atlaskit/theme/colors");
|
|
13
13
|
|
|
@@ -18,7 +18,7 @@ var _constants = require("./constants");
|
|
|
18
18
|
var _theme = _interopRequireDefault(require("./theme"));
|
|
19
19
|
|
|
20
20
|
/** @jsx jsx */
|
|
21
|
-
var labelStyles = (0,
|
|
21
|
+
var labelStyles = (0, _react.css)({
|
|
22
22
|
display: 'grid',
|
|
23
23
|
gap: '0 4px',
|
|
24
24
|
gridAutoColumns: '1fr',
|
|
@@ -28,12 +28,12 @@ var labelStyles = (0, _core.css)({
|
|
|
28
28
|
cursor: 'default',
|
|
29
29
|
fontFamily: _constants.fontFamily
|
|
30
30
|
});
|
|
31
|
-
var disabledStyles = (0,
|
|
31
|
+
var disabledStyles = (0, _react.css)({
|
|
32
32
|
color: "var(--ds-text-disabled, ".concat(_colors.N80, ")"),
|
|
33
33
|
cursor: 'not-allowed'
|
|
34
34
|
});
|
|
35
35
|
var themeStyles = {
|
|
36
|
-
light: (0,
|
|
36
|
+
light: (0, _react.css)({
|
|
37
37
|
/**
|
|
38
38
|
* Background
|
|
39
39
|
*/
|
|
@@ -65,7 +65,7 @@ var themeStyles = {
|
|
|
65
65
|
'--local-tick-disabled': _theme.default.light.tickColor.disabledAndChecked,
|
|
66
66
|
'--local-tick-rest': 'transparent'
|
|
67
67
|
}),
|
|
68
|
-
dark: (0,
|
|
68
|
+
dark: (0, _react.css)({
|
|
69
69
|
/**
|
|
70
70
|
* Background
|
|
71
71
|
*/
|
|
@@ -110,7 +110,7 @@ function Label(_ref) {
|
|
|
110
110
|
mode = _useGlobalTheme.mode;
|
|
111
111
|
|
|
112
112
|
return (// eslint-disable-next-line jsx-a11y/click-events-have-key-events, jsx-a11y/no-noninteractive-element-interactions
|
|
113
|
-
(0,
|
|
113
|
+
(0, _react.jsx)("label", {
|
|
114
114
|
css: [labelStyles, isDisabled && disabledStyles, mode === 'light' && themeStyles.light, mode === 'dark' && themeStyles.dark],
|
|
115
115
|
"data-testid": testId,
|
|
116
116
|
"data-disabled": isDisabled || undefined,
|
|
@@ -5,20 +5,20 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports.default = RequiredIndicator;
|
|
7
7
|
|
|
8
|
-
var
|
|
8
|
+
var _react = require("@emotion/react");
|
|
9
9
|
|
|
10
10
|
var _colors = require("@atlaskit/theme/colors");
|
|
11
11
|
|
|
12
12
|
var _constants = require("./constants");
|
|
13
13
|
|
|
14
14
|
/** @jsx jsx */
|
|
15
|
-
var requiredIndicatorStyles = (0,
|
|
15
|
+
var requiredIndicatorStyles = (0, _react.css)({
|
|
16
16
|
paddingLeft: _constants.gridSize * 0.25,
|
|
17
17
|
color: "var(--ds-text-danger, ".concat(_colors.R500, ")")
|
|
18
18
|
});
|
|
19
19
|
|
|
20
20
|
function RequiredIndicator() {
|
|
21
|
-
return (0,
|
|
21
|
+
return (0, _react.jsx)("span", {
|
|
22
22
|
css: requiredIndicatorStyles,
|
|
23
23
|
"aria-hidden": true
|
|
24
24
|
}, "*");
|
package/dist/cjs/version.json
CHANGED
package/dist/es2019/checkbox.js
CHANGED
|
@@ -2,7 +2,7 @@ import _extends from "@babel/runtime/helpers/extends";
|
|
|
2
2
|
|
|
3
3
|
/** @jsx jsx */
|
|
4
4
|
import { forwardRef, memo, useCallback, useRef, useState } from 'react';
|
|
5
|
-
import { css, jsx } from '@emotion/
|
|
5
|
+
import { css, jsx } from '@emotion/react';
|
|
6
6
|
import { usePlatformLeafEventHandler } from '@atlaskit/analytics-next/usePlatformLeafEventHandler';
|
|
7
7
|
import mergeRefs from '@atlaskit/ds-lib/merge-refs';
|
|
8
8
|
import { CheckboxIcon, Label, LabelText, RequiredIndicator } from './internal';
|
|
@@ -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.
|
|
151
|
+
packageVersion: "12.4.0"
|
|
152
152
|
});
|
|
153
153
|
const internalRef = useRef(null);
|
|
154
154
|
const mergedRefs = mergeRefs([internalRef, ref]); // Use isChecked from the state if it is controlled
|
package/dist/es2019/version.json
CHANGED
package/dist/esm/checkbox.js
CHANGED
|
@@ -5,7 +5,7 @@ var _excluded = ["isChecked", "isDisabled", "isInvalid", "defaultChecked", "isIn
|
|
|
5
5
|
|
|
6
6
|
/** @jsx jsx */
|
|
7
7
|
import { forwardRef, memo, useCallback, useRef, useState } from 'react';
|
|
8
|
-
import { css, jsx } from '@emotion/
|
|
8
|
+
import { css, jsx } from '@emotion/react';
|
|
9
9
|
import { usePlatformLeafEventHandler } from '@atlaskit/analytics-next/usePlatformLeafEventHandler';
|
|
10
10
|
import mergeRefs from '@atlaskit/ds-lib/merge-refs';
|
|
11
11
|
import { CheckboxIcon, Label, LabelText, RequiredIndicator } from './internal';
|
|
@@ -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.
|
|
162
|
+
packageVersion: "12.4.0"
|
|
163
163
|
});
|
|
164
164
|
var internalRef = useRef(null);
|
|
165
165
|
var mergedRefs = mergeRefs([internalRef, ref]); // Use isChecked from the state if it is controlled
|
package/dist/esm/version.json
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
/** @jsx jsx */
|
|
2
|
+
import { jsx } from '@emotion/react';
|
|
2
3
|
import { LabelTextProps } from '../types';
|
|
3
|
-
export default function LabelText({ children }: LabelTextProps): JSX.Element;
|
|
4
|
+
export default function LabelText({ children }: LabelTextProps): jsx.JSX.Element;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
/** @jsx jsx */
|
|
2
|
+
import { jsx } from '@emotion/react';
|
|
2
3
|
import { LabelProps } from '../types';
|
|
3
|
-
export default function Label({ children, isDisabled, testId, onClick, id, }: LabelProps): JSX.Element;
|
|
4
|
+
export default function Label({ children, isDisabled, testId, onClick, id, }: LabelProps): jsx.JSX.Element;
|
|
@@ -1,2 +1,3 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
/** @jsx jsx */
|
|
2
|
+
import { jsx } from '@emotion/react';
|
|
3
|
+
export default function RequiredIndicator(): jsx.JSX.Element;
|
|
@@ -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,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,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
|
+
"version": "12.4.0",
|
|
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": {
|
|
@@ -28,11 +35,11 @@
|
|
|
28
35
|
"dependencies": {
|
|
29
36
|
"@atlaskit/analytics-next": "^8.2.0",
|
|
30
37
|
"@atlaskit/ds-lib": "^2.1.0",
|
|
31
|
-
"@atlaskit/icon": "^21.
|
|
32
|
-
"@atlaskit/theme": "^12.
|
|
38
|
+
"@atlaskit/icon": "^21.11.0",
|
|
39
|
+
"@atlaskit/theme": "^12.2.0",
|
|
33
40
|
"@atlaskit/tokens": "^0.10.0",
|
|
34
41
|
"@babel/runtime": "^7.0.0",
|
|
35
|
-
"@emotion/
|
|
42
|
+
"@emotion/react": "^11.7.1"
|
|
36
43
|
},
|
|
37
44
|
"peerDependencies": {
|
|
38
45
|
"react": "^16.8.0"
|
|
@@ -40,18 +47,18 @@
|
|
|
40
47
|
"devDependencies": {
|
|
41
48
|
"@atlaskit/button": "^16.3.0",
|
|
42
49
|
"@atlaskit/docs": "*",
|
|
43
|
-
"@atlaskit/form": "^8.
|
|
44
|
-
"@atlaskit/section-message": "^6.
|
|
50
|
+
"@atlaskit/form": "^8.6.0",
|
|
51
|
+
"@atlaskit/section-message": "^6.3.0",
|
|
45
52
|
"@atlaskit/ssr": "*",
|
|
46
|
-
"@atlaskit/toggle": "^12.
|
|
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": "^
|
|
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.
|
|
61
|
+
"typescript": "4.5.5",
|
|
55
62
|
"wait-for-expect": "^1.2.0"
|
|
56
63
|
},
|
|
57
64
|
"keywords": [
|
package/report.api.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
## API Report File for "@atlaskit/checkbox"
|
|
1
|
+
## API Report File for "@atlaskit/checkbox".
|
|
2
2
|
|
|
3
|
-
> Do not edit this file.
|
|
3
|
+
> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
4
6
|
|
|
5
7
|
```ts
|
|
6
8
|
/// <reference types="react" />
|