Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/19h47/19h47-tabs
📂
https://github.com/19h47/19h47-tabs
javascript tab tablist tabs tabulation
Last synced: about 2 months ago
JSON representation
📂
- Host: GitHub
- URL: https://github.com/19h47/19h47-tabs
- Owner: 19h47
- Created: 2018-12-05T14:41:58.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T06:08:45.000Z (10 months ago)
- Last Synced: 2024-04-14T06:07:25.699Z (9 months ago)
- Topics: javascript, tab, tablist, tabs, tabulation
- Language: HTML
- Homepage: https://19h47.github.io/19h47-tabs/
- Size: 1.74 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @19h47/tabs
> Tabulation partout, tabulation nulle part
## Installation
```
yarn add @19h47/tabs
```
## Usage
```js
import Tabs from '@19h47/tabs';
const $element = document.querySelector('.js-tabs');
const tabs = new Tabs($element);
tabs.init();
```
### Tablist
The element that serves as a container for the set of tabs. The `role="tablist"` attribute is required.
The `aria-label=""` attribute provides a label that describes the purpose of the set of tabs.
```html
-
Home
-
Project
-
Contact
```
### Tab
An element in the tab list that serves as a label for one of the tab panels and can be activated to display that panel.
```html
Project
```
The `role="tab"` attribute is required.
The `aria-controls="foo-tab"` refers to the id of the tabpanel element associated with the tab.
Since an HTML button element is used for the tab, it is not necessary to set `tabindex="0"` on the selected (active) tab element.
Is the tabulation deletable ? You can set up this option by adding the `data-deletable` attribute on button.
To active the button on first load, add a `is-active` class to the button, remove the `tabindex` attribute and switch to `true` the `aria-selected` attribute.
### Tabpanel
The element that contains the content associated with a tab.
```html
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Nihil hic, vero. Fugiat voluptas
ex consequatur hic nemo officia iure placeat non, pariatur, dolore natus nobis, tempore
dolores dicta nisi inventore.
```
To active panel on first load, add a `is-active` class to it.
## Keyboard support
| Key | Function |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Tab |
- When focus moves into the tab list, places focus on the active tab element
- When the tab list contains the focus, moves focus to the next element in the tab sequence, which is the
tabpanelelement.
| Enter
Space | When a tab has focus, activates the tab, causing its associated panel to be displayed. |
| Right Arrow | When a tab has focus:
- Moves focus to the next tab.
- If focus is on the last tab, moves focus to the first tab.
| Left Arrow | When a tab has focus:
- Moves focus to the previous tab.
- If focus is on the first tab, moves focus to the last tab.
| Home
`fn + left arrow` | When a tab has focus, moves focus to the first tab. |
| End
`fn + right arrow` | When a tab has focus, moves focus to the last tab. |
| Delete | When focus is on the **Contact** tab, removes the tab from the tab list and places focus on the previous tab. |
## Options
| Option | Type | Default | Description |
| -------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| delay | integer | 0 | Determine whether there should be a delay when user navigates with the arrow keys |
| hash | boolean | true | |
| callback | function | () => {} | A callback fired right before `Tab.activate` event. Useful for animation or to fetch data for instance. Don't use arrow function if you need to access `this`. |
```javascript
import Tabs from '@19h47/tabs';
const $element = document.querySelector('.js-tabs');
const tabs = new Tabs($el, {
callback() {
return new Promise(resolve => {
// animate, fetch data, use this, do your stuff, etc.
resolve();
});
},
});
tabs.init();
```
## Events
| Event | Arguments | Description |
| ------------ | --------- | ----------------------------------------------------------------------------- |
| Tab.activate | event | Detail object containing current **controls** id, and current DOM **element** |
| Tab.delete | event | Detail object containing current **controls** id, and current DOM **element** |
```javascript
import Tabs from '@19h47/tabs';
const $element = document.querySelector('.js-tabs');
const tabs = new Tabs($element);
tabs.init();
tabs.tabs.forEach($tab => {
$tab.el.addEventListener('Tab.activate', ({ detail }) => {
const { controls, element } = detail;
console.log(controls, element);
});
$tab.el.addEventListener('Tab.delete', ({ detail }) => {
const { controls, element } = detail;
console.log(controls, element);
});
});
```
## Methods
| Method | |
| ----------- | ------- |
| `destroy()` | Destroy |
| `init()` | Create |
| `create()` | Create |
## Build Setup
```bash
# install dependencies
$ yarn install
# serve with hot reload at localhost:3000
$ yarn start
# build for production
$ yarn prod
```
## Example
An example is located right [here](https://19h47.github.io/19h47-tabs/), see [sources](/docs/index.html).
## Acknowledgments
- [Deciding When to Make Selection Automatically Follow Focus](https://www.w3.org/TR/wai-aria-practices/#kbd_selection_follows_focus)
- [Example of Tabs with Manual Activation](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/examples/tabs-manual/)
- [Example of Tabs with Automatic Activation](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/examples/tabs-automatic/)
- [Keycode](https://keycode.info/) by [Wes Bos](https://wesbos.com/)