Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: override prop in manifest #3307

Merged
merged 2 commits into from
Dec 18, 2024
Merged

docs: override prop in manifest #3307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bc8eb3
fix: override prop in manifest
DavideMininni-Fincons Dec 17, 2024
46d1616
docs: fix escape chars in readmes
DavideMininni-Fincons Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/elements/button/accent-button/readme.md
View file
Open in desktop
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` | | Returns the form owner of the internals of the target element. |
| `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
Open in desktop
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` | | Returns the form owner of the internals of the target element. |
| `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
Open in desktop
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` | | Returns the form owner of the internals of the target element. |
| `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
Open in desktop
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` | | Returns the form owner of the internals of the target element. |
| `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
Open in desktop
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` | | Returns the form owner of the internals of the target element. |
| `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
14 changes: 7 additions & 7 deletions src/elements/card/card-button/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ as it is used for search engines and screen-reader users.

## Properties

| Name | Attribute | Privacy | Type | Default | Description |
| -------- | --------- | ------- | ------------------------- | ---------- | -------------------------------------------------------------- |
| `active` | `active` | public | `boolean` | `false` | Whether the card is active. |
| `form` | `form` | public | `HTMLFormElement \| null` | | Returns the form owner of the internals of the target element. |
| `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. |
| 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. |
| `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. |

## Slots

Expand Down
2 changes: 1 addition & 1 deletion src/elements/core/base-elements/button-base-element.ts
View file
Open in desktop
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
16 changes: 8 additions & 8 deletions src/elements/datepicker/datepicker-next-day/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ both standalone or within the `sbb-form-field`, they must have the same parent e

## Properties

| Name | Attribute | Privacy | Type | Default | Description |
| ------------ | ------------- | ------- | ------------------------------------------- | ---------- | -------------------------------------------------------------- |
| `datePicker` | `date-picker` | public | `string \| SbbDatepickerElement<T> \| null` | `null` | Datepicker reference. |
| `form` | `form` | public | `HTMLFormElement \| null` | | Returns the form owner of the internals of the target element. |
| `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. |
| `value` | `value` | public | `string \| null` | `null` | Value of the form element. |
| 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. |
| `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. |
| `value` | `value` | public | `string \| null` | `null` | Value of the form element. |
16 changes: 8 additions & 8 deletions src/elements/datepicker/datepicker-previous-day/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ both standalone or within the `sbb-form-field`, they must have the same parent e

## Properties

| Name | Attribute | Privacy | Type | Default | Description |
| ------------ | ------------- | ------- | ------------------------------------------- | ---------- | -------------------------------------------------------------- |
| `datePicker` | `date-picker` | public | `string \| SbbDatepickerElement<T> \| null` | `null` | Datepicker reference. |
| `form` | `form` | public | `HTMLFormElement \| null` | | Returns the form owner of the internals of the target element. |
| `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. |
| `value` | `value` | public | `string \| null` | `null` | Value of the form element. |
| 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. |
| `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. |
| `value` | `value` | public | `string \| null` | `null` | Value of the form element. |
2 changes: 1 addition & 1 deletion src/elements/expansion-panel/expansion-panel-header/readme.md
View file
Open in desktop
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` | | Returns the form owner of the internals of the target element. |
| `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
Loading