Accessible, responsive, themeable, small footprint tabs web component
<aria-tabs> is a customizable tabs web-component/custom-element. Simply load the script, e.g. in your document's
<head> and add checkboxes to your document.
Okay, it's probably not that simple.
AriaTabs is a class that handles the ARIA (i.e. accessibility) aspect of tabs.
<aria-tabs> comes with two themes:
looks basically like a classical tabs, just themed and with some gradients
is a material design tabs variant
Each comes with a simple theming interface. Decide which one to use. If you are happy with the look and feel just include the respective file, add you colors and enjoy:
What File to Load
You only need to load one file. Which one that is depends on your specific needs. As noted above,
<aria-tabs> comes with two pre-built themes. Thus first you should decide which theme to choose or if you want to build your own customized variant.
The pre-built dist (distribution) files are in the NPM package but not in the GitHub sources. If you loaded the latter you need to do
npm i; npm run build to get them.
If you build your own, you should
import AriaTabs from '.../src/aria-tabs.mjs' and do your own build. If you build a web application with static source code (as opposed to a page that is dynamically assembled by server side rendering) you should import the source version of your chosen themed tabs and have a custom build for your app.
If you want to use a pre-build tabs decide which and next decide which build to load. Each theme comes with three builds.
<aria-tabs> uses the ShadowQuery micro library to simplify web component implementation. Two builds bundle it, one doesn't. If you use more stuff that also needs ShadowQuery use the version where it's not bundled. That way you don't have to load it multiple times.
- *.min.mjs minified EcmaScript Module without ShadowQuery
- *.min.js minified ES6 script file with ShadowQuery bundled - use for all modern browsers except Edge
- *.IE.min.js babel-transpiled ES5 for IE (and possibly Edge?) with ShadowQuery bundled
File sizes (gzipped): the minified tabs without ShadowQuery are ~4K, with ShadowQuery ~6K and transpiled with ShadowQuery ~16K.
Deployment & Polyfills
Older versions of current browsers and IE don't fully support web components and may miss modern language features. For the former you need to load a polyfill, for the latter you need to load the transpiled
In addition I strongly recommend that you load the polyfills only where required and don't load transpiled code for browsers that don't need it! Transpiled means that the code went through babel. The code is twice as big and slower than the native ES6 ... and simply won't work in at least some modern browsers.
Theming & Customization
If you want to theme/customize
aria-tabs you'll need to write your own component and inherit from the
AriaTabs base class. In your constructor you can - and should - pass a template to the
AriaTabs contructor. That way you can generate the custom DOM you need, along with your styles. Please check the default template exported by
aria-tabs.mjs and check the (really simple) implementation of
aria-tabsMaterial.mjs to learn how this is done.
In addition the are some methods you may want to override in order to get you custom style for all aspects of the tabs:
get deleteButtonTemplate()to create a custom delete button on the tabs
get tabTemplate()to customize tab DOM
renderTabs(labels)chances are, if you want a custom tab template, that template also requires custom initialization. Check the implementation of
aria-tabsMaterial.mjsfor an example. You don't need
get tabTemplate()if you implement
Note on IE
If you want to support IE you will need to coax the ShadyCSS polyfill to actually handle your component. If you just need a custom main template, just define your component as shown in
aria-tabsClassic.mjs and you're fine. If you need more, check
aria-tabsMaterial.mjs. It uses the
iniCss export from
aria-tabs.mjs to handle that.
makes all tabs deletable if attribute is present
will show last opened tab (index!) when re-opening page. Pass a string that will be used as an ID for the persistent data. Uses
when present, arrow key navigation will not activate but just focus tabs, activation then happens with space or enter key (useful for tabs that load additional content like whole sub-applcations)
optional delay when navigating with arrow keys - ignored when
on the tab-panels, sets the title of the tab-button
Several attributes on the associated DOM are set automatically for accessibility support.
aria-tabs automatically initializes several properties - for its own use and for inheriting (customized) tabs.
Attribute readers for the respective
None so far.
CSS custom properties
These are specific to the theme you use for the box. The shipped themes support the following:
background color of inactive tab button
background color of active tab button
text color of inactive tab button
text color of active tab button
flex mode of tablist when not scrolling (space-between, space-around, start, end, center ...)
highlight color for active tab
highlight color for focussed tab
border around tab buttons and panels
shadow of tab buttons and panels
Public methods should be considered
protected - they are there to allow inheriting classes to customize certain aspects of
On first rendering and on the change of certain attributes, initialize is called. If you overwrite this method in an inherited class you'll most likely need to call
initialize- before, after, or in between your initialization code
- get tabTemplate()
returns the template (string) for the tab-buttons
if you want a custom
tabTemplateyou likely need custom initialization of the tab buttons. Check aria-tabsMaterial.mjs on how to do this.
- get deleteButtonTemplate()
returns the template for tab-delete buttons
- delete(tab) delete a tab
See W3C example.