Skip to content

Commit e91e09f

Browse files
committed
docs(banner): missing docs markdown and screenshot
1 parent facd520 commit e91e09f

2 files changed

Lines changed: 43 additions & 0 deletions

File tree

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{% renderOverview %}
2+
A banner provides a full-width container for communicating short,
3+
non-dismissible messages.
4+
5+
<pf-v6-banner>Default banner</pf-v6-banner>
6+
{% endrenderOverview %}
7+
8+
{% band header="Usage" %}
9+
### Default
10+
{% htmlexample %}
11+
<pf-v6-banner>Default banner</pf-v6-banner>
12+
{% endhtmlexample %}
13+
14+
### Status
15+
When a banner conveys status, use the `status` attribute. Include an icon
16+
and `screen-reader-text` for accessibility.
17+
18+
{% htmlexample %}
19+
<pf-v6-banner status="danger" screen-reader-text="Danger banner">
20+
Danger banner
21+
</pf-v6-banner>
22+
{% endhtmlexample %}
23+
24+
### Sticky
25+
Use the `sticky` attribute to keep the banner visible at the top of a
26+
scrolling container.
27+
28+
{% htmlexample %}
29+
<pf-v6-banner sticky>Sticky banner</pf-v6-banner>
30+
{% endhtmlexample %}
31+
{% endband %}
32+
33+
{% renderSlots %}{% endrenderSlots %}
34+
35+
{% renderAttributes %}{% endrenderAttributes %}
36+
37+
{% renderMethods %}{% endrenderMethods %}
38+
39+
{% renderEvents %}{% endrenderEvents %}
40+
41+
{% renderCssCustomProperties %}{% endrenderCssCustomProperties %}
42+
43+
{% renderCssParts %}{% endrenderCssParts %}
45.8 KB
Loading

0 commit comments

Comments
 (0)