@instructure/ui-checkbox 11.7.3-snapshot-37 → 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 +1 -1
- package/package.json +16 -16
- package/src/Checkbox/v1/README.md +14 -0
- package/src/Checkbox/v2/README.md +14 -0
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-
|
|
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
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@instructure/ui-checkbox",
|
|
3
|
-
"version": "11.7.3-snapshot-
|
|
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-
|
|
20
|
-
"@instructure/emotion": "11.7.3-snapshot-
|
|
21
|
-
"@instructure/shared-types": "11.7.3-snapshot-
|
|
22
|
-
"@instructure/ui-dom-utils": "11.7.3-snapshot-
|
|
23
|
-
"@instructure/ui-form-field": "11.7.3-snapshot-
|
|
24
|
-
"@instructure/ui-icons": "11.7.3-snapshot-
|
|
25
|
-
"@instructure/ui-
|
|
26
|
-
"@instructure/ui-
|
|
27
|
-
"@instructure/ui-utils": "11.7.3-snapshot-
|
|
28
|
-
"@instructure/ui-
|
|
29
|
-
"@instructure/
|
|
30
|
-
"@instructure/
|
|
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-
|
|
38
|
-
"@instructure/ui-babel-preset": "11.7.3-snapshot-
|
|
39
|
-
"@instructure/ui-color-utils": "11.7.3-snapshot-
|
|
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"
|
|
@@ -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
|
|
@@ -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
|