Skip to content

Commit 00d7fd2

Browse files
committed
docs: progerss circular
1 parent f702911 commit 00d7fd2

File tree

1 file changed

+19
-76
lines changed

1 file changed

+19
-76
lines changed

apps/docs/content/_components/progresscircular.md

Lines changed: 19 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -14,124 +14,67 @@
1414

1515
<Showcase showcase-name="ProgressCircular/ProgressCircularSizes" style="min-height:320px">
1616

17-
::vue-only
18-
<<<../../../preview/nuxt/pages/showcases/ProgressCircular/ProgressCircularSizes.vue
19-
::
20-
::react-only
21-
<<<../../../preview/next/pages/showcases/ProgressCircular/ProgressCircularSizes.tsx
22-
::
23-
::qwik-only
2417
<<<../../../website/src/routes/showcases/ProgressCircular/ProgressCircularSizes/index.tsx
25-
::
2618

2719
</Showcase>
2820

2921
### Customizing colors
3022

31-
By default, `SfProgressCircular` uses `primary-700` as the shape color (customizable by setting text color) and `neutral-300` for the background ring. You can change these values in your [Tailwind configuration](https://tailwindcss.com/docs/configuration#theme) or override them for a single-element using [`important modifier`](https://tailwindcss.com/docs/configuration#important-modifier).
23+
By default, `SfProgressCircular` uses `primary-700` as the shape color (customizable by setting text color) and `neutral-300` for the background ring.
3224

25+
<!--
26+
You can change these values in your [Tailwind configuration](https://tailwindcss.com/docs/configuration#theme) or override them for a single-element using [`important modifier`](https://tailwindcss.com/docs/configuration#important-modifier).
27+
-->
28+
29+
<!--
3330
::tip
3431
Learn more about [overriding default styles](/customization/overriding-default-styles) in Storefront UI.
3532
::
33+
-->
3634

3735
<Showcase showcase-name="ProgressCircular/ProgressCircularColors">
3836

39-
::vue-only
40-
<<<../../../preview/nuxt/pages/showcases/ProgressCircular/ProgressCircularColors.vue
41-
::
42-
::react-only
43-
<<<../../../preview/next/pages/showcases/ProgressCircular/ProgressCircularColors.tsx
44-
::
45-
::qwik-only
4637
<<<../../../website/src/routes/showcases/ProgressCircular/ProgressCircularColors/index.tsx
47-
::
4838

4939
</Showcase>
5040

5141
### With floating label
5242

53-
::vue-only
54-
You can add text to the center of the Progress Circle by providing content to the component via the `default` slot.
55-
::
56-
::react-only
57-
You can add text to the center of the Progress Circle by providing content to the component via the `children`.
58-
::
59-
::qwik-only
6043
You can add text to the center of the Progress Circle by providing content to the component via the `Slot`.
61-
::
6244

6345
::warning
6446
`SfProgressCircular` is built using an `svg`, so your content must be SVG-compatible.
6547
::
6648

6749
<Showcase showcase-name="ProgressCircular/ProgressCircularFloatingLabel">
6850

69-
::vue-only
70-
<<<../../../preview/nuxt/pages/showcases/ProgressCircular/ProgressCircularFloatingLabel.vue
71-
::
72-
::react-only
73-
<<<../../../preview/next/pages/showcases/ProgressCircular/ProgressCircularFloatingLabel.tsx
74-
::
75-
::qwik-only
7651
<<<../../../website/src/routes/showcases/ProgressCircular/ProgressCircularFloatingLabel/index.tsx
77-
::
7852

7953
</Showcase>
8054

55+
<!--
8156
## Accessibility notes
8257
8358
This component sets the `role="progressbar"` to [allow screen readers treat it as an indicator of progress status](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/progressbar_role).
59+
-->
8460

8561
## Playground
8662

87-
<Generate />
63+
<Generate class="playground" />
8864

8965
#tab-2
9066

9167
## Props
9268

93-
::vue-only
94-
| Prop name | Type | Default value | Possible values |
95-
|-----------------------|----------------------------|---------------|----------------------------------------|
96-
| `value` | `number` | `0` | |
97-
| `size` | `SfProgressSize` | `'base'` | `'xs'`,`'sm'`,`'base'`,`'lg'`,`'xl'`,`'2xl'`,`'3xl'`,`'4xl'` |
98-
| `ariaLabel` | `string` | `'Progress element'` |
99-
::
100-
::react-only
101-
| Prop name | Type | Default value | Possible values |
102-
|-----------------------|----------------------------|---------------|----------------------------------------|
103-
| `value` | `number` | `0` | |
104-
| `size` | `SfProgressSize` | `'base'` | `'xs'`,`'sm'`,`'base'`,`'lg'`,`'xl'`,`'2xl'`,`'3xl'`,`'4xl'` |
105-
| `ariaLabel` | `string` | `'Progress element'` |
106-
| `className` | `string` | | |
107-
| `children` | `ReactNode` | | Default slotted content |
108-
::
109-
::qwik-only
110-
| Prop name | Type | Default value | Possible values |
111-
|-----------------------|----------------------------|---------------|----------------------------------------|
112-
| `value` | `number` | `0` | |
113-
| `size` | `SfProgressSize` | `'base'` | `'xs'`,`'sm'`,`'base'`,`'lg'`,`'xl'`,`'2xl'`,`'3xl'`,`'4xl'` |
114-
| `ariaLabel` | `string` | `'Progress element'` |
115-
| `className` | `string` | | |
116-
| `children` | `ReactNode` | | Default slotted content |
117-
::
118-
119-
::vue-only
69+
| Prop name | Type | Default value | Possible values |
70+
| ------------ | ---------------- | -------------------- | ------------------------------------------------------------ |
71+
| `class?` | `string` | | |
72+
| `value?` | `number` | `0` | |
73+
| `size?` | `SfProgressSize` | `'base'` | `'xs'`,`'sm'`,`'base'`,`'lg'`,`'xl'`,`'2xl'`,`'3xl'`,`'4xl'` |
74+
| `ariaLabel?` | `string` | `'Progress element'` |
12075

12176
## Slots
12277

123-
| Slot name | Description |
124-
| --------- | ------------------------------- |
125-
| `default` | adds content within svg element |
126-
127-
::
128-
129-
#tab-3
130-
::vue-only
131-
<<<../../../../packages/sfui/frameworks/vue/components/SfProgressCircular/SfProgressCircular.vue
132-
::
133-
::react-only
134-
<<<../../../../packages/sfui/frameworks/react/components/SfProgressCircular/SfProgressCircular.tsx
135-
::
136-
137-
::
78+
| Slot name | Description |
79+
| --------- | --------------- |
80+
| `default` | Slotted content |

0 commit comments

Comments
 (0)