@instructure/ui-number-input 9.8.1-pr-snapshot-1729284977591 → 9.8.1
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 +2 -2
- package/package.json +15 -15
- package/src/NumberInput/README.md +4 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,12 +3,12 @@
|
|
|
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
|
-
## [9.8.1
|
|
6
|
+
## [9.8.1](https://github.com/instructure/instructure-ui/compare/v9.8.0...v9.8.1) (2024-10-28)
|
|
7
7
|
|
|
8
8
|
|
|
9
9
|
### Bug Fixes
|
|
10
10
|
|
|
11
|
-
* **ui-number-input:** add back options for string input ([
|
|
11
|
+
* **ui-number-input:** add back options for string input ([f08d078](https://github.com/instructure/instructure-ui/commit/f08d0786aece1731b9a122338d8a7586aec3e32a))
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@instructure/ui-number-input",
|
|
3
|
-
"version": "9.8.1
|
|
3
|
+
"version": "9.8.1",
|
|
4
4
|
"description": "A UI component library made by Instructure Inc.",
|
|
5
5
|
"author": "Instructure, Inc. Engineering and Product Design",
|
|
6
6
|
"homepage": "https://instructure.github.io/instructure-ui/",
|
|
@@ -23,25 +23,25 @@
|
|
|
23
23
|
"ts:check": "tsc -p tsconfig.build.json --noEmit --emitDeclarationOnly false"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|
|
26
|
-
"@instructure/ui-axe-check": "9.8.1
|
|
27
|
-
"@instructure/ui-babel-preset": "9.8.1
|
|
28
|
-
"@instructure/ui-scripts": "9.8.1
|
|
29
|
-
"@instructure/ui-test-locator": "9.8.1
|
|
30
|
-
"@instructure/ui-test-utils": "9.8.1
|
|
31
|
-
"@instructure/ui-themes": "9.8.1
|
|
26
|
+
"@instructure/ui-axe-check": "9.8.1",
|
|
27
|
+
"@instructure/ui-babel-preset": "9.8.1",
|
|
28
|
+
"@instructure/ui-scripts": "9.8.1",
|
|
29
|
+
"@instructure/ui-test-locator": "9.8.1",
|
|
30
|
+
"@instructure/ui-test-utils": "9.8.1",
|
|
31
|
+
"@instructure/ui-themes": "9.8.1",
|
|
32
32
|
"@testing-library/react": "^15.0.7",
|
|
33
33
|
"vitest": "^2.0.2"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
36
|
"@babel/runtime": "^7.24.5",
|
|
37
|
-
"@instructure/emotion": "9.8.1
|
|
38
|
-
"@instructure/shared-types": "9.8.1
|
|
39
|
-
"@instructure/ui-form-field": "9.8.1
|
|
40
|
-
"@instructure/ui-icons": "9.8.1
|
|
41
|
-
"@instructure/ui-react-utils": "9.8.1
|
|
42
|
-
"@instructure/ui-testable": "9.8.1
|
|
43
|
-
"@instructure/ui-utils": "9.8.1
|
|
44
|
-
"@instructure/uid": "9.8.1
|
|
37
|
+
"@instructure/emotion": "9.8.1",
|
|
38
|
+
"@instructure/shared-types": "9.8.1",
|
|
39
|
+
"@instructure/ui-form-field": "9.8.1",
|
|
40
|
+
"@instructure/ui-icons": "9.8.1",
|
|
41
|
+
"@instructure/ui-react-utils": "9.8.1",
|
|
42
|
+
"@instructure/ui-testable": "9.8.1",
|
|
43
|
+
"@instructure/ui-utils": "9.8.1",
|
|
44
|
+
"@instructure/uid": "9.8.1",
|
|
45
45
|
"keycode": "^2",
|
|
46
46
|
"prop-types": "^15.8.1"
|
|
47
47
|
},
|
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
describes: NumberInput
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
A controlled number input field.
|
|
5
|
+
A controlled number input field.
|
|
6
|
+
By deafult, it renders a `<intput type="number">` to the DOM. However, if you need any string value, use the `allowStringValue` flag. Only use this if absolutely necessary, since it could be confusing for screenreader users.
|
|
7
|
+
Note that this field **does not work
|
|
6
8
|
uncontrolled** - you must pass event handlers if you want it to respond to
|
|
7
9
|
user input.
|
|
8
10
|
|
|
@@ -164,12 +166,11 @@ type: embed
|
|
|
164
166
|
---
|
|
165
167
|
<Guidelines>
|
|
166
168
|
<Figure recommendation="yes" title="Do">
|
|
167
|
-
<Figure.Item>Use when
|
|
169
|
+
<Figure.Item>Use when you need increment/decrement functionality</Figure.Item>
|
|
168
170
|
<Figure.Item>Use labels at the top or to the left of the input field</Figure.Item>
|
|
169
171
|
</Figure>
|
|
170
172
|
<Figure recommendation="no" title="Don't">
|
|
171
173
|
<Figure.Item>Place labels or text strings to the right of the input field</Figure.Item>
|
|
172
|
-
<Figure.Item>Use for alphanumeric input</Figure.Item>
|
|
173
174
|
</Figure>
|
|
174
175
|
</Guidelines>
|
|
175
176
|
```
|