What does the component do?

A tag is a small labelling element that is used for categorisation and as a filter.

When should the component be used?

• To filter and categorise content according to certain criteria.
• To allow users to search content according to defined properties.
• To make the user interface clearer.

Rules

• Tags should be short and clearly labelled.
• Use a logical and intuitive order of tags to maximise usability.
• Avoid too many tags at once to ensure clarity.

Child Components

Examples

The sbb-tag-group component is used as a container for one or multiple sbb-tag components,
which are projected inside the unnamed slot.

To work properly, it's mandatory to provide a value to each sbb-tag.
See its documentation for more details.

<sbb-tag-group>
  <sbb-tag value="all">All</sbb-tag>
  <sbb-tag value="phones">Phones</sbb-tag>
  <sbb-tag value="computer">Computer</sbb-tag>
  <sbb-tag value="laptop">Laptop</sbb-tag>
</sbb-tag-group>

Style

The component has a size property which can be used to change the size of all the inner sbb-tag.
Two values are available, s and m, which is the default.

<sbb-tag-group size="m">
  <sbb-tag value="all">All</sbb-tag>
  <sbb-tag value="phones">Phones</sbb-tag>
  <sbb-tag value="computer">Computer</sbb-tag>
</sbb-tag-group>

<sbb-tag-group size="s">
  <sbb-tag value="all">All</sbb-tag>
  <sbb-tag value="phones">Phones</sbb-tag>
  <sbb-tag value="computer">Computer</sbb-tag>
</sbb-tag-group>

Interactions

Exclusive selection vs. multiple selection

By default, sbb-tag-group acts like a radio-button group: only one item can be selected.
In this mode, the value of the sbb-tag-group will reflect the value of the selected sbb-tag.

Setting multiple property to true allows multiple items to be selected (checkbox behavior).
In this mode the value of the sbb-tag-group is an array containing all values of the selected sbb-tag items.

<sbb-tag-group multiple>
  <sbb-tag value="all">All</sbb-tag>
  <sbb-tag value="phones" checked>Phones</sbb-tag>
  <sbb-tag value="computer" checked>Computer</sbb-tag>
  <sbb-tag value="laptop">Laptop</sbb-tag>
</sbb-tag-group>

Changing multiple property during run time

There is no support for changing multiple mode during run time (e.g., update value automatically).
So this flag should be provided at component's instantiation time.

Advanced usage: multiple and exclusive mixed

const uncheckAllTag = () => {
  document.getElementById('all').removeAttribute('checked');
};

const uncheckTags = () => {
  Array.from(document.querySelectorAll('sbb-tag'))
    .filter((e) => e.getAttribute('id') !== 'all' && !e.getAttribute('disabled'))
    .forEach((e) => e.removeAttribute('checked'));
};

<sbb-tag-group aria-label="Select your desired device to filter it" multiple>
  <sbb-tag id="all" onchange="uncheckTags()" value="All" checked> All </sbb-tag>
  <sbb-tag value="phones" onchange="uncheckAllTag()">Phones</sbb-tag>
  <sbb-tag value="computer" onchange="uncheckAllTag()">Computer</sbb-tag>
  <sbb-tag value="laptop" onchange="uncheckAllTag()">Laptop</sbb-tag>
</sbb-tag-group>

Accessibility

The property listAccessibilityLabel is forwarded as aria-label to the inner list that the component uses to display the tags,
to use the implicit role="list" of the ul.

If the listAccessibilityLabel property is not defined, the sbb-tag-group surrounding the buttons applies role="group"
to convey the association between the individual sbb-tags.

When using the role="group", each sbb-tag-group element should be given a label with aria-label or aria-labelledby,
that communicates the collective meaning of all sbb-tags.

<sbb-tag-group aria-label="Select your desired font styles to filter it">
  <sbb-tag value="all" checked>All</sbb-tag>
  <sbb-tag value="phones">Bold</sbb-tag>
  <sbb-tag value="computer">Italic</sbb-tag>
  <sbb-tag value="laptop">Underline</sbb-tag>
</sbb-tag-group>

Properties

Slots