Show Menu
TOPICS×

Tabs Component

The Core Component Tabs Component allows organization of content onto multiple tabs.

Usage

The Tabs Component allows the content author to organize page content within multiple tabs.
The edit dialog allows the content author to define multiple tabs as well as set the active tab. Using the design dialog , the template author can define which components can be added to tabs and customize the styles.
Nested tab components (tabs within tabs) are supported.
Simple (non-nested) tab components can be located/selected using the content tree , however nested tabs can not be.

Deep Linking to a Panel

The Tabs and Accordion Components support linking directly to a panel within the component.
To do this:
  1. View the page with the component using the option in the page editor.
  2. Inspect the content of the page and identify the ID of the panel.
    • For example
      id="accordion-86196c94d3-item-ca319dbb0b"
  3. The ID becomes the anchor you can append to the URL using a hash (
    #
    ).
    • For example
      https://wknd.site/content/wknd/language-masters/en/magazine/western-australia.html#accordion-86196c94d3-item-ca319dbb0b
Navigating to the URL with the panel ID as anchor, the browser will scroll directly to the particular component and display the specified panel. If the panel is configured to not be expanded by default, it will be expanded automatically.

Version and Compatibility

The current version of the Tabs Component is v1, which was introduced with release 2.2.0 of the Core Components in October 2018, and is described in this document.
The following table details all supported versions of the component, the AEM versions with which the versions of the component is compatible, and links to documentation for previous versions.
Component Version
AEM 6.4
AEM 6.5
AEM as a Cloud Service
v1
Compatible
Compatible
Compatible
For more information about Core Component versions and releases, see the document Core Components Versions .

Sample Component Output

To experience the Tabs Component as well as see examples of its configuration options as well as HTML and JSON output, visit the Component Library .

Technical Details

The latest technical documentation about the Tabs Component can be found on GitHub .
Further details about developing Core Components can be found in the Core Components developer documentation .

Edit Dialog

The edit dialog allows the content author to create, rename, and rearrange tabs as well as define the active tab.

Items Tab

Use the
Add
button to open the component selector to choose which component to add as a tab. Once added, an entry is added to the list, which contains the following columns:
  • Icon
    - The icon of the component type of the tab for easy identification in the list. Mouse over to see the full component name as a tooltip.
  • Description
    - The description used as the text of the tab, defaulting to the name of the component selected for the tab.
  • Delete
    - Tap or click to delete the tab from the tab component.
  • Rearrange
    - Tap or click and drag to rearrange the order of the tabs.
If the viewport of the page is reduced so that the edit dialog becomes full screen, the
Add
button will be hidden. Components can still be added to the Tabs Component by dragging from the components browser and dropping on the Tabs Component in the page editor .

Properties Tab

  • Active Item
    - The content author can define which tab is active when the page is loaded.
    • With the
      Default
      option, the first tab will be selected.
  • ID
    - This option allows to control the unique identifier of the component in the HTML and in the Data Layer .
    • If left blank, a unique ID is automatically generated for you and can be found by inspecting the resulting page.
    • If an ID is specified, it is the responsibility of the author to make sure that it is unique.
    • Changing the ID can have an impact on CSS, JS and Data Layer tracking.

Accessibility Tab

On the
Accessibility
tab, values can be set for ARIA accessibility labels for the component.
  • Label
    - Value of an ARIA label attribute for the component

Select Panel

The content author can use the
Select Panel
option on the component toolbar to change to a different panel for editing as well as to easily rearrange the order of the tabs.
Once selecting the
Select Panel
option in the component toolbar, the configured tabs are displayed as a drop-down.
  • The list is ordered by the assigned arrangement of the tabs and is reflected in the numbering.
  • The component type of the tab is displayed first, followed by the description of the tab in lighter font.
  • Tapping or clicking an entry in the dropdown, switches the view in the editor to that tab.
  • The tabs can be rearranged in-place by using the drag handles.
Tabs are not selectable by the author when in
Edit
mode. Use mode or the option to interact with the tabs as a reader of the published content would.

Design Dialog

The design dialog allows the template author to define which components can be added as items to the tabs component as well as define which custom styles are available to the content author.

Allowed Components Tab

The
Allowed Components
tab is used to define which components can be added as items to the tabs component by the content author.
The Allowed Components tab functions in the same way as the tab of the same name when defining the policy and properties of a Layout Container in the Template Editor.

Styles Tab

The Tabs Component supports the AEM Style System .