You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/website/src/routes/docs/headless/progress/index.mdx
+71Lines changed: 71 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,3 +13,74 @@ import { Note } from '~/components/note/note';
13
13
Displays a progress bar related to a task.
14
14
15
15
<Showcasename="hero" />
16
+
17
+
Qwik UI's Progress implementation follows the [WAI-Aria](https://www.w3.org/WAI/ARIA/apg/patterns/accordion/) design pattern, along with some additional API's that enhance the flexibility, types, and performance.
18
+
19
+
<FeatureList
20
+
features={['Provides context for assistive technology to read the progress of a task.']}
[Report an issue 🚨](https://github.com/qwikifiers/qwik-ui/issues)
27
+
28
+
[Edit This Page 🗒️](<https://github.com/qwikifiers/qwik-ui/edit/main/apps/website/src/routes/docs/headless/(components)/progress/index.mdx>)
29
+
30
+
</div>
31
+
32
+
> Rather than using the `details` and `summary` tags as disclosure widgets, we use a custom implementation. While these widgets can be used without JavaScript, they come with [their own accessibility drawbacks](https://www.scottohara.me/blog/2022/09/12/details-summary.html).
Adheres to the [progressbar role requirements](https://www.w3.org/WAI/ARIA/apg/patterns/meter/).
55
+
56
+
## API
57
+
58
+
### Root
59
+
60
+
Contains all of the progress parts.
61
+
62
+
<APITable
63
+
propDescriptors={[
64
+
{
65
+
name: 'class',
66
+
type: 'string',
67
+
description: 'CSS classes to apply to the Progress.',
68
+
},
69
+
{
70
+
name: 'value',
71
+
type: 'number',
72
+
description: 'The progress value.',
73
+
},
74
+
{
75
+
name: 'max',
76
+
type: 'number',
77
+
description: 'The maximum progress value',
78
+
},
79
+
{
80
+
name: 'getValueLabel',
81
+
type: 'function',
82
+
description:
83
+
'A function to get the accessible label text representing the current value in a human-readable format. If not provided, the value label will be read as the numeric value as a percentage of the max value.',
0 commit comments