The sbb-journey-header is a component used to display the journey's details.
The component has two required properties, named origin and destination, which are the two ends of the journey.
An icon is placed between them: if the property roundTrip is set to false (default), the icon is
an arrow pointing to the destination, otherwise it is a double arrow to display the round-trip.
The component has a level property, which is passed to its inner sbb-title component;
it is rendered as a heading from h1 to h6. Default level is 3.
The component also has two sizes, named m (default) and l, and a negative background variant.
Accessibility
The component has some hidden elements in order to be correctly read from a screen-reader.
The following example will be read as (locale: ENG): Connection from Point A to Point B..
<sbb-journey-header origin="Point A" destination="Point B" />The following one will be read as (locale: ENG): Connection from Point A to Point B and back to Point A..
<sbb-journey-header origin="Point A" destination="Point B" round-trip="true"/>Usage
Basic usage, rendered as <h3>:
<sbb-journey-header origin="Point A" destination="Point B"/>Size l, rendered as <h1>:
<sbb-journey-header origin="Point A" destination="Point B" size="l" level="1"/>Negative variant, round-trip:
<sbb-journey-header origin="Point A" destination="Point B" round-trip="true" negative="true"/>Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
destination (required) | destination | Destination location for the journey header. | string | undefined |
level | level | Heading level of the journey header element (e.g. h1-h6). | "1" | "2" | "3" | "4" | "5" | "6" | '3' |
negative | negative | Negative coloring variant flag. | boolean | false |
origin (required) | origin | Origin location for the journey header. | string | undefined |
roundTrip | round-trip | Whether the journey is a round trip. If so, the icon changes to a round-trip one. | boolean | undefined |
size | size | Journey header size. | "l" | "m" | 'm' |
Dependencies
Used by
Depends on
Graph
graph TD;
sbb-journey-header --> sbb-title
sbb-journey-header --> sbb-icon
sbb-journey-summary --> sbb-journey-header
style sbb-journey-header fill:#f9f,stroke:#333,stroke-width:4px