diff --git a/docs/_data/repoStatus.yaml b/docs/_data/repoStatus.yaml
index c7216448b5..83c1ba258f 100644
--- a/docs/_data/repoStatus.yaml
+++ b/docs/_data/repoStatus.yaml
@@ -1,4 +1,5 @@
-- name: "Accordion"
+- tagName: rh-accordion
+ name: "Accordion"
type: "Element"
overallStatus: "Available"
libraries:
@@ -6,11 +7,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Alert"
+- tagName: rh-alert
+ name: "Alert"
type: "Element"
overallStatus: "Available"
libraries:
@@ -18,11 +20,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Audio Player"
+- tagName: rh-audio-player
+ name: "Audio Player"
type: "Element"
overallStatus: "Available"
libraries:
@@ -30,11 +33,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Avatar"
+- tagName: rh-avatar
+ name: "Avatar"
type: "Element"
overallStatus: "Available"
libraries:
@@ -42,11 +46,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Back To Top"
+- tagName: rh-back-to-top
+ name: "Back To Top"
type: "Element"
overallStatus: "Available"
libraries:
@@ -54,11 +59,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Planned
- name: Documentation
status: In Progress
-- name: "Badge"
+- tagName: rh-badge
+ name: "Badge"
type: "Element"
overallStatus: "Available"
libraries:
@@ -66,11 +72,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Blockquote"
+- tagName: rh-blockquote
+ name: "Blockquote"
type: "Element"
overallStatus: "Available"
libraries:
@@ -78,11 +85,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Breadcrumb"
+- tagName: rh-breadcrumb
+ name: "Breadcrumb"
type: "Element"
overallStatus: "Available"
libraries:
@@ -90,11 +98,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Button"
+- tagName: rh-button
+ name: "Button"
type: "Element"
overallStatus: "Available"
libraries:
@@ -102,11 +111,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Cta"
+- tagName: rh-cta
+ name: "Cta"
type: "Element"
overallStatus: "Available"
libraries:
@@ -114,11 +124,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Card"
+- tagName: rh-card
+ name: "Card"
type: "Element"
overallStatus: "Available"
libraries:
@@ -126,11 +137,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Code Block"
+- tagName: rh-code-block
+ name: "Code Block"
type: "Element"
overallStatus: "Available"
libraries:
@@ -138,11 +150,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Dialog"
+- tagName: rh-dialog
+ name: "Dialog"
type: "Element"
overallStatus: "Available"
libraries:
@@ -150,11 +163,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Footer"
+- tagName: rh-footer
+ name: "Footer"
type: "Element"
overallStatus: "Available"
libraries:
@@ -162,11 +176,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Health Index"
+- tagName: rh-health-index
+ name: "Health Index"
type: "Element"
overallStatus: "Available"
libraries:
@@ -174,11 +189,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Planned
- name: Documentation
status: Ready
-- name: "Jumplinks"
+- tagName: rh-jump-links
+ name: "Jumplinks"
type: "Element"
overallStatus: "Available"
libraries:
@@ -186,11 +202,12 @@
status: N/A
- name: RH Elements
status: N/A
- - name: WebRH
+ - name: RH Shared Libs
status: N/A
- name: Documentation
status: Ready
-- name: "Navigation Secondary"
+- tagName: rh-navigation-secondary
+ name: "Navigation Secondary"
type: "Element"
overallStatus: "Available"
libraries:
@@ -198,11 +215,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Pagination"
+- tagName: rh-pagination
+ name: "Pagination"
type: "Element"
overallStatus: "Available"
libraries:
@@ -210,23 +228,38 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Popover"
+- tagName: rh-popover
+ name: "Popover"
type: "Element"
overallStatus: "Available"
libraries:
- name: Figma library
status: Ready
- name: RH Elements
+ status: Planned
+ - name: RH Shared Libs
+ status: Planned
+ - name: Documentation
status: Ready
- - name: WebRH
+- tagName: rh-progress-steps
+ name: "Progess Steps"
+ type: "Element"
+ overallStatus: "Available"
+ libraries:
+ - name: Figma library
status: Ready
+ - name: RH Elements
+ status: Planned
+ - name: RH Shared Libs
+ status: Planned
- name: Documentation
- status: Ready
-- name: "Skip Link"
+ status: Ready
+- tagName: rh-skip-link
+ name: "Skip Link"
type: "Element"
overallStatus: "New"
libraries:
@@ -234,11 +267,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Planned
- name: Documentation
status: Ready
-- name: "Site Status"
+- tagName: rh-site-status
+ name: "Site Status"
type: "Element"
overallStatus: "New"
libraries:
@@ -246,11 +280,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Planned
- name: Documentation
status: Ready
-- name: "Spinner"
+- tagName: rh-spinner
+ name: "Spinner"
type: "Element"
overallStatus: "Available"
libraries:
@@ -258,11 +293,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Stat"
+- tagName: rh-stat
+ name: "Stat"
type: "Element"
overallStatus: "Available"
libraries:
@@ -270,11 +306,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Subnav"
+- tagName: rh-subnav
+ name: "Subnav"
type: "Element"
overallStatus: "Available"
libraries:
@@ -282,11 +319,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Surface"
+- tagName: rh-surface
+ name: "Surface"
type: "Element"
overallStatus: "New"
libraries:
@@ -294,11 +332,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Switch"
+- tagName: rh-switch
+ name: "Switch"
type: "Element"
overallStatus: "New"
libraries:
@@ -306,11 +345,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Planned
- name: Documentation
status: Ready
-- name: "Table"
+- tagName: rh-table
+ name: "Table"
type: "Element"
overallStatus: "New"
libraries:
@@ -318,11 +358,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Tabs"
+- tagName: rh-tabs
+ name: "Tabs"
type: "Element"
overallStatus: "Available"
libraries:
@@ -330,11 +371,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Tag"
+- tagName: rh-tag
+ name: "Tag"
type: "Element"
overallStatus: "Available"
libraries:
@@ -342,11 +384,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Tile"
+- tagName: rh-tile
+ name: "Tile"
type: "Element"
overallStatus: "New"
libraries:
@@ -354,11 +397,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Timestamp"
+- tagName: rh-timestamp
+ name: "Timestamp"
type: "Element"
overallStatus: "Available"
libraries:
@@ -366,11 +410,12 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
status: Ready
-- name: "Tooltip"
+- tagName: rh-tooltip
+ name: "Tooltip"
type: "Element"
overallStatus: "Available"
libraries:
@@ -378,7 +423,7 @@
status: Ready
- name: RH Elements
status: Ready
- - name: WebRH
+ - name: RH Shared Libs
status: Ready
- name: Documentation
- status: Ready
\ No newline at end of file
+ status: Ready
diff --git a/docs/_plugins/cem-shortcodes.cjs b/docs/_plugins/cem-shortcodes.cjs
index c68483dc59..2ed89054d7 100644
--- a/docs/_plugins/cem-shortcodes.cjs
+++ b/docs/_plugins/cem-shortcodes.cjs
@@ -90,7 +90,7 @@ class Renderers {
* @see https://github.com/11ty/eleventy/blob/bf7c0c0cce1b2cb01561f57fdd33db001df4cb7e/src/Plugins/RenderPlugin.js#L89-L93
* @type {DocsPage}
*/
- this.docsPage = page.ctx._;
+ this.docsPage = page.ctx.doc;
this.manifest = this.docsPage.manifest;
Renderers.renderers.set(page, this);
}
diff --git a/docs/_plugins/rhds.cjs b/docs/_plugins/rhds.cjs
index 6398bd37e1..9879a0b4b8 100644
--- a/docs/_plugins/rhds.cjs
+++ b/docs/_plugins/rhds.cjs
@@ -189,6 +189,13 @@ module.exports = function(eleventyConfig, { tagsToAlphabetize }) {
return content;
});
+ eleventyConfig.addFilter('getPrettyElementName', function(tagName) {
+ const { pfeconfig } = eleventyConfig?.globalData ?? {};
+ const slug = getTagNameSlug(tagName, pfeconfig);
+ const deslugify = eleventyConfig.getFilter('deslugify');
+ return pfeconfig.aliases[tagName] || deslugify(slug);
+ });
+
eleventyConfig.addFilter('getTitleFromDocs', function(docs) {
return docs.find(x => x.docsPage?.title)?.alias
?? docs[0]?.alias
@@ -204,7 +211,7 @@ module.exports = function(eleventyConfig, { tagsToAlphabetize }) {
* @see https://github.com/11ty/eleventy/blob/bf7c0c0cce1b2cb01561f57fdd33db001df4cb7e/src/Plugins/RenderPlugin.js#L89-L93
* @type {import('@patternfly/pfe-tools/11ty/DocsPage.js').DocsPage}
*/
- const docsPage = this.ctx._;
+ const docsPage = this.ctx.doc;
return docsPage.description;
});
@@ -303,18 +310,22 @@ module.exports = function(eleventyConfig, { tagsToAlphabetize }) {
try {
const { glob } = await import('glob');
- /** @type {(import('@patternfly/pfe-tools/11ty/DocsPage').DocsPage & { repoStatus?: any[] })[]} */
- const elements = await eleventyConfig.globalData?.elements();
+ const { DocsPage } = await import('@patternfly/pfe-tools/11ty/DocsPage.js');
+ const {
+ Manifest,
+ } = await import('@patternfly/pfe-tools/custom-elements-manifest/lib/Manifest.js');
+
+ const customElementsManifestDocsPages = await eleventyConfig.globalData?.elements();
const filePaths = (await glob(`elements/*/docs/*.md`, { cwd: process.cwd() }))
.filter(x => x.match(/\d{1,3}-[\w-]+\.md$/)); // only include new style docs
- const { repoStatus } = collectionApi.items.find(item => item.data?.repoStatus)?.data || [];
+
return filePaths
.map(filePath => {
const props = getProps(filePath);
- const docsPage = elements.find(x => x.tagName === props.tagName);
- if (docsPage) {
- docsPage.repoStatus = repoStatus;
- }
+ const [manifest] = Manifest.getAll();
+ const docsPage =
+ customElementsManifestDocsPages.find(x => x.tagName === props.tagName)
+ ?? new DocsPage(manifest);
const tabs = filePaths
.filter(x => x.split('/docs/').at(0) === (`elements/${props.tagName}`))
.sort()
diff --git a/docs/_plugins/shortcodes/renderCodeDocs.cjs b/docs/_plugins/shortcodes/renderCodeDocs.cjs
index 8da5f30624..6d86782718 100644
--- a/docs/_plugins/shortcodes/renderCodeDocs.cjs
+++ b/docs/_plugins/shortcodes/renderCodeDocs.cjs
@@ -9,14 +9,13 @@ const html = (...args) =>
.map(x => x.replace(/^ {6}/, ''))
.join('\n');
-/** @typedef {import('@patternfly/pfe-tools/11ty/DocsPage').DocsPage} DocsPage */
module.exports = function(eleventyConfig) {
- eleventyConfig.addPairedShortcode('renderCodeDocs',
- function renderCodeDocs(content, kwargs = {}) {
- const renderers = new Renderers(this, kwargs);
- return renderers.renderAll(content);
- }
- );
+ eleventyConfig
+ .addPairedShortcode('renderCodeDocs', function renderCodeDocs(content, kwargs = {}) {
+ const page = this.context?.doc ?? this.ctx;
+ const renderers = new Renderers(page, kwargs);
+ return renderers.renderAll(content);
+ });
};
function innerMD(content = '') {
@@ -49,9 +48,8 @@ class Renderers {
* NB: since the data for this shortcode is no a POJO,
* but a DocsPage instance, 11ty assigns it to this.ctx._
* @see https://github.com/11ty/eleventy/blob/bf7c0c0cce1b2cb01561f57fdd33db001df4cb7e/src/Plugins/RenderPlugin.js#L89-L93
- * @type {DocsPage}
*/
- this.docsPage = page.ctx._;
+ this.docsPage = page.doc.docsPage;
this.manifest = this.docsPage.manifest;
this.kwargs = kwargs;
}
diff --git a/docs/_plugins/shortcodes/renderInstallation.cjs b/docs/_plugins/shortcodes/renderInstallation.cjs
index 5592d892a4..d6eadd30be 100644
--- a/docs/_plugins/shortcodes/renderInstallation.cjs
+++ b/docs/_plugins/shortcodes/renderInstallation.cjs
@@ -13,7 +13,7 @@ function renderInstall(content, {
* @see https://github.com/11ty/eleventy/blob/bf7c0c0cce1b2cb01561f57fdd33db001df4cb7e/src/Plugins/RenderPlugin.js#L89-L93
* @type {DocsPage}
*/
- const docsPage = this.ctx._;
+ const docsPage = this.ctx.doc;
const lightdomcssblock = /* md */`
### Lightdom CSS
diff --git a/docs/_plugins/shortcodes/repoStatus.cjs b/docs/_plugins/shortcodes/repoStatus.cjs
index b4233bfe65..b919053692 100644
--- a/docs/_plugins/shortcodes/repoStatus.cjs
+++ b/docs/_plugins/shortcodes/repoStatus.cjs
@@ -70,38 +70,31 @@ const STATUS_CHECKLIST = {
'Deprecated': 'Component is no longer available in the RH Elements repo',
'N/A': 'Not planned, not available, or does not apply',
},
- 'WebRH': {
- 'Ready': 'Component is available in the WebRH repo',
- 'In progress': 'Component will be added to the WebRH repo when finished',
- 'Planned': 'Component should be added to the WebRH repo at a later date',
- 'Deprecated': 'Component is no longer available in the WebRH repo',
+ 'RH Shared Libs': {
+ 'Ready': 'Component is available in the RH Shared Libs repo',
+ 'In progress': 'Component will be added to the RH Shared Libs repo when finished',
+ 'Planned': 'Component should be added to the RH Shared Libs repo at a later date',
+ 'Deprecated': 'Component is no longer available in the RH Shared Libs repo',
'N/A': 'Not planned, not available, or does not apply',
},
};
-/**
- * Reads repo status data from global data and outputs an array with component keys
- */
-function getRepoData() {
- const docsPage = this.ctx._;
- const allStatuses = this.ctx.repoStatus ?? docsPage?.repoStatus ?? [];
- const title = this.ctx.title ?? docsPage?.title;
- return allStatuses.find(
- component => component.name === title && component.type === 'Element'
- )?.libraries;
-}
-
/**
* Calls getRepoData function and outputs a definition list for each component
* @param {object} [options] list heading render options
* @param {string} [options.heading] heading text
* @param {number} [options.level] heading level
*/
-function repoStatusList({ heading = 'Status', level = 2 } = {}) {
+function repoStatusList({ repoStatus, heading = 'Status', level = 2 } = {}) {
// Removing Documentation status from the repoStatusList
- const statusList = getRepoData.call(this)?.filter(repo => repo.name !== 'Documentation');
+ const librariesList = this.ctx.doc ?
+ repoStatus.find(x => x.tagName === this.ctx.doc.tagName)
+ ?.libraries?.filter(repo =>
+ repo.name !== 'Documentation')
+ : repoStatus.flatMap(x => x.libraries) ?? [];
- if (!Array.isArray(statusList) || !statusList.length) {
+
+ if (!Array.isArray(librariesList) || !librariesList.length) {
return '';
} else {
return html`
@@ -112,7 +105,7 @@ function repoStatusList({ heading = 'Status', level = 2 } = {}) {
What do these mean?
-
${statusList.map(listItem => html`
+ ${librariesList.map(listItem => html`
- ${listItem.name}:
-
@@ -129,14 +122,8 @@ function repoStatusList({ heading = 'Status', level = 2 } = {}) {
/**
* Reads component status data from global data (see above) and outputs a table for Design/Code status page
*/
-function repoStatusTable() {
- const docsPage = this.ctx._;
- const allStatuses = this.ctx.repoStatus ?? docsPage?.repoStatus ?? [];
- // Filtering out 'Responsive' status from all the libraries
- const elementsList = allStatuses.map(item => ({
- ...item,
- libraries: item.libraries.filter(lib => lib.name !== 'Responsive'),
- }));
+function repoStatusTable({ repoStatus }) {
+ const elementsList = repoStatus;
if (!Array.isArray(elementsList) || !elementsList.length) {
return '';
@@ -157,7 +144,7 @@ function repoStatusTable() {
Name |
Figma library |
RH Elements |
- WebRH |
+ RH Shared Libs |
Documentation |
@@ -188,8 +175,14 @@ function repoStatusTable() {
* @param {string} [options.heading] heading text
* @param {number} [options.level] heading level
*/
-function repoStatusChecklist({ heading = 'Status checklist', level = 2 } = {}) {
- const statusList = getRepoData.call(this)?.filter(repo => repo.name !== 'Documentation');
+function repoStatusChecklist({ repoStatus, heading = 'Status checklist', level = 2 } = {}) {
+ // is repoStatus returning undefined ?
+ const statusList = this.ctx.doc ?
+ repoStatus.find(x => x.tagName === this.ctx.doc.tagName)
+ ?.libraries?.filter(repo =>
+ repo.name !== 'Documentation')
+ : repoStatus.flatMap(x => x.libraries) ?? [];
+
if (!Array.isArray(statusList) || !statusList.length) {
return '';
} else {
diff --git a/docs/design-code-status/index.md b/docs/design-code-status/index.md
index 16c0edc930..a8015627e0 100644
--- a/docs/design-code-status/index.md
+++ b/docs/design-code-status/index.md
@@ -123,7 +123,7 @@ A detailed synopsis of our web components and their implementation status.
## Web component status
-{% repoStatusTable %}
+{% repoStatusTable repoStatus=repoStatus %}
diff --git a/docs/elements/elements.html b/docs/elements/elements.html
index a60be03e8b..ffe0518d26 100644
--- a/docs/elements/elements.html
+++ b/docs/elements/elements.html
@@ -1,11 +1,19 @@
+---js
+{
+ templateEngineOverride: 'njk',
+ hasToc: true,
+ layout: 'layouts/pages/elements.njk',
+ permalink: '{{ doc.permalink }}',
+ pagination: {
+ data: 'collections.elementDocs',
+ alias: 'doc',
+ size: 1,
+ },
+ eleventyComputed: {
+ context(data) {
+ return data;
+ },
+ },
+}
---
-templateEngineOverride: njk
-hasToc: true
-layout: layouts/pages/elements.njk
-permalink: "{{ doc.permalink }}"
-pagination:
- data: collections.elementDocs
- alias: doc
- size: 1
----
-{% renderFile doc.filePath, doc.docsPage %}
+{% renderFile doc.filePath, context %}
diff --git a/docs/elements/index.njk b/docs/elements/index.njk
index 2060ade7bd..c4d578b611 100644
--- a/docs/elements/index.njk
+++ b/docs/elements/index.njk
@@ -38,7 +38,7 @@ importElements:
{%- for tagName, docs in collections.elementDocs | groupby('tagName') -%}
{%- set doc = docs[0] -%}
{%- set slug = doc.slug -%}
- {%- set title = docs | getTitleFromDocs | makeSentenceCase -%}
+ {%- set title = tagName | getPrettyElementName | makeSentenceCase -%}
{%- set comingSoon = tagName in comingSoonItems -%}
{%- set summary = doc.docsPage.summary -%}
{% if not summary %}
diff --git a/elements/rh-accordion/docs/00-overview.md b/elements/rh-accordion/docs/00-overview.md
index 5e8a5f7bd0..84cf599435 100644
--- a/elements/rh-accordion/docs/00-overview.md
+++ b/elements/rh-accordion/docs/00-overview.md
@@ -5,7 +5,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -68,4 +68,4 @@
- When you need to condense a large amount of related information into sections
- When you need a way for users to read or compare sections of content simultaneously
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-alert/docs/00-overview.md b/elements/rh-alert/docs/00-overview.md
index 3966a6f6c9..f63b6e7933 100644
--- a/elements/rh-alert/docs/00-overview.md
+++ b/elements/rh-alert/docs/00-overview.md
@@ -2,7 +2,7 @@
{{ tagName | getElementDescription }}
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -20,4 +20,4 @@
[img-sample]: {{ './alert-sample.svg' | url }}
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-audio-player/docs/00-overview.md b/elements/rh-audio-player/docs/00-overview.md
index 8bbe36c1a8..8721460864 100644
--- a/elements/rh-audio-player/docs/00-overview.md
+++ b/elements/rh-audio-player/docs/00-overview.md
@@ -2,7 +2,7 @@
{{ tagName | getElementDescription }}
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -2637,4 +2637,4 @@
- When you want to feature audio content without directing users to other pages
- When you want to offer users with reduced hearing abilities a listening alternative using a transcript
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-avatar/docs/00-overview.md b/elements/rh-avatar/docs/00-overview.md
index dd414d6682..4a55da0eaa 100644
--- a/elements/rh-avatar/docs/00-overview.md
+++ b/elements/rh-avatar/docs/00-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -17,5 +17,5 @@
- When you need to represent a user who has not provided a photo or image
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-back-to-top/docs/00-overview.md b/elements/rh-back-to-top/docs/00-overview.md
index 10bdeb23a9..7971c676ad 100644
--- a/elements/rh-back-to-top/docs/00-overview.md
+++ b/elements/rh-back-to-top/docs/00-overview.md
@@ -7,7 +7,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample
@@ -19,4 +19,4 @@ View the [demos](demos/).
- When content fills up more than two screens in length at medium and large breakpoints
- When content fills up more than four screens in length at small breakpoints
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-badge/docs/00-overview.md b/elements/rh-badge/docs/00-overview.md
index 39ebb9b363..50fdabfd00 100644
--- a/elements/rh-badge/docs/00-overview.md
+++ b/elements/rh-badge/docs/00-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -23,4 +23,4 @@
- When you need to reflect counts like number of objects, events, or unread items
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-blockquote/docs/00-overview.md b/elements/rh-blockquote/docs/00-overview.md
index 8307bd315d..beea53786c 100644
--- a/elements/rh-blockquote/docs/00-overview.md
+++ b/elements/rh-blockquote/docs/00-overview.md
@@ -2,7 +2,7 @@
A blockquote is a styled quotation and citation offset from other text styles on the page.
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -34,5 +34,5 @@ View a live version of this component and see how it can be customized.
- When you need to break up large portions of text
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-breadcrumb/docs/00-overview.md b/elements/rh-breadcrumb/docs/00-overview.md
index a8b1665f15..2c9e3a68f0 100644
--- a/elements/rh-breadcrumb/docs/00-overview.md
+++ b/elements/rh-breadcrumb/docs/00-overview.md
@@ -8,7 +8,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -28,4 +28,4 @@
- When you want to help orient a user and and show where they are in the page hierarchy
- When you want to provide a secondary method for navigating to parent pages of the current page
-{% repoStatusChecklist %}
\ No newline at end of file
+{% repoStatusChecklist repoStatus=repoStatus %}
\ No newline at end of file
diff --git a/elements/rh-button/docs/00-overview.md b/elements/rh-button/docs/00-overview.md
index 2b7b8db205..b42a00a867 100644
--- a/elements/rh-button/docs/00-overview.md
+++ b/elements/rh-button/docs/00-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -19,4 +19,4 @@
- When you need to communicate actions users can take
- When you need to draw attention to the highest priority action
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-card/docs/00-overview.md b/elements/rh-card/docs/00-overview.md
index 58f99eb8f7..fcb8b87624 100644
--- a/elements/rh-card/docs/00-overview.md
+++ b/elements/rh-card/docs/00-overview.md
@@ -2,7 +2,7 @@
{{ tagName | getElementDescription }}
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -11,4 +11,4 @@
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-code-block/docs/10-overview.md b/elements/rh-code-block/docs/10-overview.md
index 51f73e1230..82a9b1710b 100644
--- a/elements/rh-code-block/docs/10-overview.md
+++ b/elements/rh-code-block/docs/10-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -28,4 +28,4 @@
- When you need to highlight a block of code while maintaining the formatting
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-cta/docs/00-overview.md b/elements/rh-cta/docs/00-overview.md
index ea3350c100..8708980268 100644
--- a/elements/rh-cta/docs/00-overview.md
+++ b/elements/rh-cta/docs/00-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -19,4 +19,4 @@
- When you need to arrange links in different arrangements like in a row or grid
- When you need to hide or reveal content
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-dialog/docs/00-overview.md b/elements/rh-dialog/docs/00-overview.md
index 04bba87792..ec6f4a11db 100644
--- a/elements/rh-dialog/docs/00-overview.md
+++ b/elements/rh-dialog/docs/00-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -26,4 +26,4 @@
- When you need an immediate response from users
- When you need to notify users of urgent information concerning their current workflow
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-footer/docs/00-overview.md b/elements/rh-footer/docs/00-overview.md
index d64c4d18f0..2673d72396 100644
--- a/elements/rh-footer/docs/00-overview.md
+++ b/elements/rh-footer/docs/00-overview.md
@@ -2,7 +2,7 @@
{{ tagName | getElementDescription }}
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -89,4 +89,4 @@
- When you want to give users persistent access to secondary content outside of the navigation
- When you need a place to put copyright or legal information
- {% repoStatusChecklist %}
+ {% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-health-index/docs/00-overview.md b/elements/rh-health-index/docs/00-overview.md
index 0e6c19e89c..ad34a6f0f5 100644
--- a/elements/rh-health-index/docs/00-overview.md
+++ b/elements/rh-health-index/docs/00-overview.md
@@ -7,7 +7,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -22,4 +22,4 @@
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-navigation-secondary/docs/00-overview.md b/elements/rh-navigation-secondary/docs/00-overview.md
index a7a429bd40..73d627e685 100644
--- a/elements/rh-navigation-secondary/docs/00-overview.md
+++ b/elements/rh-navigation-secondary/docs/00-overview.md
@@ -2,7 +2,7 @@
{{ tagName | getElementDescription }}
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -17,4 +17,4 @@
- When you need to prevent other navigations from getting overloaded
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-pagination/docs/00-overview.md b/elements/rh-pagination/docs/00-overview.md
index 3fd1e3bcd7..c13c6ad06e 100644
--- a/elements/rh-pagination/docs/00-overview.md
+++ b/elements/rh-pagination/docs/00-overview.md
@@ -24,4 +24,4 @@
- When you need to enable users to navigate to through pages or locate a specific page number
- When you need to improve the loading performance of a system
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-popover/docs/00-overview.md b/elements/rh-popover/docs/00-overview.md
index 96cffb5a3c..02cdcb6e74 100644
--- a/elements/rh-popover/docs/00-overview.md
+++ b/elements/rh-popover/docs/00-overview.md
@@ -1,14 +1,15 @@
-## Coming soon!
-
-This element is currently in progress and not yet available for use.
-
## Overview
A Popover displays content in a non-modal dialog and adds contextual
information or provides resources via text and links.
+{% repoStatusList repoStatus=repoStatus %}
+
## Sample element
+
+
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-popover/docs/30-code.md b/elements/rh-popover/docs/30-code.md
new file mode 100644
index 0000000000..8e659b1416
--- /dev/null
+++ b/elements/rh-popover/docs/30-code.md
@@ -0,0 +1,3 @@
+## Coming soon!
+
+This element is currently in progress and not yet available for use.
\ No newline at end of file
diff --git a/elements/rh-progress-steps/docs/00-overview.md b/elements/rh-progress-steps/docs/00-overview.md
index 730b7991d8..ad90cee1df 100644
--- a/elements/rh-progress-steps/docs/00-overview.md
+++ b/elements/rh-progress-steps/docs/00-overview.md
@@ -1,14 +1,14 @@
-## Coming soon!
-
-This element is currently in progress and not yet available for use.
-
## Overview
Progress steps guide a user through a task with multiple sequential steps
toward the completion of a linear process.
+{% repoStatusList repoStatus=repoStatus %}
+
## Sample element
+
+{% repoStatusChecklist repoStatus=repoStatus %}
\ No newline at end of file
diff --git a/elements/rh-progress-steps/docs/30-code.md b/elements/rh-progress-steps/docs/30-code.md
new file mode 100644
index 0000000000..b9cddcad45
--- /dev/null
+++ b/elements/rh-progress-steps/docs/30-code.md
@@ -0,0 +1,3 @@
+## Coming soon!
+
+This element is currently in progress and not yet available for use.
diff --git a/elements/rh-site-status/docs/00-overview.md b/elements/rh-site-status/docs/00-overview.md
index 3a7c36acc0..69c11e010d 100644
--- a/elements/rh-site-status/docs/00-overview.md
+++ b/elements/rh-site-status/docs/00-overview.md
@@ -7,7 +7,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -21,4 +21,4 @@
- When you need to provide users with a link to a status page where they can learn more
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-skip-link/docs/00-overview.md b/elements/rh-skip-link/docs/00-overview.md
index 4a325d3194..477b714371 100644
--- a/elements/rh-skip-link/docs/00-overview.md
+++ b/elements/rh-skip-link/docs/00-overview.md
@@ -7,7 +7,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -24,4 +24,4 @@ To show the skip link, click this paragraph and hit the "Tab" key on your keyboa
- When there are blocks of content that are repeated on multiple pages
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-spinner/docs/00-overview.md b/elements/rh-spinner/docs/00-overview.md
index b3634bb6f0..238d89d6b9 100644
--- a/elements/rh-spinner/docs/00-overview.md
+++ b/elements/rh-spinner/docs/00-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -19,4 +19,4 @@
- When the structure or amount of content that's loading is unknown
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-stat/docs/00-overview.md b/elements/rh-stat/docs/00-overview.md
index 78cad9a568..451aecdf05 100644
--- a/elements/rh-stat/docs/00-overview.md
+++ b/elements/rh-stat/docs/00-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -23,5 +23,5 @@
- When you need to pair a data point with supporting text to add more context
- When you need to display several statistics together in a group
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-subnav/docs/00-overview.md b/elements/rh-subnav/docs/00-overview.md
index 3ee08d031b..51b25c1412 100644
--- a/elements/rh-subnav/docs/00-overview.md
+++ b/elements/rh-subnav/docs/00-overview.md
@@ -7,7 +7,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -26,4 +26,4 @@
- When you want to allow users to browse high-level and low-level pages in the
same experience
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-switch/docs/00-overview.md b/elements/rh-switch/docs/00-overview.md
index 6c4131139a..9ad397bfd9 100644
--- a/elements/rh-switch/docs/00-overview.md
+++ b/elements/rh-switch/docs/00-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -25,4 +25,4 @@
- When users need to toggle an item on or off
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-table/docs/00-overview.md b/elements/rh-table/docs/00-overview.md
index db36fe65dc..286a5a25bc 100644
--- a/elements/rh-table/docs/00-overview.md
+++ b/elements/rh-table/docs/00-overview.md
@@ -7,7 +7,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -56,4 +56,4 @@
- If a user needs to scan, examine, and compare data
- If a user must navigate to a specific piece of data to complete a task
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-tabs/docs/00-overview.md b/elements/rh-tabs/docs/00-overview.md
index 06704e62c4..e714955eba 100644
--- a/elements/rh-tabs/docs/00-overview.md
+++ b/elements/rh-tabs/docs/00-overview.md
@@ -7,7 +7,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -27,4 +27,4 @@
- When you need to group other types of content in the same view like forms, settings, dashboards, etc.
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-tag/docs/00-overview.md b/elements/rh-tag/docs/00-overview.md
index 781461376d..6656bab977 100644
--- a/elements/rh-tag/docs/00-overview.md
+++ b/elements/rh-tag/docs/00-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -38,4 +38,4 @@ class="visually-hidden">Hat
- When you need to tag items of the same category
- When you need to indicate status
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-tile/docs/00-overview.md b/elements/rh-tile/docs/00-overview.md
index 58cbcf97bd..bc74c191ce 100644
--- a/elements/rh-tile/docs/00-overview.md
+++ b/elements/rh-tile/docs/00-overview.md
@@ -7,7 +7,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -25,5 +25,5 @@
- When you need an alternative to a group of cards with the same calls to action
- When you need to group content for a radio button or checkbox in a form
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-timestamp/docs/00-overview.md b/elements/rh-timestamp/docs/00-overview.md
index 5d5429496d..9ee6863b1e 100644
--- a/elements/rh-timestamp/docs/00-overview.md
+++ b/elements/rh-timestamp/docs/00-overview.md
@@ -2,7 +2,7 @@
{{ tagName | getElementDescription }}
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -12,4 +12,4 @@
- When you need to customize date and time content
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}
diff --git a/elements/rh-tooltip/docs/00-overview.md b/elements/rh-tooltip/docs/00-overview.md
index 81aa768e24..525d3ddd5c 100644
--- a/elements/rh-tooltip/docs/00-overview.md
+++ b/elements/rh-tooltip/docs/00-overview.md
@@ -6,7 +6,7 @@
-{% repoStatusList %}
+{% repoStatusList repoStatus=repoStatus %}
## Sample element
@@ -36,4 +36,4 @@
- When you need to provide more information for icons or icon buttons without labels
- When you need to define new or unfamiliar UI elements that are not described directly in the user interface
-{% repoStatusChecklist %}
+{% repoStatusChecklist repoStatus=repoStatus %}