@gridui/progress 1.0.1 → 1.0.2
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/README.md +1 -1
- package/docs/progress.md +29 -0
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -5,4 +5,4 @@ Core family. Public API: `Progress`, `ProgressProps`.
|
|
|
5
5
|
Import components from `@gridui/progress` and load `@gridui/progress/styles.css` after Theme.
|
|
6
6
|
Load styles for any composed dependency used by this family. Applications own routes, labels, state persistence, and branding.
|
|
7
7
|
|
|
8
|
-
See [component ownership](
|
|
8
|
+
See [component ownership](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/docs/component-ownership.md) and [release history](https://github.com/sudo-ui/GridUI-React-Monorepo/tree/main/packages-core/progress/.changeset/history).
|
package/docs/progress.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Progress
|
|
2
|
+
|
|
3
|
+
Import `Progress` from `@gridui/progress` and load this family's styles after Theme. Use it for
|
|
4
|
+
completion of a task with a known total, or for ongoing work with unknown progress.
|
|
5
|
+
Use LoadingSurface when preserving the geometry of content that is loading.
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
<Progress value={completed} max={total} aria-label="File upload" />
|
|
9
|
+
<Progress value={null} aria-label="Preparing files" aria-valuetext="Waiting for server" />
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
`value` is required and accepts a number or `null`. The default `max` is 100 and
|
|
13
|
+
must be finite and positive. Values outside 0–max are clamped; non-finite values
|
|
14
|
+
become indeterminate. The same normalized value drives the indicator and Radix
|
|
15
|
+
`progressbar` semantics. Unknown progress omits `aria-valuenow`. Supply a visible
|
|
16
|
+
label with `aria-labelledby` or a localized `aria-label`; optional `aria-valuetext`
|
|
17
|
+
expresses task-specific progress without forcing English copy.
|
|
18
|
+
|
|
19
|
+
The control does not announce every increment as a live region. Applications can
|
|
20
|
+
announce meaningful milestones separately. It forwards native div props and ref,
|
|
21
|
+
but owns children, role, minimum, maximum, and current-value attributes. It has no
|
|
22
|
+
visible percentage label; consumers place meaningful text in the surrounding layout.
|
|
23
|
+
|
|
24
|
+
The determinate fill transitions with the shared quick duration. Unknown progress
|
|
25
|
+
uses a moving partial fill, with its direction following RTL. Its cycle uses
|
|
26
|
+
`--gridui-motion-duration-loop` (1.5s) and `--gridui-motion-ease-in-out`.
|
|
27
|
+
Reduced motion stops
|
|
28
|
+
the movement and leaves a static partial indicator. Completion uses the same
|
|
29
|
+
semantic accent color and does not add a second success message.
|
package/package.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gridui/progress",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "GridUI React progress",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"files": [
|
|
8
8
|
"dist",
|
|
9
|
+
"docs",
|
|
9
10
|
"README.md"
|
|
10
11
|
],
|
|
11
12
|
"sideEffects": [
|
|
@@ -26,8 +27,8 @@
|
|
|
26
27
|
"react-dom": "^19.2.0"
|
|
27
28
|
},
|
|
28
29
|
"dependencies": {
|
|
29
|
-
"@gridui/style-utils": "^2.1.
|
|
30
|
-
"@gridui/theme": "^2.2
|
|
30
|
+
"@gridui/style-utils": "^2.1.4",
|
|
31
|
+
"@gridui/theme": "^2.3.2",
|
|
31
32
|
"@radix-ui/react-progress": "1.2.1"
|
|
32
33
|
},
|
|
33
34
|
"devDependencies": {
|