diff --git a/packages/webawesome/docs/docs/components/breadcrumb-item.md b/packages/webawesome/docs/docs/components/breadcrumb-item.md index aa23f85a2..f010b18ec 100644 --- a/packages/webawesome/docs/docs/components/breadcrumb-item.md +++ b/packages/webawesome/docs/docs/components/breadcrumb-item.md @@ -5,17 +5,4 @@ tags: component parent: breadcrumb --- -```html {.example} - - - - Home - - Clothing - Shirts - -``` - -:::info -Additional demonstrations can be found in the [breadcrumb examples](/docs/components/breadcrumb). -::: +This component must be used as a child of ``. Please see the [Breadcrumb docs](/docs/components/breadcrumb) to see examples of this component in action. diff --git a/packages/webawesome/docs/docs/components/carousel-item.md b/packages/webawesome/docs/docs/components/carousel-item.md index 6fb06cce8..fa1d858a1 100644 --- a/packages/webawesome/docs/docs/components/carousel-item.md +++ b/packages/webawesome/docs/docs/components/carousel-item.md @@ -6,41 +6,4 @@ parent: carousel icon: carousel-item --- -```html {.example} - - - The sun shines on the mountains and trees - Photo by Adam Kool on Unsplash - - - A waterfall in the middle of a forest - Photo by Thomas Kelly on Unsplash - - - The sun is setting over a lavender field - Photo by Leonard Cotte on Unsplash - - - A field of grass with the sun setting in the background - Photo by Sapan Patel on Unsplash - - - A scenic view of a mountain with clouds rolling in - Photo by V2osk on Unsplash - - -``` - -:::info -Additional demonstrations can be found in the [carousel examples](/docs/components/carousel). -::: +This component must be used as a child of ``. Please see the [Carousel docs](/docs/components/carousel) to see examples of this component in action. diff --git a/packages/webawesome/docs/docs/components/option.md b/packages/webawesome/docs/docs/components/option.md index 84868b736..6d2343397 100644 --- a/packages/webawesome/docs/docs/components/option.md +++ b/packages/webawesome/docs/docs/components/option.md @@ -6,50 +6,4 @@ parent: select icon: option --- -```html {.example} - - Option 1 - Option 2 - Option 3 - -``` - -## Examples - -### Disabled - -Use the `disabled` attribute to disable an option and prevent it from being selected. - -```html {.example} - - Option 1 - Option 2 - Option 3 - -``` - -### Start & End Decorations - -Use the `start` and `end` slots to add presentational elements like `` next to the option label. - -```html {.example} - - - - Email - - - - - - Phone - - - - - - Chat - - - -``` +This component must be used as a child of ``. Please see the [Select docs](/docs/components/select) to see examples of this component in action. diff --git a/packages/webawesome/docs/docs/components/radio.md b/packages/webawesome/docs/docs/components/radio.md index 10adc4a44..3cf357f50 100644 --- a/packages/webawesome/docs/docs/components/radio.md +++ b/packages/webawesome/docs/docs/components/radio.md @@ -7,71 +7,4 @@ native: radio icon: radio-group --- -Radios are designed to be used with [radio groups](/docs/components/radio-group). - -```html {.example} - - Option 1 - Option 2 - Option 3 - -``` - -:::info -This component works with standard `
` elements. Please refer to the section on [form controls](/docs/form-controls) to learn more about form submission and client-side validation. -::: - -## Examples - -### Initial Value - -To set the initial value and checked state, use the `value` attribute on the containing radio group. - -```html {.example} - - Option 1 - Option 2 - Option 3 - -``` - -### Disabled - -Use the `disabled` attribute to disable a radio. - -```html {.example} - - Option 1 - Option 2 - Option 3 - -``` - -### Sizes - -Add the `size` attribute to the [Radio Group](/docs/components/radio-group) to change the radios' size. - -```html {.example} - - Small 1 - Small 2 - Small 3 - - -
- - - Medium 1 - Medium 2 - Medium 3 - - -
- - - Large 1 - Large 2 - Large 3 - -``` - +This component must be used as a child of ``. Please see the [Radio Group docs](/docs/components/radio-group) to see examples of this component in action. diff --git a/packages/webawesome/docs/docs/components/tab-panel.md b/packages/webawesome/docs/docs/components/tab-panel.md index fcafe7c54..6dda59793 100644 --- a/packages/webawesome/docs/docs/components/tab-panel.md +++ b/packages/webawesome/docs/docs/components/tab-panel.md @@ -6,20 +6,4 @@ parent: tab-group icon: tab-panel --- -```html {.example} - - General - Custom - Advanced - Disabled - - This is the general tab panel. - This is the custom tab panel. - This is the advanced tab panel. - This is a disabled tab panel. - -``` - -:::info -Additional demonstrations can be found in the [tab group examples](/docs/components/tab-group). -::: +This component must be used as a child of ``. Please see the [Tab Group docs](/docs/components/tab-group) to see examples of this component in action. diff --git a/packages/webawesome/docs/docs/components/tab.md b/packages/webawesome/docs/docs/components/tab.md index 2c22508d1..a5356ebe9 100644 --- a/packages/webawesome/docs/docs/components/tab.md +++ b/packages/webawesome/docs/docs/components/tab.md @@ -6,6 +6,4 @@ parent: tab-group icon: tab --- -:::info -Additional demonstrations can be found in the [tab group examples](/docs/components/tab-group). -::: +This component must be used as a child of ``. Please see the [Tab Group docs](/docs/components/tab-group) to see examples of this component in action. diff --git a/packages/webawesome/docs/docs/components/tree-item.md b/packages/webawesome/docs/docs/components/tree-item.md index f86385e55..2fca9bfd9 100644 --- a/packages/webawesome/docs/docs/components/tree-item.md +++ b/packages/webawesome/docs/docs/components/tree-item.md @@ -5,78 +5,4 @@ tags: [navigation, disclosure, apps] icon: tree --- -```html {.example} - - - Item 1 - Item A - Item B - Item C - - Item 2 - Item 3 - -``` - -## Examples - -### Nested tree items - -A tree item can contain other tree items. This allows the node to be expanded or collapsed by the user. - -```html {.example} - - - Item 1 - - Item A - Item Z - Item Y - Item X - - Item B - Item C - - Item 2 - Item 3 - -``` - -### Selected - -Use the `selected` attribute to select a tree item initially. - -```html {.example} - - - Item 1 - Item A - Item B - Item C - - Item 2 - Item 3 - -``` - -### Expanded - -Use the `expanded` attribute to expand a tree item initially. - -```html {.example} - - - Item 1 - - Item A - Item Z - Item Y - Item X - - Item B - Item C - - Item 2 - Item 3 - -``` +This component must be used as a child of ``. Please see the [Tree docs](/docs/components/tree) to see examples of this component in action. diff --git a/packages/webawesome/src/components/breadcrumb-item/breadcrumb-item.ts b/packages/webawesome/src/components/breadcrumb-item/breadcrumb-item.ts index 610422755..274cf6f6e 100644 --- a/packages/webawesome/src/components/breadcrumb-item/breadcrumb-item.ts +++ b/packages/webawesome/src/components/breadcrumb-item/breadcrumb-item.ts @@ -6,7 +6,7 @@ import WebAwesomeElement from '../../internal/webawesome-element.js'; import styles from './breadcrumb-item.css'; /** - * @summary Breadcrumb Items are used inside [breadcrumbs](/docs/components/breadcrumb) to represent different links. + * @summary Breadcrumb Items are used inside breadcrumbs to represent different links. * @documentation https://backers.webawesome.com/docs/components/breadcrumb-item * @status stable * @since 2.0 diff --git a/packages/webawesome/src/components/carousel-item/carousel-item.ts b/packages/webawesome/src/components/carousel-item/carousel-item.ts index 779d5df08..a655b317c 100644 --- a/packages/webawesome/src/components/carousel-item/carousel-item.ts +++ b/packages/webawesome/src/components/carousel-item/carousel-item.ts @@ -4,7 +4,7 @@ import WebAwesomeElement from '../../internal/webawesome-element.js'; import styles from './carousel-item.css'; /** - * @summary A carousel item represent a slide within a [carousel](/docs/components/carousel). + * @summary A carousel item represent a slide within a carousel. * * @since 2.0 * @status experimental diff --git a/packages/webawesome/src/components/option/option.ts b/packages/webawesome/src/components/option/option.ts index 5972cec9a..25ae09f30 100644 --- a/packages/webawesome/src/components/option/option.ts +++ b/packages/webawesome/src/components/option/option.ts @@ -8,7 +8,7 @@ import '../icon/icon.js'; import styles from './option.css'; /** - * @summary Options define the selectable items within various form controls such as [select](/docs/components/select). + * @summary Options define the selectable items within a select component. * @documentation https://backers.webawesome.com/docs/components/option * @status stable * @since 2.0