Tabs

<auro-tabs> is a HTML custom element for the purpose of showing a set of layered sections of content, known as tab panels, that display one panel of content at a time. Each tab panel has an associated tab element, that when activated, displays the panel. The list of tab elements is arranged along one edge of the currently displayed panel, most commonly the top edge.

UI development browser support

For the most up to date information on UI development browser support

Install

$ npm i @aurodesignsystem/auro-tabs

Design Token CSS Custom Property dependency

The use of any Auro custom element has a dependency on the Auro Design Tokens.

Define dependency in project component

Defining the component dependency within each component that is using the <auro-tabs> component.

import "@aurodesignsystem/auro-tabs";

Reference component in HTML

<auro-tabgroup variant="unstyled">
  <div slot="tabs">
    <auro-tab>
      Baggage Info
    </auro-tab>
    <auro-tab>
      Help
    </auro-tab>
    <auro-tab>
      More
    </auro-tab>
    <auro-tab>
      No Panel
    </auro-tab>
  </div>
  <div slot="panels">
    <auro-tabpanel>
      <span>Tab 1 Content</span>
    </auro-tabpanel>
    <auro-tabpanel><span>Tab 2 Content</span></auro-tabpanel>
    <auro-tabpanel><span>Tab 3 Content</span></auro-tabpanel>
  </div>
</auro-tabgroup>

Use CDN

In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.

<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-tabs@latest/+esm"></script>

auro-tabs use cases

The <auro-tabs> element should be used in situations where users:

• show a list of content without reloading the page or compromising on space
• need to organize large amount of content that can be separated

API Code Examples

Default auro-tabs

<auro-tabgroup variant="unstyled">
  <div slot="tabs">
    <auro-tab>
      Baggage Info
    </auro-tab>
    <auro-tab>
      Help
    </auro-tab>
    <auro-tab>
      More
    </auro-tab>
    <auro-tab>
      No Panel
    </auro-tab>
  </div>
  <div slot="panels">
    <auro-tabpanel>
      <span>Tab 1 Content</span>
    </auro-tabpanel>
    <auro-tabpanel><span>Tab 2 Content</span></auro-tabpanel>
    <auro-tabpanel><span>Tab 3 Content</span></auro-tabpanel>
  </div>
</auro-tabgroup>

Development

In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.

Please be sure to review the contribution guidelines for this project. Please make sure to pay special attention to the conventional commits section of the document.

Start development environment

Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the dev server.

$ npm run dev

Open localhost:8000

Testing

Automated tests are required for every Auro component. See .\test\auro-tabs.test.js for the tests for this component. Run npm run test to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See the testing documentation for more details.