https://github.com/schne324/logica11y

https://github.com/schne324/logica11y

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/schne324/logica11y
• Owner: schne324
• License: mit
• Created: 2017-04-06T00:22:47.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-10T02:56:47.000Z (over 7 years ago)
• Last Synced: 2024-08-08T15:47:14.168Z (5 months ago)
• Language: JavaScript
• Size: 74.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Logica11y

*NOTE*: This is very much a work in progress and should not be used yet.

Automated widget validation according the the ARIA Authoring Practices.  Validates attributes (initial and dynamic) as well as keyboard interaction.

## Installation

```bash

$ npm install logica11y

```

## Usage

### In the browser

```js

const logica11y = window.logica11y;

logica11y.tabs({

  tabs: '.tab'

}).then((result) => {

  console.log(result); // { valid: false, failures: [...], passes: [...] }

}).catch((err) => console.log(err));

```

### Browserify

```js

const logica11y = require('logica11y');

logica11y.tabs({

  tabs: '.tab'

}).then((result) => {

  console.log(result); // { valid: false, failures: [...], passes: [...] }

}).catch((err) => console.log(err));

```

## API

### logica11y.tabs

The tabs API returns a promise and accepts an options object:

- `tabs` {_Mixed_}: A selector for all tabs OR an array (or nodeList) of tab elements

- `timeout` {_Number_}: Time in ms it takes for panel to display upon tab activation (defaults to 0)