Questa pagina non è disponibile nella lingua desiderata. Lingue disponibili:
If the href
property is set, it will internally be rendered as link, otherwise as a button.
If the <sbb-button>
is placed inside another action element (e.g. button, link, ...),
it is internally rendered as a <span>
in order to not break HTML structure.
It's also possible to set the <sbb-button>
manually into static state by applying is-static
property.
If the <sbb-button>
is placed inside an <sbb-form-field>
, it renders with the correct styling.
Usage
Simple button
<sbb-button>Button text</sbb-button>
Button with icon
<sbb-button icon-name="info">Button text</sbb-button>
Button with slotted icon
<sbb-button>
<sbb-icon slot="icon" name="info"></sbb-icon>
Button text
</sbb-button>
Accessibility
Use the accessibility properties in case of an icon only button to describe the purpose of the button for screen reader users.
Focus outline
Please make sure, that the focus outline appears in the correct color if using on a dark background.
You can set it by re-defining the css var on sbb-button
or any parent element:
sbb-button {
--sbb-focus-outline-color: var(--sbb-focus-outline-color-dark);
}
Properties
Property | Attribute | Description | Type | Default |
---|---|---|---|---|
disabled | disabled | Whether the button is disabled. | boolean | false |
download | download | Whether the browser will show the download dialog on click. | boolean | undefined |
form | form | The | string | undefined |
href | href | The href value you want to link to (if it is present, button becomes a link). | string | undefined |
iconName | icon-name | 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. | string | undefined |
isStatic | is-static | Set this property to true if you want only a visual representation of a button, but no interaction (a span instead of a link/button will be rendered). | boolean | false |
name | name | The name attribute to use for the button. | string | undefined |
negative | negative | Negative coloring variant flag. | boolean | false |
rel | rel | The relationship of the linked URL as space-separated link types. | string | undefined |
size | size | Size variant, either l or m. | "l" | "m" | 'l' |
target | target | Where to display the linked URL. | string | undefined |
type | type | The type attribute to use for the button. | "button" | "reset" | "submit" | undefined |
value | value | The value attribute to use for the button. | string | undefined |
variant | variant | Variant of the button, like primary, secondary etc. | "primary" | "secondary" | "tertiary" | "transparent" | 'primary' |
Slots
Slot | Description |
---|---|
"icon" | Slot used to display the icon, if one is set |
"unnamed" | Button Content |
Dependencies
Used by
- sbb-alert
- sbb-calendar
- sbb-dialog
- sbb-map-container
- sbb-navigation
- sbb-navigation-section
- sbb-notification
- sbb-toast
- sbb-tooltip
Depends on
Graph
graph TD;
sbb-button --> sbb-icon
sbb-alert --> sbb-button
sbb-calendar --> sbb-button
sbb-dialog --> sbb-button
sbb-map-container --> sbb-button
sbb-navigation --> sbb-button
sbb-navigation-section --> sbb-button
sbb-notification --> sbb-button
sbb-toast --> sbb-button
sbb-tooltip --> sbb-button
style sbb-button fill:#f9f,stroke:#333,stroke-width:4px