Skip to content

Commit 456b40e

Browse files
committed
docs(spinner): add docs markdown and screenshot
1 parent 1bd76a7 commit 456b40e

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{% renderInstallation %} {% endrenderInstallation %}
2+
3+
{% renderOverview %}
4+
A spinner is an animated visual that indicates when a quick action is in progress.
5+
6+
<pf-v6-spinner accessible-label="Loading contents">Loading...</pf-v6-spinner>
7+
{% endrenderOverview %}
8+
9+
{% band header="Usage" %}
10+
### Basic
11+
{% htmlexample %}
12+
<pf-v6-spinner accessible-label="Loading contents">Loading...</pf-v6-spinner>
13+
{% endhtmlexample %}
14+
15+
### Size variations
16+
Use the `size` attribute to set the spinner size to `xs`, `sm`, `md`, `lg`, or `xl`.
17+
18+
{% htmlexample %}
19+
<pf-v6-spinner size="xs" accessible-label="Extra small spinner"></pf-v6-spinner>
20+
<pf-v6-spinner size="sm" accessible-label="Small spinner"></pf-v6-spinner>
21+
<pf-v6-spinner size="md" accessible-label="Medium spinner"></pf-v6-spinner>
22+
<pf-v6-spinner size="lg" accessible-label="Large spinner"></pf-v6-spinner>
23+
<pf-v6-spinner size="xl" accessible-label="Extra large spinner"></pf-v6-spinner>
24+
{% endhtmlexample %}
25+
26+
### Custom size
27+
Use the `--pf-v6-c-spinner--diameter` CSS custom property to set a custom size.
28+
29+
{% htmlexample %}
30+
<pf-v6-spinner style="--pf-v6-c-spinner--diameter: 80px;" accessible-label="Custom size spinner"></pf-v6-spinner>
31+
{% endhtmlexample %}
32+
33+
### Inline
34+
Set the `inline` attribute to inherit the font size from surrounding text.
35+
36+
{% htmlexample %}
37+
<p>Content is loading <pf-v6-spinner inline accessible-label="Loading"></pf-v6-spinner></p>
38+
{% endhtmlexample %}
39+
40+
{% endband %}
41+
42+
{% renderSlots %}{% endrenderSlots %}
43+
44+
{% renderAttributes %}{% endrenderAttributes %}
45+
46+
{% renderProperties %}{% endrenderProperties %}
47+
48+
{% renderMethods %}{% endrenderMethods %}
49+
50+
{% renderEvents %}{% endrenderEvents %}
51+
52+
{% renderCssCustomProperties %}{% endrenderCssCustomProperties %}
53+
54+
{% renderCssParts %}{% endrenderCssParts %}
7.52 KB
Loading

0 commit comments

Comments
 (0)