Zur Navigation Zum Inhalt Kontakt Menu Find component Overview Lyne Principles Foundation Accessibility Design System Guidelines Deutsch Français Italiano English Our design principles User-centred Recognisable Inclusive Reduced Holistic Self-explanatory Task-oriented Appropriate SBB Brand portal Logo Digital clock Rights of use Base colors Functional colors Off brand colors Icons Timetable icons Pictograms About accessibility Über diesen Guide Contact Further information Product Owner User Research Interaction Design Visual Design Development Content Design Testing What is a design system? Designing Coding FAQ Help Process Contribution Contact Overview Base Components Overview Releases Design Tokens Komponenten Overview Base Informationen Overview Base Components Sense & Purpose Community Assets Instructions Power-Apps Digital banner ads SAP Design Guidelines App Icons Autocomplete Info

What does the component do?

The component offers suggestions to the user during input, based on existing data or previous input, to make input easier and faster.

When should the component be used?

  • To improve the data input experience by suggesting possible/allowed inputs.
  • To increase the accuracy and consistency of the data input.
  • To reduce the time users need to fill in forms.


  • The component should not be used for small data sets (e.g. only 10 entries/options).
  • The autocomplete list should not display too many suggestions at once in order to maintain clarity (max. 10 suggestions).
  • Users should be able to ignore the autocomplete function and make their own entries.

Child Components

Anatomy of the component
Number Type Description Optional Info
1 Component sbb-form-field No
1a Standard-HTML label No
1b Standard-HTML input No
1c Component sbb-icon Yes Prefix
1d Component sbb-icon Yes Suffix
2 Component sbb-optgroup Yes
2a Text Label No
2b Component sbb-divider - Erscheint bei einer optgroup
3 Component sbb-option No
3a Text Value No
3b Component sbb-icon Yes


Option 1 Option 2 Option 3 Option 4 Option 5 Option 6
Indent label No Yes Background White Milk Iron Charcoal Black


Basic Negative
Basic Open Above
Borderless Negative
Floating Label
With Error
With Error Negative
Borderless Open Above
No Icon Space
With Option Group
Mixed Single Option With Option Group
Mixed Single Option With Option Group Negative
HTML-Markup kopiert.

The sbb-autocomplete is a component that can be used to display a panel of suggested options connected to a text input.

It's possible to set the element to which the component's panel will be attached using the origin prop,
and the input which will work as a trigger using the trigger prop.
Both accept an id or an element reference.

<!-- Origin element -->
<div id="autocomplete-origin">Another origin</div>

<!-- Trigger element -->
<input id="autocomplete-txt" placeholder="Another trigger element" />

<sbb-autocomplete origin="autocomplete-origin" trigger="autocomplete-txt">
  <sbb-option value="Option A">Option A</sbb-option>
  <sbb-option value="Option B">Option B</sbb-option>
  <sbb-option value="Option C">Option C</sbb-option>

In sbb-form-field

If the component is used within a sbb-form-field,
it will automatically connect to the native <input> as trigger and will display the option panel above or below the sbb-form-field.

<!-- Origin element -->
  <!-- Trigger element -->
  <input placeholder="Trigger element" />

    <sbb-option icon-name="clock-small" value="Option 1"> Option 1 </sbb-option>
    <sbb-option icon-name="clock-small" value="Option 2"> Option 2 </sbb-option>
    <sbb-option icon-name="clock-small" value="Option 3"> Option 3 </sbb-option>


Option highlight

By default, the autocomplete will highlight the label of the sbb-option in the panel, if it matches the typed text.
See the sbb-option for more details.

Option grouping

The displayed sbb-option can be collected into groups using sbb-optgroup element:

<!-- Origin element -->
  <!-- Trigger element -->
  <input placeholder="Trigger element" />

    <sbb-optgroup label="Group 1">
      <sbb-option icon-name="clock-small" value="Option 1"> Option 1 </sbb-option>
    <sbb-optgroup label="Group 2"> ... </sbb-optgroup>


The sbb-option emits the optionSelected event when selected via user interaction.

Keyboard interaction

The options panel opens on focus, click or input events on the trigger element, or on ArrowDown keypress;
it can be closed on backdrop click, or using the Escape or Tab keys.

Keyboard Action
Down Arrow Navigate to the next option. Open the panel, if closed.
Up Arrow Navigate to the previous option.
Enter Select the active option.
Escape Close the autocomplete panel.


The sbb-autocomplete implements the ARIA combobox interaction pattern.

The text input trigger specifies role="combobox" while the content of the pop-up applies role="listbox".
Because of this listbox pattern, you should not put other interactive controls, such as buttons or checkboxes, inside an autocomplete option.
Nesting interactive controls like this interferes with many assistive technologies.

The component preserves focus on the input trigger,
using aria-activedescendant to support navigation though the autocomplete options.


Name Attribute Privacy Type Default Description
negative negative public boolean false Negative coloring variant flag.
origin origin public string | HTMLElement | undefined The element where the autocomplete will attach; accepts both an element's id or an HTMLElement. If not set, will search for the first 'sbb-form-field' ancestor.
originElement - public HTMLElement Returns the element where autocomplete overlay is attached to.
preserveIconSpace preserve-icon-space public boolean | undefined Whether the icon space is preserved when no icon is set.
trigger trigger public string | HTMLInputElement | undefined The input element that will trigger the autocomplete opening; accepts both an element's id or an HTMLElement. By default, the autocomplete will open on focus, click, input or ArrowDown keypress of the 'trigger' element. If not set, will search for the first 'input' child of a 'sbb-form-field' ancestor.
triggerElement - public HTMLInputElement | undefined Returns the trigger element.


Name Privacy Description Parameters Return Inherited From
close public Closes the autocomplete. void SbbOpenCloseBaseElement
open public Opens the autocomplete. void SbbOpenCloseBaseElement


Name Type Description Inherited From
didClose CustomEvent<void> Emits whenever the sbb-autocomplete is closed. SbbOpenCloseBaseElement
didOpen CustomEvent<void> Emits whenever the sbb-autocomplete is opened. SbbOpenCloseBaseElement
willClose CustomEvent<void> Emits whenever the sbb-autocomplete begins the closing transition. Can be canceled. SbbOpenCloseBaseElement
willOpen CustomEvent<void> Emits whenever the sbb-autocomplete starts the opening transition. Can be canceled. SbbOpenCloseBaseElement

CSS Properties

Name Default Description
--sbb-autocomplete-z-index var(--sbb-overlay-default-z-index) To specify a custom stack order, the z-index can be overridden by defining this CSS variable. The default z-index of the component is set to var(--sbb-overlay-default-z-index) with a value of 1000.


Name Description
Use the unnamed slot to add sbb-option or sbb-optgroup elements to the sbb-autocomplete.
Imprint Contact Cookie settings