Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fork/vue-roving-tabindex

Add a roving tabindex to a Vue component
https://github.com/fork/vue-roving-tabindex

Last synced: 1 day ago
JSON representation

Add a roving tabindex to a Vue component

Awesome Lists containing this project

README

        

# `@4rk/vue-roving-tabindex`

Add a roving tabindex to a Vue component. This is useful to implement keyboard navigation inside components according to [WAI-ARIA](https://www.w3.org/TR/wai-aria-practices/#kbd_general_within).

## Installation

```javascript
import VueRovingTabindex from "@4rk/vue-roving-tabindex";

app.use(VueRovingTabindex);
```

## Usage

```vue


  • foo

  • bar

  • baz

```

## Directive API

The package provides two Vue directives:

### v-roving-tabindex-container

This directive denotes the boundary of a roving tabindex sequence. Add it to a parent element of the `v-roving-tabindex` elements.

It has a single boolean modifier to change the direction from vertical to horizontal:

```vue


```

### v-roving-tabindex

This directive should be used on every focussable element inside a `v-roving-tabindex-container` that is part of the roving tabindex.

Its value can be set to `false` to remove the element from the roving tabindex:

```vue