@instructure/ui-progress 8.18.1-snapshot.1 → 8.18.1-snapshot.12
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/package.json +14 -14
- package/src/ProgressBar/README.md +12 -11
- package/src/ProgressCircle/README.md +13 -11
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@instructure/ui-progress",
|
|
3
|
-
"version": "8.18.1-snapshot.
|
|
3
|
+
"version": "8.18.1-snapshot.12+ca14b3dc8",
|
|
4
4
|
"description": "Styled HTML <progress /> elements for showing completion of a task",
|
|
5
5
|
"author": "Instructure, Inc. Engineering and Product Design",
|
|
6
6
|
"module": "./es/index.js",
|
|
@@ -24,21 +24,21 @@
|
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@babel/runtime": "^7.13.10",
|
|
27
|
-
"@instructure/console": "8.18.1-snapshot.
|
|
28
|
-
"@instructure/emotion": "8.18.1-snapshot.
|
|
29
|
-
"@instructure/shared-types": "8.18.1-snapshot.
|
|
30
|
-
"@instructure/ui-a11y-content": "8.18.1-snapshot.
|
|
31
|
-
"@instructure/ui-color-utils": "8.18.1-snapshot.
|
|
32
|
-
"@instructure/ui-react-utils": "8.18.1-snapshot.
|
|
33
|
-
"@instructure/ui-testable": "8.18.1-snapshot.
|
|
34
|
-
"@instructure/ui-view": "8.18.1-snapshot.
|
|
27
|
+
"@instructure/console": "8.18.1-snapshot.12+ca14b3dc8",
|
|
28
|
+
"@instructure/emotion": "8.18.1-snapshot.12+ca14b3dc8",
|
|
29
|
+
"@instructure/shared-types": "8.18.1-snapshot.12+ca14b3dc8",
|
|
30
|
+
"@instructure/ui-a11y-content": "8.18.1-snapshot.12+ca14b3dc8",
|
|
31
|
+
"@instructure/ui-color-utils": "8.18.1-snapshot.12+ca14b3dc8",
|
|
32
|
+
"@instructure/ui-react-utils": "8.18.1-snapshot.12+ca14b3dc8",
|
|
33
|
+
"@instructure/ui-testable": "8.18.1-snapshot.12+ca14b3dc8",
|
|
34
|
+
"@instructure/ui-view": "8.18.1-snapshot.12+ca14b3dc8",
|
|
35
35
|
"prop-types": "^15"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@instructure/ui-babel-preset": "8.18.1-snapshot.
|
|
39
|
-
"@instructure/ui-test-locator": "8.18.1-snapshot.
|
|
40
|
-
"@instructure/ui-test-utils": "8.18.1-snapshot.
|
|
41
|
-
"@instructure/ui-themes": "8.18.1-snapshot.
|
|
38
|
+
"@instructure/ui-babel-preset": "8.18.1-snapshot.12+ca14b3dc8",
|
|
39
|
+
"@instructure/ui-test-locator": "8.18.1-snapshot.12+ca14b3dc8",
|
|
40
|
+
"@instructure/ui-test-utils": "8.18.1-snapshot.12+ca14b3dc8",
|
|
41
|
+
"@instructure/ui-themes": "8.18.1-snapshot.12+ca14b3dc8"
|
|
42
42
|
},
|
|
43
43
|
"peerDependencies": {
|
|
44
44
|
"react": ">=16.8 <=17"
|
|
@@ -47,5 +47,5 @@
|
|
|
47
47
|
"access": "public"
|
|
48
48
|
},
|
|
49
49
|
"sideEffects": false,
|
|
50
|
-
"gitHead": "
|
|
50
|
+
"gitHead": "ca14b3dc8f0315daef7b86aa05f711e6d6684c58"
|
|
51
51
|
}
|
|
@@ -49,17 +49,19 @@ component. Set it to `primary-inverse` when the component is used on dark backgr
|
|
|
49
49
|
```js
|
|
50
50
|
---
|
|
51
51
|
example: true
|
|
52
|
-
background: 'checkerboard-inverse'
|
|
53
52
|
---
|
|
54
|
-
<
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
53
|
+
<View background="primary-inverse" as="div">
|
|
54
|
+
<ProgressBar
|
|
55
|
+
screenReaderLabel="Loading completion"
|
|
56
|
+
color="primary-inverse"
|
|
57
|
+
valueNow={30}
|
|
58
|
+
valueMax={60}
|
|
59
|
+
/>
|
|
60
|
+
</View>
|
|
60
61
|
```
|
|
61
62
|
|
|
62
63
|
### `meterColor`
|
|
64
|
+
|
|
63
65
|
The color of the progress meter is set separately through the `meterColor` property.
|
|
64
66
|
|
|
65
67
|
```js
|
|
@@ -101,7 +103,7 @@ example: true
|
|
|
101
103
|
valueNow={40}
|
|
102
104
|
valueMax={60}
|
|
103
105
|
margin="0 0 small"
|
|
104
|
-
/>
|
|
106
|
+
/>
|
|
105
107
|
</div>
|
|
106
108
|
```
|
|
107
109
|
|
|
@@ -130,8 +132,7 @@ example: true
|
|
|
130
132
|
```
|
|
131
133
|
|
|
132
134
|
> `<ProgressBar />` defaults to setting the meter color to `success` when
|
|
133
|
-
complete.
|
|
134
|
-
|
|
135
|
+
> complete.
|
|
135
136
|
|
|
136
137
|
### `renderValue` / `formatScreenReaderValue`
|
|
137
138
|
|
|
@@ -139,7 +140,7 @@ Via the `renderValue` prop, developers can use `valueMax` and `valueNow` props t
|
|
|
139
140
|
value that `<ProgressBar />` displays.
|
|
140
141
|
|
|
141
142
|
> `renderValue` will not be spoken by screen readers. Any essential information
|
|
142
|
-
in `renderValue` must also be conveyed via `formatScreenReaderValue` for screen reader users.
|
|
143
|
+
> in `renderValue` must also be conveyed via `formatScreenReaderValue` for screen reader users.
|
|
143
144
|
|
|
144
145
|
```js
|
|
145
146
|
---
|
|
@@ -88,17 +88,20 @@ component. Set it to `primary-inverse` when the component is used on dark backgr
|
|
|
88
88
|
```js
|
|
89
89
|
---
|
|
90
90
|
example: true
|
|
91
|
-
|
|
91
|
+
|
|
92
92
|
---
|
|
93
|
-
<
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
93
|
+
<View background="primary-inverse" as="div">
|
|
94
|
+
<ProgressCircle
|
|
95
|
+
screenReaderLabel="Loading completion"
|
|
96
|
+
color="primary-inverse"
|
|
97
|
+
valueNow={50}
|
|
98
|
+
valueMax={60}
|
|
99
|
+
/>
|
|
100
|
+
</View>
|
|
99
101
|
```
|
|
100
102
|
|
|
101
103
|
### `meterColor`
|
|
104
|
+
|
|
102
105
|
The color of the progress meter is set separately through the `meterColor` property.
|
|
103
106
|
|
|
104
107
|
```js
|
|
@@ -140,7 +143,7 @@ example: true
|
|
|
140
143
|
valueNow={40}
|
|
141
144
|
valueMax={60}
|
|
142
145
|
margin="0 0 small"
|
|
143
|
-
/>
|
|
146
|
+
/>
|
|
144
147
|
</div>
|
|
145
148
|
```
|
|
146
149
|
|
|
@@ -169,8 +172,7 @@ example: true
|
|
|
169
172
|
```
|
|
170
173
|
|
|
171
174
|
> `<ProgressCircle />` defaults to setting the meter color to `success` when
|
|
172
|
-
complete.
|
|
173
|
-
|
|
175
|
+
> complete.
|
|
174
176
|
|
|
175
177
|
### `renderValue` / `formatScreenReaderValue`
|
|
176
178
|
|
|
@@ -178,7 +180,7 @@ Via the `renderValue` prop, developers can use `valueMax` and `valueNow` props t
|
|
|
178
180
|
value that `<ProgressCircle />` displays.
|
|
179
181
|
|
|
180
182
|
> `renderValue` will not be spoken by screen readers. Any essential information
|
|
181
|
-
in `renderValue` must also be conveyed via `formatScreenReaderValue` for screen reader users.
|
|
183
|
+
> in `renderValue` must also be conveyed via `formatScreenReaderValue` for screen reader users.
|
|
182
184
|
|
|
183
185
|
```js
|
|
184
186
|
---
|