Skip to content

Commit

Permalink
docs: fix escape chars in readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
@DavideMininni-Fincons
DavideMininni-Fincons committed Dec 17, 2024
1 parent 7bc8eb3 commit 46d1616
Show file tree
Hide file tree
Showing 19 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion src/elements/button/accent-button/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
2 changes: 1 addition & 1 deletion src/elements/button/button/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
2 changes: 1 addition & 1 deletion src/elements/button/mini-button/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
2 changes: 1 addition & 1 deletion src/elements/button/secondary-button/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
2 changes: 1 addition & 1 deletion src/elements/button/transparent-button/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
2 changes: 1 addition & 1 deletion src/elements/card/card-button/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
2 changes: 1 addition & 1 deletion src/elements/core/base-elements/button-base-element.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ abstract class SbbButtonBaseElement extends SbbFormAssociatedMixin(SbbActionBase
return (this.getAttribute('type') as SbbButtonType) ?? 'button';
}

/** The <form> element to associate the button with. */
/** The `<form>` element to associate the button with. */
@property()
public override set form(value: string) {
this._formId = value;
Expand Down
2 changes: 1 addition & 1 deletion src/elements/datepicker/datepicker-next-day/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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<T> \| null` | `null` | Datepicker reference. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
2 changes: 1 addition & 1 deletion src/elements/datepicker/datepicker-previous-day/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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<T> \| null` | `null` | Datepicker reference. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
2 changes: 1 addition & 1 deletion src/elements/expansion-panel/expansion-panel-header/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
2 changes: 1 addition & 1 deletion src/elements/form-field/form-field-clear/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
2 changes: 1 addition & 1 deletion src/elements/header/header-button/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <form> element to associate the button with. |
| `form` | `form` | public | `HTMLFormElement \| null` | | The `<form>` 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. |
Expand Down
Loading

0 comments on commit 46d1616

Please sign in to comment.