From cff70c22f989f1b36014f47661647b6a463e143e Mon Sep 17 00:00:00 2001 From: imagoiq <12294151+imagoiq@users.noreply.github.com> Date: Mon, 5 Feb 2024 07:25:19 +0100 Subject: [PATCH 01/13] feat(documentation): Set id/permalink for stories --- .../components/accordion/accordion.stories.ts | 1 + .../alert/standard-html/alert.stories.ts | 23 ++------ .../alert/web-component/post-alert.stories.ts | 5 +- .../stories/components/badge/badge.stories.ts | 16 ++---- .../blockquote/blockquote.stories.ts | 1 + .../button-group/button-group.stories.ts | 5 +- .../components/button/button.stories.ts | 32 +++-------- .../components/cards/card/card.stories.ts | 49 ++++------------- .../product-card/product-card.stories.ts | 19 +++---- .../components/carousel/carousel.stories.ts | 1 + .../collapsible/collapsible.stories.ts | 5 +- .../datepicker/datepicker.stories.ts | 1 + .../components/dropdown/dropdown.stories.ts | 1 + .../forms/checkbox/checkbox.stories.ts | 5 +- .../choice-card/checkbox-card.stories.ts | 3 +- .../custom-select/custom-select.stories.ts | 1 + .../forms/input-group/input-group.stories.ts | 1 + .../components/forms/input/input.stories.ts | 27 +++------- .../components/forms/radio/radio.stories.ts | 17 ++---- .../components/forms/range/range.stories.ts | 29 +++------- .../components/forms/select/select.stories.ts | 54 ++++++++----------- .../components/forms/switch/switch.stories.ts | 20 ++----- .../forms/textarea/textarea.stories.ts | 32 +++-------- .../components/heading/heading.stories.ts | 1 + .../icons/components/icon.stories.ts | 14 ++--- .../icons/getting-started.stories.ts | 1 + .../search-icons/search-icons.stories.ts | 1 + .../getting-started.stories.ts | 1 + .../intranet-header.stories.ts | 1 + .../stories/components/modal/modal.stories.ts | 1 + .../pagination/pagination.stories.ts | 1 + .../components/popover/popover.stories.ts | 7 +-- .../progressbar/progressbar.stories.ts | 1 + .../components/stepper/stepper.stories.ts | 1 + .../stories/components/table/table.stories.ts | 5 +- .../stories/components/tabs/tabs.stories.ts | 1 + .../timepicker/timepicker.stories.ts | 1 + .../stories/components/toast/toast.stories.ts | 23 +++----- .../components/tooltip/tooltip.stories.ts | 1 + .../topic-teaser/topic-teaser.stories.ts | 9 +--- .../components/typeahead/typeahead.stories.ts | 1 + .../accessibility/accessibility.stories.ts | 1 + .../stories/foundation/color/color.stories.ts | 1 + .../foundation/elevation/elevation.stories.ts | 5 +- .../layout/breakpoints/breakpoints.stories.ts | 1 + .../layout/columns/columns.stories.ts | 3 +- .../layout/containers/containers.stories.ts | 1 + .../foundation/layout/grid/grid.stories.ts | 3 +- .../typography/typography.stories.ts | 1 + .../compatibility/compatibility.stories.ts | 1 + .../components-angular/angular.stories.ts | 1 + .../components/components.stories.ts | 1 + .../getting-started/styles/styles.stories.ts | 1 + .../documentation/src/stories/home.stories.ts | 1 + .../misc/changelog/changelog.stories.ts | 1 + .../migration-guide.stories.ts | 1 + .../stories/misc/versions/versions.stories.ts | 1 + .../stories/patterns/forms/forms.stories.ts | 1 + .../background/background.stories.ts | 5 +- .../utilities/common/common.stories.ts | 1 + .../utilities/heading/heading.stories.ts | 9 ++-- .../stories/utilities/list/list.stories.ts | 1 + .../utilities/sizing/sizing.stories.ts | 1 + .../utilities/spacing/spacing.stories.ts | 11 ++-- .../stories/utilities/text/text.stories.ts | 33 +++--------- 65 files changed, 173 insertions(+), 332 deletions(-) diff --git a/packages/documentation/src/stories/components/accordion/accordion.stories.ts b/packages/documentation/src/stories/components/accordion/accordion.stories.ts index d56f62c505..8943a19098 100644 --- a/packages/documentation/src/stories/components/accordion/accordion.stories.ts +++ b/packages/documentation/src/stories/components/accordion/accordion.stories.ts @@ -4,6 +4,7 @@ import { ifDefined } from 'lit/directives/if-defined.js'; import { BADGE } from '../../../../.storybook/constants'; const meta: Meta = { + id: 'Components/Accordion', title: 'Components/Accordion', component: 'post-accordion', parameters: { diff --git a/packages/documentation/src/stories/components/alert/standard-html/alert.stories.ts b/packages/documentation/src/stories/components/alert/standard-html/alert.stories.ts index 20183055cb..ed1d063cd3 100644 --- a/packages/documentation/src/stories/components/alert/standard-html/alert.stories.ts +++ b/packages/documentation/src/stories/components/alert/standard-html/alert.stories.ts @@ -7,6 +7,7 @@ import { getAlertClasses } from './getAlertClasses'; import { BADGE } from '../../../../../.storybook/constants'; const meta: Meta = { + id: 'Components/Alert', title: 'Components/Alert', render: renderAlert, decorators: [externalControl], @@ -122,9 +123,7 @@ function externalControl(story: StoryFn, { args, context }: StoryContext) { `; - return html` - ${args.fixed ? button : nothing} ${story(args, context)} - `; + return html` ${args.fixed ? button : nothing} ${story(args, context)} `; } // RENDERER @@ -133,11 +132,7 @@ function renderAlert(args: Args) { const classes = getAlertClasses(args); const content = html` - ${args.title - ? html` -

${args.title}

- ` - : nothing} + ${args.title ? html`

${args.title}

` : nothing} ${unsafeHTML(args.content)} `; @@ -145,19 +140,11 @@ function renderAlert(args: Args) {
${renderProductCard({ ...args, title: `${args.title} 2` })}
-
${renderProductCard({ ...args, title: `${args.title} 3`, text: '' })}
+
+ ${renderProductCard({ ...args, title: `${args.title} 3`, text: '' })} +
${renderProductCard({ ...args, title: `${args.title} 4` })}
${renderProductCard({ @@ -333,7 +330,7 @@ export const Multipart: Story = { nodes.forEach(node => { const group = node.getAttribute('data-sync-height-with'); const groupHeight = heightByGroup.get(group); - + node.style.height = 'auto'; const nodeHeight = node.offsetHeight; diff --git a/packages/documentation/src/stories/components/carousel/carousel.stories.ts b/packages/documentation/src/stories/components/carousel/carousel.stories.ts index 3d35fd9441..941f50c709 100644 --- a/packages/documentation/src/stories/components/carousel/carousel.stories.ts +++ b/packages/documentation/src/stories/components/carousel/carousel.stories.ts @@ -2,6 +2,7 @@ import { Meta, StoryObj } from '@storybook/web-components'; import { BADGE } from '../../../../.storybook/constants'; const meta: Meta = { + id: 'Components/Carousel', title: 'Components/Carousel', parameters: { badges: [BADGE.WEB_COMPONENT_CANDIDATE], diff --git a/packages/documentation/src/stories/components/collapsible/collapsible.stories.ts b/packages/documentation/src/stories/components/collapsible/collapsible.stories.ts index cde1122d25..98dff52bd8 100644 --- a/packages/documentation/src/stories/components/collapsible/collapsible.stories.ts +++ b/packages/documentation/src/stories/components/collapsible/collapsible.stories.ts @@ -4,6 +4,7 @@ import { BADGE } from '../../../../.storybook/constants'; import { spreadArgs } from '../../../utils'; const meta: Meta = { + id: 'Components/Collapsible', title: 'Components/Collapsible', component: 'post-collapsible', render: renderCollapsible, @@ -64,9 +65,7 @@ function externalControls(story: StoryFn, context: StoryContext) { //RENDERER function renderCollapsible(args: Partial) { - return html` - - `; + return html` `; } // STORIES diff --git a/packages/documentation/src/stories/components/datepicker/datepicker.stories.ts b/packages/documentation/src/stories/components/datepicker/datepicker.stories.ts index ecc7f1a27c..a750dfbd0d 100644 --- a/packages/documentation/src/stories/components/datepicker/datepicker.stories.ts +++ b/packages/documentation/src/stories/components/datepicker/datepicker.stories.ts @@ -3,6 +3,7 @@ import { html } from 'lit'; import { BADGE } from '../../../../.storybook/constants'; const meta: Meta = { + id: 'Components/Datepicker', title: 'Components/Datepicker', parameters: { badges: [BADGE.WEB_COMPONENT_CANDIDATE], diff --git a/packages/documentation/src/stories/components/dropdown/dropdown.stories.ts b/packages/documentation/src/stories/components/dropdown/dropdown.stories.ts index 9ef137d00a..90d1424e3c 100644 --- a/packages/documentation/src/stories/components/dropdown/dropdown.stories.ts +++ b/packages/documentation/src/stories/components/dropdown/dropdown.stories.ts @@ -2,6 +2,7 @@ import { Meta } from '@storybook/web-components'; import { BADGE } from '../../../../.storybook/constants'; const meta: Meta = { + id: 'Components/Dropdown', title: 'Components/Dropdown', parameters: { badges: [BADGE.WEB_COMPONENT_CANDIDATE], diff --git a/packages/documentation/src/stories/components/forms/checkbox/checkbox.stories.ts b/packages/documentation/src/stories/components/forms/checkbox/checkbox.stories.ts index 1b48d5df46..763dd30988 100644 --- a/packages/documentation/src/stories/components/forms/checkbox/checkbox.stories.ts +++ b/packages/documentation/src/stories/components/forms/checkbox/checkbox.stories.ts @@ -6,6 +6,7 @@ import { BADGE } from '../../../../../.storybook/constants'; import { mapClasses } from '../../../../utils'; const meta: Meta = { + id: 'Components/Forms/Checkbox', title: 'Components/Forms/Checkbox', render: renderCheckbox, parameters: { @@ -159,9 +160,7 @@ const VALIDATION_STATE_MAP: Record = { }; function getLabel({ label }: Args, { id }: StoryContext) { - return html` - - `; + return html` `; } function getValidationFeedback({ validation }: Args) { diff --git a/packages/documentation/src/stories/components/forms/choice-card/checkbox-card.stories.ts b/packages/documentation/src/stories/components/forms/choice-card/checkbox-card.stories.ts index 04e03c18e9..de470b7e5d 100644 --- a/packages/documentation/src/stories/components/forms/choice-card/checkbox-card.stories.ts +++ b/packages/documentation/src/stories/components/forms/choice-card/checkbox-card.stories.ts @@ -1,8 +1,9 @@ import { BADGE } from '../../../../../.storybook/constants'; -import { choiceCardMeta, choiceCardDefault, choiceCardGroup } from './choice-card'; +import { choiceCardDefault, choiceCardGroup, choiceCardMeta } from './choice-card'; export default { ...choiceCardMeta, + id: 'Components/Forms/Checkbox Card', title: 'Components/Forms/Checkbox Card', parameters: { badges: [BADGE.NEEDS_REVISION], diff --git a/packages/documentation/src/stories/components/forms/custom-select/custom-select.stories.ts b/packages/documentation/src/stories/components/forms/custom-select/custom-select.stories.ts index 5cd5b7e191..09cf309257 100644 --- a/packages/documentation/src/stories/components/forms/custom-select/custom-select.stories.ts +++ b/packages/documentation/src/stories/components/forms/custom-select/custom-select.stories.ts @@ -2,6 +2,7 @@ import { Meta, StoryObj } from '@storybook/web-components'; import { BADGE } from '../../../../../.storybook/constants'; const meta: Meta = { + id: 'Components/Forms/Custom-Select', title: 'Components/Forms/Custom-Select', parameters: { badges: [BADGE.DEPRECATED], diff --git a/packages/documentation/src/stories/components/forms/input-group/input-group.stories.ts b/packages/documentation/src/stories/components/forms/input-group/input-group.stories.ts index 7c2cd662d7..a6185264c1 100644 --- a/packages/documentation/src/stories/components/forms/input-group/input-group.stories.ts +++ b/packages/documentation/src/stories/components/forms/input-group/input-group.stories.ts @@ -2,6 +2,7 @@ import { Meta, StoryObj } from '@storybook/web-components'; import { BADGE } from '../../../../../.storybook/constants'; const meta: Meta = { + id: 'Components/Forms/Input Group', title: 'Components/Forms/Input Group', parameters: { badges: [BADGE.TODO], diff --git a/packages/documentation/src/stories/components/forms/input/input.stories.ts b/packages/documentation/src/stories/components/forms/input/input.stories.ts index b750710b8d..abef1ec865 100644 --- a/packages/documentation/src/stories/components/forms/input/input.stories.ts +++ b/packages/documentation/src/stories/components/forms/input/input.stories.ts @@ -9,6 +9,7 @@ const VALIDATION_STATE_MAP: Record = { }; const meta: Meta = { + id: 'Components/Forms/Input', title: 'Components/Forms/Input', render: render, parameters: { @@ -199,9 +200,7 @@ function render(args: Args, context: StoryContext) { const useAriaLabel = !args.floatingLabel && args.hiddenLabel; const label: TemplateResult | null = !useAriaLabel - ? html` - - ` + ? html` ` : null; if (args.floatingLabel && !args.placeholder) { @@ -209,21 +208,9 @@ function render(args: Args, context: StoryContext) { } const contextual: (TemplateResult | null)[] = [ - args.validation === 'is-valid' - ? html` -

Ggranda sukceso!

- ` - : null, - args.validation === 'is-invalid' - ? html` -

Eraro okazis!

- ` - : null, - args.hint !== '' - ? html` -
${args.hint}
- ` - : null, + args.validation === 'is-valid' ? html`

Ggranda sukceso!

` : null, + args.validation === 'is-invalid' ? html`

Eraro okazis!

` : null, + args.hint !== '' ? html`
${args.hint}
` : null, ]; const control: TemplateResult = html` @@ -243,9 +230,7 @@ function render(args: Args, context: StoryContext) {
${[control, label, ...contextual].filter(el => el !== null)}
`; } else { - return html` - ${[label, control, ...contextual].filter(el => el !== null)} - `; + return html` ${[label, control, ...contextual].filter(el => el !== null)} `; } } diff --git a/packages/documentation/src/stories/components/forms/radio/radio.stories.ts b/packages/documentation/src/stories/components/forms/radio/radio.stories.ts index e947e62f6e..316c2cf18e 100644 --- a/packages/documentation/src/stories/components/forms/radio/radio.stories.ts +++ b/packages/documentation/src/stories/components/forms/radio/radio.stories.ts @@ -10,6 +10,7 @@ const VALIDATION_STATE_MAP: Record = { }; const meta: Meta = { + id: 'Components/Forms/Radio button', title: 'Components/Forms/Radio button', parameters: { controls: { @@ -123,22 +124,12 @@ function render(args: Args, context: StoryContext) { const useAriaLabel = args.hiddenLabel; const label: TemplateResult | null = !useAriaLabel - ? html` - - ` + ? html` ` : null; const contextual: (TemplateResult | null)[] = [ - args.validation === 'is-valid' - ? html` -

Ggranda sukceso!

- ` - : null, - args.validation === 'is-invalid' - ? html` -

Eraro okazis!

- ` - : null, + args.validation === 'is-valid' ? html`

Ggranda sukceso!

` : null, + args.validation === 'is-invalid' ? html`

Eraro okazis!

` : null, ]; const control = html` diff --git a/packages/documentation/src/stories/components/forms/range/range.stories.ts b/packages/documentation/src/stories/components/forms/range/range.stories.ts index 4d68b0a02d..3f68edfdb6 100644 --- a/packages/documentation/src/stories/components/forms/range/range.stories.ts +++ b/packages/documentation/src/stories/components/forms/range/range.stories.ts @@ -12,6 +12,7 @@ const VALIDATION_STATE_MAP: Record = { const ARROW_KEYS = ['ArrowUp', 'ArrowDown', 'ArrowLeft', 'ArrowRight']; const meta: Meta = { + id: 'Components/Forms/Range', title: 'Components/Forms/Range', render: render, parameters: { @@ -170,22 +171,12 @@ function render(args: Args, context: StoryContext) { const useAriaLabel = args.hiddenLabel; const label: TemplateResult | null = !useAriaLabel - ? html` - - ` + ? html` ` : null; const contextual: (TemplateResult | null)[] = [ - args.validation === 'is-valid' - ? html` -

Ggranda sukceso!

- ` - : null, - args.validation === 'is-invalid' - ? html` -

Eraro okazis!

- ` - : null, + args.validation === 'is-valid' ? html`

Ggranda sukceso!

` : null, + args.validation === 'is-invalid' ? html`

Eraro okazis!

` : null, ]; const control: TemplateResult = html` @@ -208,16 +199,12 @@ function render(args: Args, context: StoryContext) { let valueElement: TemplateResult | TemplateResult[] | null = null; if (args.showValue === 'text') { - valueElement = html` -

${args.value}

- `; + valueElement = html`

${args.value}

`; } else if (args.showValue === 'input') { const inputId = `${context.viewMode}_${context.name.replace(/\s/g, '-')}_ExampleRangeInput`; valueElement = [ - html` - - `, + html` `, html` `; } else { - return html` - ${[label, control, valueElement, ...contextual].filter(el => el !== null)} - `; + return html` ${[label, control, valueElement, ...contextual].filter(el => el !== null)} `; } } diff --git a/packages/documentation/src/stories/components/forms/select/select.stories.ts b/packages/documentation/src/stories/components/forms/select/select.stories.ts index 16ee308f2d..9a1d126aad 100644 --- a/packages/documentation/src/stories/components/forms/select/select.stories.ts +++ b/packages/documentation/src/stories/components/forms/select/select.stories.ts @@ -11,6 +11,7 @@ const VALIDATION_STATE_MAP: Record = { }; const meta: Meta = { + id: 'Components/Forms/Select', title: 'Components/Forms/Select', parameters: { badges: [BADGE.NEEDS_REVISION], @@ -217,43 +218,27 @@ const Template: Story = { .join(' '); const useAriaLabel = !args.floatingLabel && args.hiddenLabel; const label = !useAriaLabel - ? html` - - ` + ? html` ` : null; const optionElements = Array.from({ length: args.options - 1 }, (_, i) => i + 2).map( - (key: number) => html` - - `, + (key: number) => html` `, ); const options = [ ...[ args.floatingLabelPlaceholder - ? html` - - ` - : html` - - `, + ? html` ` + : html` `, ], ...optionElements, ]; const contextuals = [ args.validation === 'is-valid' - ? html` -

Ggranda sukceso!

- ` + ? html`

Ggranda sukceso!

` : null, args.validation === 'is-invalid' - ? html` -

Eraro okazis!

- ` - : null, - args.hint !== '' - ? html` -
${args.hint}
- ` + ? html`

Eraro okazis!

` : null, + args.hint !== '' ? html`
${args.hint}
` : null, ]; const control = html` `; @@ -288,9 +278,7 @@ const Template: Story = {
`; } else { - return html` - ${[label, control, ...contextuals].filter(el => el !== null)} - `; + return html` ${[label, control, ...contextuals].filter(el => el !== null)} `; } }, }; diff --git a/packages/documentation/src/stories/components/forms/switch/switch.stories.ts b/packages/documentation/src/stories/components/forms/switch/switch.stories.ts index b5364f8d03..c7087f2a5c 100644 --- a/packages/documentation/src/stories/components/forms/switch/switch.stories.ts +++ b/packages/documentation/src/stories/components/forms/switch/switch.stories.ts @@ -6,6 +6,7 @@ import { BADGE } from '../../../../../.storybook/constants'; import { mapClasses } from '../../../../utils'; const meta: Meta = { + id: 'Components/Forms/Switch', title: 'Components/Forms/Switch', render: renderSwitch, parameters: { @@ -94,12 +95,7 @@ const meta: Meta = { }, }, }, - decorators: [ - story => - html` -
${story()}
- `, - ], + decorators: [story => html`
${story()}
`], }; export default meta; @@ -124,23 +120,17 @@ function renderSwitch(args: Args, context: StoryContext) { const useLabelAfter = !useAriaLabel && 'after' === args.labelPosition; const labelBefore = useLabelBefore - ? html` - - ` + ? html` ` : null; const labelAfter = useLabelAfter - ? html` - - ` + ? html` ` : null; const validationText = args.validation === 'is-valid' ? 'Ggranda sukceso!' : 'Eraro okazis!'; const validationFeedback = args.validation !== 'null' - ? html` -

${validationText}

- ` + ? html`

${validationText}

` : null; return html` diff --git a/packages/documentation/src/stories/components/forms/textarea/textarea.stories.ts b/packages/documentation/src/stories/components/forms/textarea/textarea.stories.ts index 389f96d498..2ceb1de06f 100644 --- a/packages/documentation/src/stories/components/forms/textarea/textarea.stories.ts +++ b/packages/documentation/src/stories/components/forms/textarea/textarea.stories.ts @@ -10,6 +10,7 @@ const VALIDATION_STATE_MAP: Record = { }; const meta: Meta = { + id: 'Components/Forms/Textarea', title: 'Components/Forms/Textarea', render: renderTextarea, parameters: { @@ -160,34 +161,16 @@ function renderTextarea(args: Args, context: StoryContext) { }); const useAriaLabel = !args.floatingLabel && args.hiddenLabel; const label = !useAriaLabel - ? html` - - ` + ? html` ` : null; const contextuals = [ args.validation === 'is-valid' - ? html` -
Ggranda sukceso!
- ` + ? html`
Ggranda sukceso!
` : null, args.validation === 'is-invalid' - ? html` -
Eraro okazis!
- ` - : null, - args.hint !== '' - ? html` -
- ${html` - ${args.hint} - `} -
- ` + ? html`
Eraro okazis!
` : null, + args.hint !== '' ? html`
${html` ${args.hint} `}
` : null, ]; const control = html`