diff --git a/src/elements/button/accent-button/readme.md b/src/elements/button/accent-button/readme.md index 6273b00369..383c22948d 100644 --- a/src/elements/button/accent-button/readme.md +++ b/src/elements/button/accent-button/readme.md @@ -85,7 +85,7 @@ guard against such cases in your component. | --------------------- | ---------------------- | ------- | ------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------- | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The
element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `negative` | `negative` | public | `boolean` | `false` | Negative coloring variant flag. | diff --git a/src/elements/button/button/readme.md b/src/elements/button/button/readme.md index a9a25e4ec5..8082e96d0c 100644 --- a/src/elements/button/button/readme.md +++ b/src/elements/button/button/readme.md @@ -83,7 +83,7 @@ guard against such cases in your component. | --------------------- | ---------------------- | ------- | ------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------- | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `negative` | `negative` | public | `boolean` | `false` | Negative coloring variant flag. | diff --git a/src/elements/button/mini-button/readme.md b/src/elements/button/mini-button/readme.md index 017c210df7..f3fdacdd12 100644 --- a/src/elements/button/mini-button/readme.md +++ b/src/elements/button/mini-button/readme.md @@ -91,7 +91,7 @@ guard against such cases in your component. | --------------------- | ---------------------- | ------- | ------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------- | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `negative` | `negative` | public | `boolean` | `false` | Negative coloring variant flag. | diff --git a/src/elements/button/secondary-button/readme.md b/src/elements/button/secondary-button/readme.md index 990ec4cb24..695fdeabd4 100644 --- a/src/elements/button/secondary-button/readme.md +++ b/src/elements/button/secondary-button/readme.md @@ -88,7 +88,7 @@ guard against such cases in your component. | --------------------- | ---------------------- | ------- | ------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------- | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `negative` | `negative` | public | `boolean` | `false` | Negative coloring variant flag. | diff --git a/src/elements/button/transparent-button/readme.md b/src/elements/button/transparent-button/readme.md index 0f4053a576..afdece211e 100644 --- a/src/elements/button/transparent-button/readme.md +++ b/src/elements/button/transparent-button/readme.md @@ -88,7 +88,7 @@ guard against such cases in your component. | --------------------- | ---------------------- | ------- | ------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------- | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `negative` | `negative` | public | `boolean` | `false` | Negative coloring variant flag. | diff --git a/src/elements/card/card-button/readme.md b/src/elements/card/card-button/readme.md index cc976e64ac..38881bc719 100644 --- a/src/elements/card/card-button/readme.md +++ b/src/elements/card/card-button/readme.md @@ -25,7 +25,7 @@ as it is used for search engines and screen-reader users. | Name | Attribute | Privacy | Type | Default | Description | | -------- | --------- | ------- | ------------------------- | ---------- | ----------------------------------------------------------- | | `active` | `active` | public | `boolean` | `false` | Whether the card is active. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `type` | `type` | public | `SbbButtonType` | `'button'` | The type attribute to use for the button. | | `value` | `value` | public | `string \| null` | `null` | Value of the form element. | diff --git a/src/elements/core/base-elements/button-base-element.ts b/src/elements/core/base-elements/button-base-element.ts index 05fce0bbfa..96dfcf2c01 100644 --- a/src/elements/core/base-elements/button-base-element.ts +++ b/src/elements/core/base-elements/button-base-element.ts @@ -33,7 +33,7 @@ abstract class SbbButtonBaseElement extends SbbFormAssociatedMixin(SbbActionBase return (this.getAttribute('type') as SbbButtonType) ?? 'button'; } - /** The element to associate the button with. */ + /** The `` element to associate the button with. */ @property() public override set form(value: string) { this._formId = value; diff --git a/src/elements/datepicker/datepicker-next-day/readme.md b/src/elements/datepicker/datepicker-next-day/readme.md index 61581ac688..71388cda72 100644 --- a/src/elements/datepicker/datepicker-next-day/readme.md +++ b/src/elements/datepicker/datepicker-next-day/readme.md @@ -38,7 +38,7 @@ both standalone or within the `sbb-form-field`, they must have the same parent e | Name | Attribute | Privacy | Type | Default | Description | | ------------ | ------------- | ------- | ------------------------------------------- | ---------- | ----------------------------------------------------------- | | `datePicker` | `date-picker` | public | `string \| SbbDatepickerElement \| null` | `null` | Datepicker reference. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `negative` | `negative` | public | `boolean` | `false` | Negative coloring variant flag. | | `type` | `type` | public | `SbbButtonType` | `'button'` | The type attribute to use for the button. | diff --git a/src/elements/datepicker/datepicker-previous-day/readme.md b/src/elements/datepicker/datepicker-previous-day/readme.md index 288fed37cf..f1a02f3264 100644 --- a/src/elements/datepicker/datepicker-previous-day/readme.md +++ b/src/elements/datepicker/datepicker-previous-day/readme.md @@ -38,7 +38,7 @@ both standalone or within the `sbb-form-field`, they must have the same parent e | Name | Attribute | Privacy | Type | Default | Description | | ------------ | ------------- | ------- | ------------------------------------------- | ---------- | ----------------------------------------------------------- | | `datePicker` | `date-picker` | public | `string \| SbbDatepickerElement \| null` | `null` | Datepicker reference. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `negative` | `negative` | public | `boolean` | `false` | Negative coloring variant flag. | | `type` | `type` | public | `SbbButtonType` | `'button'` | The type attribute to use for the button. | diff --git a/src/elements/expansion-panel/expansion-panel-header/readme.md b/src/elements/expansion-panel/expansion-panel-header/readme.md index 514ad6cd6a..ab2bead53b 100644 --- a/src/elements/expansion-panel/expansion-panel-header/readme.md +++ b/src/elements/expansion-panel/expansion-panel-header/readme.md @@ -39,7 +39,7 @@ When the element is clicked, the `toggleExpanded` event is emitted. | --------------------- | ---------------------- | ------- | ------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------- | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `type` | `type` | public | `SbbButtonType` | `'button'` | The type attribute to use for the button. | diff --git a/src/elements/form-field/form-field-clear/readme.md b/src/elements/form-field/form-field-clear/readme.md index ae24d66b42..9e64e74ad6 100644 --- a/src/elements/form-field/form-field-clear/readme.md +++ b/src/elements/form-field/form-field-clear/readme.md @@ -17,7 +17,7 @@ to provide the possibility to display a clear button which can clear the input v | Name | Attribute | Privacy | Type | Default | Description | | ---------- | ---------- | ------- | ------------------------- | ---------- | ----------------------------------------------------------- | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `negative` | `negative` | public | `boolean` | `false` | Negative coloring variant flag. | | `type` | `type` | public | `SbbButtonType` | `'button'` | The type attribute to use for the button. | diff --git a/src/elements/header/header-button/readme.md b/src/elements/header/header-button/readme.md index 6da06abb70..05c4755ffc 100644 --- a/src/elements/header/header-button/readme.md +++ b/src/elements/header/header-button/readme.md @@ -51,7 +51,7 @@ accepting its associated properties (`type`, `name`, `value` and `form`). | Name | Attribute | Privacy | Type | Default | Description | | ------------ | ------------- | ------- | ------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `expandFrom` | `expand-from` | public | `SbbHorizontalFrom` | `'medium'` | Used to set the minimum breakpoint from which the text is displayed. E.g. if set to 'large', the text will be visible for breakpoints large, wide, ultra, and hidden for all the others. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `type` | `type` | public | `SbbButtonType` | `'button'` | The type attribute to use for the button. | diff --git a/src/elements/link/block-link-button/readme.md b/src/elements/link/block-link-button/readme.md index a60a05774f..e8e7490841 100644 --- a/src/elements/link/block-link-button/readme.md +++ b/src/elements/link/block-link-button/readme.md @@ -65,7 +65,7 @@ guard against such cases in your component. | --------------------- | ---------------------- | ------- | ------------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `iconPlacement` | `icon-placement` | public | `SbbIconPlacement` | `'start'` | Moves the icon to the end of the component if set to true. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | diff --git a/src/elements/link/link-button/readme.md b/src/elements/link/link-button/readme.md index 391b26d425..1f82495e19 100644 --- a/src/elements/link/link-button/readme.md +++ b/src/elements/link/link-button/readme.md @@ -51,7 +51,7 @@ guard against such cases in your component. | --------------------- | ---------------------- | ------- | ------------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `negative` | `negative` | public | `boolean` | `false` | Negative coloring variant flag. | | `size` | `size` | public | `SbbLinkSize` | `'s' / 'xs' (lean)` | Text size, the link should get in the non-button variation. With inline variant, the text size adapts to where it is used. | diff --git a/src/elements/menu/menu-button/readme.md b/src/elements/menu/menu-button/readme.md index 5d3de6d58e..1c15dea736 100644 --- a/src/elements/menu/menu-button/readme.md +++ b/src/elements/menu/menu-button/readme.md @@ -50,7 +50,7 @@ guard against such cases in your component. | `amount` | `amount` | public | `string` | `''` | Value shown as badge at component end. | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `type` | `type` | public | `SbbButtonType` | `'button'` | The type attribute to use for the button. | diff --git a/src/elements/navigation/navigation-button/readme.md b/src/elements/navigation/navigation-button/readme.md index b6e8fbbf35..38ff7108c6 100644 --- a/src/elements/navigation/navigation-button/readme.md +++ b/src/elements/navigation/navigation-button/readme.md @@ -34,7 +34,7 @@ The component has three different sizes, which can be changed using the `size` p | Name | Attribute | Privacy | Type | Default | Description | | ------------------ | --------- | ------- | ------------------------------------------ | ------------------ | ----------------------------------------------------------- | | `connectedSection` | - | public | `SbbNavigationSectionElement \| undefined` | | The section that is beign controlled by the action, if any. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `marker` | - | public | `SbbNavigationMarkerElement \| null` | | The navigation marker in which the action is nested. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `section` | - | public | `SbbNavigationSectionElement \| null` | | The section in which the action is nested. | diff --git a/src/elements/popover/popover-trigger/readme.md b/src/elements/popover/popover-trigger/readme.md index 24ac3eae2a..d4233fc1ff 100644 --- a/src/elements/popover/popover-trigger/readme.md +++ b/src/elements/popover/popover-trigger/readme.md @@ -88,7 +88,7 @@ guard against such cases in your component. | --------------------- | ---------------------- | ------- | ------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------- | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `negative` | `negative` | public | `boolean` | `false` | Negative coloring variant flag. | diff --git a/src/elements/stepper/step-label/readme.md b/src/elements/stepper/step-label/readme.md index 9e4cdac9f3..15e94247ec 100644 --- a/src/elements/stepper/step-label/readme.md +++ b/src/elements/stepper/step-label/readme.md @@ -39,7 +39,7 @@ The accessibility properties `aria-controls`, `aria-setsize`, `aria-posinset` ar | Name | Attribute | Privacy | Type | Default | Description | | ---------- | ----------- | ------- | ------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------- | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `step` | - | public | `SbbStepElement \| null` | `null` | The step controlled by the label. | diff --git a/src/elements/tag/tag/readme.md b/src/elements/tag/tag/readme.md index baf83e833d..c78b620961 100644 --- a/src/elements/tag/tag/readme.md +++ b/src/elements/tag/tag/readme.md @@ -84,7 +84,7 @@ This can be achieved by adding an `aria-label`, `aria-labelledby` or `aria-descr | `checked` | `checked` | public | `boolean` | `false` | Whether the tag is checked. | | `disabled` | `disabled` | public | `boolean` | `false` | Whether the component is disabled. | | `disabledInteractive` | `disabled-interactive` | public | `boolean` | `false` | Whether the button should be aria-disabled but stay interactive. | -| `form` | `form` | public | `HTMLFormElement \| null` | | The element to associate the button with. | +| `form` | `form` | public | `HTMLFormElement \| null` | | The `` element to associate the button with. | | `iconName` | `icon-name` | public | `string` | `''` | The icon name we want to use, choose from the small icon variants from the ui-icons category from here https://icons.app.sbb.ch. | | `name` | `name` | public | `string` | | Name of the form element. Will be read from name attribute. | | `size` | `size` | public | `SbbTagSize` | `'m' / 's' (lean)` | Tag size, either s or m. |