diff --git a/.changeset/loud-dolphins-enjoy.md b/.changeset/loud-dolphins-enjoy.md new file mode 100644 index 0000000000..3941b9cdf2 --- /dev/null +++ b/.changeset/loud-dolphins-enjoy.md @@ -0,0 +1,7 @@ +--- +"@rhds/elements": patch +--- + +``: +``: +``: Updated custom elements manifest summaries diff --git a/docs/_plugins/rhds.cjs b/docs/_plugins/rhds.cjs index 8e0cc3592f..36d5f6e2c2 100644 --- a/docs/_plugins/rhds.cjs +++ b/docs/_plugins/rhds.cjs @@ -198,6 +198,10 @@ module.exports = function(eleventyConfig, { tagsToAlphabetize }) { return related; }); + eleventyConfig.addFilter('makeSentenceCase', function(value) { + return value.charAt(0).toUpperCase() + value.slice(1).toLowerCase(); + }); + eleventyConfig.addCollection('elementDocs', async function(collectionApi) { const { pfeconfig } = eleventyConfig?.globalData ?? {}; /** @@ -215,6 +219,7 @@ module.exports = function(eleventyConfig, { tagsToAlphabetize }) { capitalize(filePath.split(path.sep).pop()?.split('.').shift()?.replace(/^\d+-/, '') ?? ''); const pageSlug = slugify(pageTitle, { strict: true, lower: true }); /** e.g. `/elements/call-to-action/code/index.html` */ + const overviewHref = `/elements/${slug}/`; const permalink = pageSlug === 'overview' ? `/elements/${slug}/index.html` : `/elements/${slug}/${pageSlug}/index.html`; @@ -232,6 +237,7 @@ module.exports = function(eleventyConfig, { tagsToAlphabetize }) { screenshotPath, permalink, href, + overviewHref }; } diff --git a/docs/elements/index.md b/docs/elements/index.md index 2c40b3e7ca..118e335cc7 100644 --- a/docs/elements/index.md +++ b/docs/elements/index.md @@ -1,6 +1,6 @@ --- layout: layout-basic.njk -title: Elements +title: All elements summaries: audio-player: Plays audio clips and includes other features jump-links: Moves users to specific content when a link is selected @@ -26,7 +26,7 @@ summaries: {%- for tagName, docs in collections.elementDocs | groupby('tagName') -%} {%- set doc = docs[0] -%} {%- set slug = doc.slug -%} - {%- set title = docs | getTitleFromDocs -%} + {%- set title = docs | getTitleFromDocs | makeSentenceCase -%} {%- set comingSoon = tagName in comingSoonItems -%} {% if comingSoon %} {%- set title = [title, "(coming soon)"] | join(" ") -%} @@ -42,7 +42,7 @@ summaries: {% endif %}
- {% if not comingSoon %}{% endif %} + {% if not comingSoon %}{% endif %} {% example palette="descriptive", width=340, alt=linkTitle, diff --git a/elements/rh-alert/docs/screenshot.png b/elements/rh-alert/docs/screenshot.png index 5a52e837b7..2e2dc645b7 100755 Binary files a/elements/rh-alert/docs/screenshot.png and b/elements/rh-alert/docs/screenshot.png differ diff --git a/elements/rh-audio-player/docs/screenshot.png b/elements/rh-audio-player/docs/screenshot.png index fab3e487ae..2fb683cb7e 100755 Binary files a/elements/rh-audio-player/docs/screenshot.png and b/elements/rh-audio-player/docs/screenshot.png differ diff --git a/elements/rh-avatar/docs/screenshot.png b/elements/rh-avatar/docs/screenshot.png index 96bb5a5d28..16ab7855c9 100755 Binary files a/elements/rh-avatar/docs/screenshot.png and b/elements/rh-avatar/docs/screenshot.png differ diff --git a/elements/rh-avatar/rh-avatar.ts b/elements/rh-avatar/rh-avatar.ts index 028a4bc9b2..cba5cb23a2 100644 --- a/elements/rh-avatar/rh-avatar.ts +++ b/elements/rh-avatar/rh-avatar.ts @@ -25,7 +25,7 @@ DEFAULT_AVATARS.saturated = DEFAULT_AVATARS.dark; /** * An avatar is a small thumbnail representation of a user. * - * @summary An avatar is a small thumbnail representation of a user. + * @summary Visually represents a user in a masthead or navigation * * @slot name - The subject's name * @slot subtitle - auxiliary information about the subject, e.g. job title diff --git a/elements/rh-badge/docs/screenshot.png b/elements/rh-badge/docs/screenshot.png index b39fc6649e..bdb908e8f5 100755 Binary files a/elements/rh-badge/docs/screenshot.png and b/elements/rh-badge/docs/screenshot.png differ diff --git a/elements/rh-blockquote/docs/screenshot.png b/elements/rh-blockquote/docs/screenshot.png index f58bbb6448..482b62d934 100755 Binary files a/elements/rh-blockquote/docs/screenshot.png and b/elements/rh-blockquote/docs/screenshot.png differ diff --git a/elements/rh-code-block/docs/screenshot.png b/elements/rh-code-block/docs/screenshot.png old mode 100644 new mode 100755 diff --git a/elements/rh-code-block/rh-code-block.ts b/elements/rh-code-block/rh-code-block.ts index 9f3bde648f..55b5e25092 100644 --- a/elements/rh-code-block/rh-code-block.ts +++ b/elements/rh-code-block/rh-code-block.ts @@ -8,7 +8,7 @@ import style from './rh-code-block.css'; /** * A code block is formatted text within a container. - * @summary Formatted code strings in a container. + * @summary Formats code strings within a container * @slot - A non-executable script tag containing the sample content. JavaScript * samples should use the type `text/sample-javascript`. HTML samples * containing script tags must escape the closing `` tag. diff --git a/elements/rh-footer/docs/screenshot.png b/elements/rh-footer/docs/screenshot.png index c3a14ef469..d29841e298 100755 Binary files a/elements/rh-footer/docs/screenshot.png and b/elements/rh-footer/docs/screenshot.png differ diff --git a/elements/rh-navigation-secondary/rh-navigation-secondary.ts b/elements/rh-navigation-secondary/rh-navigation-secondary.ts index 2f9d5a8cb8..a72ca125ff 100644 --- a/elements/rh-navigation-secondary/rh-navigation-secondary.ts +++ b/elements/rh-navigation-secondary/rh-navigation-secondary.ts @@ -37,7 +37,7 @@ import { state } from 'lit/decorators/state.js'; /** * The Secondary navigation is used to connect a series of pages together. It displays wayfinding content and links relevant to the page it is placed on. It should be used in conjunction with the [primary navigation](../navigation-primary). * - * @summary Guides users through a task with sequential steps + * @summary Propagates related content across a series of pages * * @slot logo - Logo added to the main nav bar, expects `Text | | ` element * @slot nav - Navigation list added to the main nav bar, expects `
    ` element diff --git a/elements/rh-navigation/docs/screenshot.png b/elements/rh-navigation/docs/screenshot.png index 79e97367ef..4805980c81 100755 Binary files a/elements/rh-navigation/docs/screenshot.png and b/elements/rh-navigation/docs/screenshot.png differ diff --git a/elements/rh-pagination/docs/screenshot.png b/elements/rh-pagination/docs/screenshot.png index 080731bae2..56968b7a58 100755 Binary files a/elements/rh-pagination/docs/screenshot.png and b/elements/rh-pagination/docs/screenshot.png differ diff --git a/elements/rh-subnav/docs/screenshot.png b/elements/rh-subnav/docs/screenshot.png index 9c8b4dd63b..9e9f41cd93 100755 Binary files a/elements/rh-subnav/docs/screenshot.png and b/elements/rh-subnav/docs/screenshot.png differ diff --git a/elements/rh-timestamp/docs/screenshot.png b/elements/rh-timestamp/docs/screenshot.png old mode 100644 new mode 100755