Skip to content

Commit

Permalink
docs: replace "Sample component" title (#1263)
Browse files Browse the repository at this point in the history
docs: replace "Sample component" title with "Sample element" or "Sample pattern"
  • Loading branch information
marionnegp authored Oct 18, 2023
1 parent fcd098a commit 218e703
Show file tree
Hide file tree
Showing 25 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/patterns/card/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A card formats content in a small, contained space. It can be used to display a
preview of information or provide secondary content in relation to the content
it's near. Several cards can be used together to group related information.

## Sample
## Sample pattern

<rh-card>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam eleifend
Expand Down
2 changes: 1 addition & 1 deletion docs/patterns/disclosure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A Disclosure toggles the visibility of sections of content. It features one
panel that consists of a caret icon and a section text label that collapses or
expands to reveal more information.

## Sample component
## Sample pattern

<rh-accordion>
<rh-accordion-header>
Expand Down
2 changes: 1 addition & 1 deletion docs/patterns/filter/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

A Filter gives users the ability to sort a results listing by turning on and off predetermined tags. They feature a list of checkboxes and text that are wrapped in an accordion or a disclosure.

## Sample Component
## Sample pattern

<div class="multi-column--300-wide"><div>
{% example palette="none",
Expand Down
2 changes: 1 addition & 1 deletion docs/patterns/form/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

A Form is a group of elements used to collect information from a user. It can include a combination of text, fields, select lists, data inputs, buttons, and more.

## Sample component
## Sample pattern
{% example palette="none",
alt="Form component samples",
src="./form-samples.svg" %}
Expand Down
2 changes: 1 addition & 1 deletion docs/patterns/link-with-icon/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags:

Link with icon features an icon that adds context to the link itself. It’s positioned to the left or on top of a link, depending on orientation.

## Sample component
## Sample pattern

{% example palette="none",
alt="Link with icon",
Expand Down
2 changes: 1 addition & 1 deletion docs/patterns/link/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags:

Links are navigational elements that allow a user to move between content, pages, and websites.

## Sample component
## Sample pattern

{% example palette="none",
alt="Link component examples",
Expand Down
2 changes: 1 addition & 1 deletion docs/patterns/skip-navigation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

Skip navigation is a styled link that appears at the top of a page when the Tab key is pressed. It bypasses the navigation and jumps users down to the main content when selected.

## Sample component
## Sample pattern

{% example palette="none",
           alt="Skip navigation",
Expand Down
2 changes: 1 addition & 1 deletion docs/patterns/sticky-banner/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

A Sticky banner slides into view at a certain scroll position and then anchors itself to the bottom edge of a browser window. It stays in one place as content scrolls underneath until a user dismisses them.

## Sample component
## Sample pattern
{% example palette="none",
alt="Sticky banner",
src="./sticky-banner.svg" %}
Expand Down
2 changes: 1 addition & 1 deletion docs/patterns/sticky-card/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

Sticky cards slide into view at a certain scroll position and then anchor themselves to the edge of a browser window. They stay in one place as content scrolls underneath until a user dismisses them.

## Sample component
## Sample pattern
{% example palette="none",
alt="Sticky card",
src="./sticky-card.svg" %}
Expand Down
2 changes: 1 addition & 1 deletion docs/patterns/video-thumbnail/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

A Video thumbnail is a graphical preview of a video overlayed with a play button. When it’s selected, a video player modal will be displayed so a user can watch the video at a larger size.

## Sample component
## Sample pattern
{% example palette="none",
alt="Video thumbnail",
src="./video-thumbnail.svg" %}
Expand Down
2 changes: 1 addition & 1 deletion elements/rh-accordion/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
alt="An accordion with four collapsed panels and one expanded panel",
src="./accordion-sample-element.png" %}

## Sample component
## Sample element

<rh-accordion>
<rh-accordion-header>
Expand Down
2 changes: 1 addition & 1 deletion elements/rh-alert/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{{ tagName | getElementDescription }}


## Sample component
## Sample element
{% example palette="light",
alt="Two examples of the alert element",
src="alert-sample.svg" %}
Expand Down
2 changes: 1 addition & 1 deletion elements/rh-audio-player/docs/00-overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Overview
{{ tagName | getElementDescription }}

## Sample component
## Sample element
<h3 hidden></h3>

<rh-audio-player lang="en-US"
Expand Down
2 changes: 1 addition & 1 deletion elements/rh-avatar/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
src="./avatar-sample.png" %}


## Sample component
## Sample element

<rh-avatar></rh-avatar>

Expand Down
2 changes: 1 addition & 1 deletion elements/rh-badge/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
src="./badge-sample-element.png" %}


## Sample component
## Sample element
<rh-badge number="1" aria-label="1 new message">1</rh-badge>
<rh-badge number="99" state="info" aria-label="99 details">99</rh-badge>
<rh-badge number="100" threshold="99" state="moderate" aria-label="99+ details">100</rh-badge>
Expand Down
2 changes: 1 addition & 1 deletion elements/rh-button/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
src="./button-sample.png" %}


## Sample component
## Sample element
<rh-button>Primary</rh-button>


Expand Down
2 changes: 1 addition & 1 deletion elements/rh-card/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{{ tagName | getElementDescription }}


## Sample component
## Sample element
{% example palette="light",
width=360,
alt="Example of a card element",
Expand Down
2 changes: 1 addition & 1 deletion elements/rh-footer/docs/00-overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Overview
{{ tagName | getElementDescription }}

## Sample component
## Sample element
<rh-footer data-analytics-region="page-footer">
<a slot="logo" href="https://redhat.com/en" data-analytics-category="Footer" data-analytics-text="Logo">
<img alt="Red Hat logo" src="https://static.redhat.com/libs/redhat/brand-assets/2/corp/logo--on-dark.svg" loading="lazy" />
Expand Down
2 changes: 1 addition & 1 deletion elements/rh-jump-links/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
is visible in the browser window.


## Sample component
## Sample element

![Jump links sample component]({{ './jump-links-sample.svg' |
url }}){style="--inline-img-max-width:128px;"}
Expand Down
2 changes: 1 addition & 1 deletion elements/rh-navigation-secondary/docs/00-overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Overview
{{ tagName | getElementDescription }}

## Sample component
## Sample element

{% example palette="light",
alt="Image of two stacked secondary navigations; one for large breakpoints and the other for small breakpoints",
Expand Down
2 changes: 1 addition & 1 deletion elements/rh-navigation/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
every page to ensure a consistent user experience across websites.


## Sample component
## Sample element
![Primary navigation component sample]({{ './primary-nav-example.png' | url
}}){style="--inline-img-max-width:1000px;"}

Expand Down
2 changes: 1 addition & 1 deletion elements/rh-popover/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
information or provides resources via text and links.


## Sample component
## Sample element
![Popover component sample]({{ './popover-sample-component.svg'
| url }}){style="--inline-img-max-width:424px;"}

Expand Down
2 changes: 1 addition & 1 deletion elements/rh-progress-steps/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
toward the completion of a linear process.


## Sample component
## Sample element
![Progress steps component sample]({{
'./progress-steps-sample.svg' | url
}}){style="--inline-img-max-width:687px;"}
Expand Down
2 changes: 1 addition & 1 deletion elements/rh-spinner/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@



## Sample component
## Sample element
<rh-spinner>Loading...</rh-spinner>


Expand Down
2 changes: 1 addition & 1 deletion elements/rh-tooltip/docs/00-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
alt=" A black tooltip on top of a gray disabled button",
src="./tooltip-sample-element.png" %}

## Sample component
## Sample element
<p>
<rh-tooltip position="top">
<rh-button>Top Tooltip</rh-button>
Expand Down

0 comments on commit 218e703

Please sign in to comment.