@instructure/ui-checkbox 11.7.3-snapshot-33 → 11.7.3-snapshot-38

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
@@ -3,7 +3,7 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
- ## [11.7.3-snapshot-33](https://github.com/instructure/instructure-ui/compare/v11.7.2...v11.7.3-snapshot-33) (2026-05-07)
6
+ ## [11.7.3-snapshot-38](https://github.com/instructure/instructure-ui/compare/v11.7.2...v11.7.3-snapshot-38) (2026-05-07)
7
7
 
8
8
 
9
9
  ### Bug Fixes
@@ -26,7 +26,7 @@ var _dec, _class;
26
26
  import { Component } from 'react';
27
27
  import { SVGIcon } from '@instructure/ui-svg-images';
28
28
  import { IconCheckMarkSolid } from '@instructure/ui-icons';
29
- import { withStyleLegacy as withStyle } from '@instructure/emotion';
29
+ import { withStyle } from '@instructure/emotion';
30
30
  import generateStyle from "./styles.js";
31
31
  import generateComponentTheme from "./theme.js";
32
32
  import { allowedProps } from "./props.js";
@@ -25,7 +25,7 @@ var _dec, _class;
25
25
 
26
26
  import { Component } from 'react';
27
27
  import { IconCheckSolid, IconXSolid } from '@instructure/ui-icons';
28
- import { withStyleLegacy as withStyle } from '@instructure/emotion';
28
+ import { withStyle } from '@instructure/emotion';
29
29
  import generateStyle from "./styles.js";
30
30
  import generateComponentTheme from "./theme.js";
31
31
  import { allowedProps } from "./props.js";
@@ -31,7 +31,7 @@ import { logError as error } from '@instructure/console';
31
31
  import { isActiveElement } from '@instructure/ui-dom-utils';
32
32
  import { omitProps, withDeterministicId } from '@instructure/ui-react-utils';
33
33
  import { View } from '@instructure/ui-view/v11_6';
34
- import { withStyleLegacy as withStyle } from '@instructure/emotion';
34
+ import { withStyle } from '@instructure/emotion';
35
35
  import { CheckboxFacade } from "./CheckboxFacade/index.js";
36
36
  import { ToggleFacade } from "./ToggleFacade/index.js";
37
37
  import generateStyle from "./styles.js";
@@ -25,7 +25,7 @@ var _dec, _class;
25
25
 
26
26
  import { Component } from 'react';
27
27
  import { CheckInstUIIcon, MinusInstUIIcon, renderIconWithProps } from '@instructure/ui-icons';
28
- import { withStyle } from '@instructure/emotion';
28
+ import { withStyleNew } from '@instructure/emotion';
29
29
  import generateStyle from "./styles.js";
30
30
  import { allowedProps } from "./props.js";
31
31
  import { jsx as _jsx, jsxs as _jsxs } from "@emotion/react/jsx-runtime";
@@ -34,7 +34,7 @@ import { jsx as _jsx, jsxs as _jsxs } from "@emotion/react/jsx-runtime";
34
34
  parent: Checkbox
35
35
  ---
36
36
  **/
37
- let CheckboxFacade = (_dec = withStyle(generateStyle, 'Checkbox'), _dec(_class = class CheckboxFacade extends Component {
37
+ let CheckboxFacade = (_dec = withStyleNew(generateStyle, 'Checkbox'), _dec(_class = class CheckboxFacade extends Component {
38
38
  static displayName = "CheckboxFacade";
39
39
  static componentId = 'CheckboxFacade';
40
40
  static allowedProps = allowedProps;
@@ -25,7 +25,7 @@ var _dec, _class;
25
25
 
26
26
  import { Component } from 'react';
27
27
  import { CheckInstUIIcon, XInstUIIcon, renderIconWithProps } from '@instructure/ui-icons';
28
- import { withStyle } from '@instructure/emotion';
28
+ import { withStyleNew } from '@instructure/emotion';
29
29
  import generateStyle from "./styles.js";
30
30
  import { allowedProps } from "./props.js";
31
31
  import { jsx as _jsx, jsxs as _jsxs } from "@emotion/react/jsx-runtime";
@@ -34,7 +34,7 @@ import { jsx as _jsx, jsxs as _jsxs } from "@emotion/react/jsx-runtime";
34
34
  parent: Checkbox
35
35
  ---
36
36
  **/
37
- let ToggleFacade = (_dec = withStyle(generateStyle, 'Toggle'), _dec(_class = class ToggleFacade extends Component {
37
+ let ToggleFacade = (_dec = withStyleNew(generateStyle, 'Toggle'), _dec(_class = class ToggleFacade extends Component {
38
38
  static displayName = "ToggleFacade";
39
39
  static componentId = 'ToggleFacade';
40
40
  static allowedProps = allowedProps;
@@ -31,7 +31,7 @@ import { logError as error } from '@instructure/console';
31
31
  import { isActiveElement } from '@instructure/ui-dom-utils';
32
32
  import { omitProps, withDeterministicId } from '@instructure/ui-react-utils';
33
33
  import { View } from '@instructure/ui-view/latest';
34
- import { withStyle } from '@instructure/emotion';
34
+ import { withStyleNew } from '@instructure/emotion';
35
35
  import { CheckboxFacade } from "./CheckboxFacade/index.js";
36
36
  import { ToggleFacade } from "./ToggleFacade/index.js";
37
37
  import generateStyle from "./styles.js";
@@ -43,7 +43,7 @@ category: components
43
43
  tags: toggle, switch
44
44
  ---
45
45
  **/
46
- let Checkbox = (_dec = withDeterministicId(), _dec2 = withStyle(generateStyle), _dec(_class = _dec2(_class = class Checkbox extends Component {
46
+ let Checkbox = (_dec = withDeterministicId(), _dec2 = withStyleNew(generateStyle), _dec(_class = _dec2(_class = class Checkbox extends Component {
47
47
  static displayName = "Checkbox";
48
48
  static componentId = 'Checkbox';
49
49
  static allowedProps = allowedProps;
@@ -42,7 +42,7 @@ var _dec, _class;
42
42
  parent: Checkbox
43
43
  ---
44
44
  **/
45
- let CheckboxFacade = exports.CheckboxFacade = (_dec = (0, _emotion.withStyleLegacy)(_styles.default, _theme.default), _dec(_class = class CheckboxFacade extends _react.Component {
45
+ let CheckboxFacade = exports.CheckboxFacade = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _dec(_class = class CheckboxFacade extends _react.Component {
46
46
  static displayName = "CheckboxFacade";
47
47
  static componentId = 'CheckboxFacade';
48
48
  static allowedProps = _props.allowedProps;
@@ -42,7 +42,7 @@ var _dec, _class;
42
42
  parent: Checkbox
43
43
  ---
44
44
  **/
45
- let ToggleFacade = exports.ToggleFacade = (_dec = (0, _emotion.withStyleLegacy)(_styles.default, _theme.default), _dec(_class = class ToggleFacade extends _react.Component {
45
+ let ToggleFacade = exports.ToggleFacade = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default), _dec(_class = class ToggleFacade extends _react.Component {
46
46
  static displayName = "ToggleFacade";
47
47
  static componentId = 'ToggleFacade';
48
48
  static allowedProps = _props.allowedProps;
@@ -64,7 +64,7 @@ category: components
64
64
  tags: toggle, switch
65
65
  ---
66
66
  **/
67
- let Checkbox = exports.Checkbox = (_dec = (0, _withDeterministicId.withDeterministicId)(), _dec2 = (0, _emotion.withStyleLegacy)(_styles.default, _theme.default), _dec(_class = _dec2(_class = class Checkbox extends _react.Component {
67
+ let Checkbox = exports.Checkbox = (_dec = (0, _withDeterministicId.withDeterministicId)(), _dec2 = (0, _emotion.withStyle)(_styles.default, _theme.default), _dec(_class = _dec2(_class = class Checkbox extends _react.Component {
68
68
  static displayName = "Checkbox";
69
69
  static componentId = 'Checkbox';
70
70
  static allowedProps = _props.allowedProps;
@@ -40,7 +40,7 @@ var _dec, _class;
40
40
  parent: Checkbox
41
41
  ---
42
42
  **/
43
- let CheckboxFacade = exports.CheckboxFacade = (_dec = (0, _emotion.withStyle)(_styles.default, 'Checkbox'), _dec(_class = class CheckboxFacade extends _react.Component {
43
+ let CheckboxFacade = exports.CheckboxFacade = (_dec = (0, _emotion.withStyleNew)(_styles.default, 'Checkbox'), _dec(_class = class CheckboxFacade extends _react.Component {
44
44
  static displayName = "CheckboxFacade";
45
45
  static componentId = 'CheckboxFacade';
46
46
  static allowedProps = _props.allowedProps;
@@ -40,7 +40,7 @@ var _dec, _class;
40
40
  parent: Checkbox
41
41
  ---
42
42
  **/
43
- let ToggleFacade = exports.ToggleFacade = (_dec = (0, _emotion.withStyle)(_styles.default, 'Toggle'), _dec(_class = class ToggleFacade extends _react.Component {
43
+ let ToggleFacade = exports.ToggleFacade = (_dec = (0, _emotion.withStyleNew)(_styles.default, 'Toggle'), _dec(_class = class ToggleFacade extends _react.Component {
44
44
  static displayName = "ToggleFacade";
45
45
  static componentId = 'ToggleFacade';
46
46
  static allowedProps = _props.allowedProps;
@@ -63,7 +63,7 @@ category: components
63
63
  tags: toggle, switch
64
64
  ---
65
65
  **/
66
- let Checkbox = exports.Checkbox = (_dec = (0, _withDeterministicId.withDeterministicId)(), _dec2 = (0, _emotion.withStyle)(_styles.default), _dec(_class = _dec2(_class = class Checkbox extends _react.Component {
66
+ let Checkbox = exports.Checkbox = (_dec = (0, _withDeterministicId.withDeterministicId)(), _dec2 = (0, _emotion.withStyleNew)(_styles.default), _dec(_class = _dec2(_class = class Checkbox extends _react.Component {
67
67
  static displayName = "Checkbox";
68
68
  static componentId = 'Checkbox';
69
69
  static allowedProps = _props.allowedProps;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@instructure/ui-checkbox",
3
- "version": "11.7.3-snapshot-33",
3
+ "version": "11.7.3-snapshot-38",
4
4
  "description": " styled HTML input type='checkbox' component.",
5
5
  "author": "Instructure, Inc. Engineering and Product Design",
6
6
  "module": "./es/index.js",
@@ -16,27 +16,27 @@
16
16
  "dependencies": {
17
17
  "@babel/runtime": "^7.29.2",
18
18
  "keycode": "^2",
19
- "@instructure/console": "11.7.3-snapshot-33",
20
- "@instructure/emotion": "11.7.3-snapshot-33",
21
- "@instructure/ui-dom-utils": "11.7.3-snapshot-33",
22
- "@instructure/ui-form-field": "11.7.3-snapshot-33",
23
- "@instructure/shared-types": "11.7.3-snapshot-33",
24
- "@instructure/ui-icons": "11.7.3-snapshot-33",
25
- "@instructure/ui-react-utils": "11.7.3-snapshot-33",
26
- "@instructure/ui-svg-images": "11.7.3-snapshot-33",
27
- "@instructure/ui-themes": "11.7.3-snapshot-33",
28
- "@instructure/ui-utils": "11.7.3-snapshot-33",
29
- "@instructure/uid": "11.7.3-snapshot-33",
30
- "@instructure/ui-view": "11.7.3-snapshot-33"
19
+ "@instructure/console": "11.7.3-snapshot-38",
20
+ "@instructure/emotion": "11.7.3-snapshot-38",
21
+ "@instructure/shared-types": "11.7.3-snapshot-38",
22
+ "@instructure/ui-dom-utils": "11.7.3-snapshot-38",
23
+ "@instructure/ui-form-field": "11.7.3-snapshot-38",
24
+ "@instructure/ui-icons": "11.7.3-snapshot-38",
25
+ "@instructure/ui-react-utils": "11.7.3-snapshot-38",
26
+ "@instructure/ui-svg-images": "11.7.3-snapshot-38",
27
+ "@instructure/ui-utils": "11.7.3-snapshot-38",
28
+ "@instructure/ui-themes": "11.7.3-snapshot-38",
29
+ "@instructure/ui-view": "11.7.3-snapshot-38",
30
+ "@instructure/uid": "11.7.3-snapshot-38"
31
31
  },
32
32
  "devDependencies": {
33
33
  "@testing-library/jest-dom": "^6.6.3",
34
34
  "@testing-library/react": "15.0.7",
35
35
  "@testing-library/user-event": "^14.6.1",
36
36
  "vitest": "^3.2.2",
37
- "@instructure/ui-axe-check": "11.7.3-snapshot-33",
38
- "@instructure/ui-babel-preset": "11.7.3-snapshot-33",
39
- "@instructure/ui-color-utils": "11.7.3-snapshot-33"
37
+ "@instructure/ui-axe-check": "11.7.3-snapshot-38",
38
+ "@instructure/ui-babel-preset": "11.7.3-snapshot-38",
39
+ "@instructure/ui-color-utils": "11.7.3-snapshot-38"
40
40
  },
41
41
  "peerDependencies": {
42
42
  "react": ">=18 <=19"
@@ -27,7 +27,7 @@ import { Component } from 'react'
27
27
  import { SVGIcon } from '@instructure/ui-svg-images'
28
28
  import { IconCheckMarkSolid } from '@instructure/ui-icons'
29
29
 
30
- import { withStyleLegacy as withStyle } from '@instructure/emotion'
30
+ import { withStyle } from '@instructure/emotion'
31
31
 
32
32
  import generateStyle from './styles'
33
33
  import generateComponentTheme from './theme'
@@ -162,6 +162,20 @@ type: example
162
162
  />
163
163
  ```
164
164
 
165
+ ### Required Fields
166
+
167
+ Whenever a `Checkbox` is required, you must include a note explaining what the asterisk means — typically "Fields marked with an asterisk (\*) are required."
168
+
169
+ ```js
170
+ ---
171
+ type: example
172
+ ---
173
+ <FormFieldGroup description="Terms" rowSpacing="small" layout="stacked">
174
+ <Text>Fields marked with an asterisk <span aria-hidden="true">(*)</span> are required.</Text>
175
+ <Checkbox label="I agree to the terms and conditions" value="terms" isRequired />
176
+ </FormFieldGroup>
177
+ ```
178
+
165
179
  ### Guidelines
166
180
 
167
181
  ```js
@@ -26,7 +26,7 @@ import { Component } from 'react'
26
26
 
27
27
  import { IconCheckSolid, IconXSolid } from '@instructure/ui-icons'
28
28
 
29
- import { withStyleLegacy as withStyle } from '@instructure/emotion'
29
+ import { withStyle } from '@instructure/emotion'
30
30
 
31
31
  import generateStyle from './styles'
32
32
  import generateComponentTheme from './theme'
@@ -32,7 +32,7 @@ import { isActiveElement } from '@instructure/ui-dom-utils'
32
32
  import { omitProps, withDeterministicId } from '@instructure/ui-react-utils'
33
33
  import { View } from '@instructure/ui-view/v11_6'
34
34
 
35
- import { withStyleLegacy as withStyle } from '@instructure/emotion'
35
+ import { withStyle } from '@instructure/emotion'
36
36
 
37
37
  import { CheckboxFacade } from './CheckboxFacade'
38
38
  import { ToggleFacade } from './ToggleFacade'
@@ -30,7 +30,7 @@ import {
30
30
  renderIconWithProps
31
31
  } from '@instructure/ui-icons'
32
32
 
33
- import { withStyle } from '@instructure/emotion'
33
+ import { withStyleNew } from '@instructure/emotion'
34
34
 
35
35
  import generateStyle from './styles'
36
36
 
@@ -42,7 +42,7 @@ import type { CheckboxFacadeProps } from './props'
42
42
  parent: Checkbox
43
43
  ---
44
44
  **/
45
- @withStyle(generateStyle, 'Checkbox')
45
+ @withStyleNew(generateStyle, 'Checkbox')
46
46
  class CheckboxFacade extends Component<CheckboxFacadeProps> {
47
47
  static readonly componentId = 'CheckboxFacade'
48
48
 
@@ -166,6 +166,20 @@ type: example
166
166
 
167
167
  The underlying `<input>` has a `data-checked` attribute (`"true"`, `"false"`, or `"mixed"` when indeterminate) that can be queried from the DOM to read the current state.
168
168
 
169
+ ### Required Fields
170
+
171
+ Whenever a `Checkbox` is required, you must include a note explaining what the asterisk means — typically "Fields marked with an asterisk (\*) are required."
172
+
173
+ ```js
174
+ ---
175
+ type: example
176
+ ---
177
+ <FormFieldGroup description="Terms" rowSpacing="small" layout="stacked">
178
+ <Text>Fields marked with an asterisk <span aria-hidden="true">(*)</span> are required.</Text>
179
+ <Checkbox label="I agree to the terms and conditions" value="terms" isRequired />
180
+ </FormFieldGroup>
181
+ ```
182
+
169
183
  ### Guidelines
170
184
 
171
185
  ```js
@@ -30,7 +30,7 @@ import {
30
30
  renderIconWithProps
31
31
  } from '@instructure/ui-icons'
32
32
 
33
- import { withStyle } from '@instructure/emotion'
33
+ import { withStyleNew } from '@instructure/emotion'
34
34
 
35
35
  import generateStyle from './styles'
36
36
 
@@ -42,7 +42,7 @@ import type { ToggleFacadeProps } from './props'
42
42
  parent: Checkbox
43
43
  ---
44
44
  **/
45
- @withStyle(generateStyle, 'Toggle')
45
+ @withStyleNew(generateStyle, 'Toggle')
46
46
  class ToggleFacade extends Component<ToggleFacadeProps> {
47
47
  static readonly componentId = 'ToggleFacade'
48
48
 
@@ -32,7 +32,7 @@ import { isActiveElement } from '@instructure/ui-dom-utils'
32
32
  import { omitProps, withDeterministicId } from '@instructure/ui-react-utils'
33
33
  import { View } from '@instructure/ui-view/latest'
34
34
 
35
- import { withStyle } from '@instructure/emotion'
35
+ import { withStyleNew } from '@instructure/emotion'
36
36
 
37
37
  import { CheckboxFacade } from './CheckboxFacade'
38
38
  import { ToggleFacade } from './ToggleFacade'
@@ -50,7 +50,7 @@ tags: toggle, switch
50
50
  **/
51
51
 
52
52
  @withDeterministicId()
53
- @withStyle(generateStyle)
53
+ @withStyleNew(generateStyle)
54
54
  class Checkbox extends Component<CheckboxProps, CheckboxState> {
55
55
  static readonly componentId = 'Checkbox'
56
56