https://github.com/rmariuzzo/dom-navigator

⚓️ JS library that allow keyboard navigation through DOM elements (←↑→↓).
https://github.com/rmariuzzo/dom-navigator

dom javascript jquery jquery-plugin navigation

Last synced: 3 months ago
JSON representation

⚓️ JS library that allow keyboard navigation through DOM elements (←↑→↓).

• Host: GitHub
• URL: https://github.com/rmariuzzo/dom-navigator
• Owner: rmariuzzo
• License: mit
• Created: 2014-08-12T21:04:56.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-10-13T11:38:51.000Z (about 6 years ago)
• Last Synced: 2024-10-17T12:22:53.925Z (3 months ago)
• Topics: dom, javascript, jquery, jquery-plugin, navigation
• Language: JavaScript
• Homepage: http://rmariuzzo.github.io/dom-navigator/
• Size: 391 KB
• Stars: 42
• Watchers: 7
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DOM Navigator

> Library that allow keyboard navigation through DOM elements (←↑→↓).

[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/rmariuzzo/dom-navigator)

## Installation

#### Bower

```sh

bower install dom-navigator --save

```

#### NPM

```sh

npm install dom-navigator --save

```

#### Manual

 1. [Download the latest release](https://github.com/rmariuzzo/dom-navigator/releases).

 2. Then include `dom-navigator-###.min.js` into your HTML page.

## Usage

#### Pure JavaScript

```js

var el = document.querySelector('#grid');

new DomNavigator(el);

```

#### jQuery

If jQuery is included you can use the library as a jQuery plugin:

```js

var el = $('#grid');

el.domNavigator();

```

## Want to contribute?

All help are more than welcome!

#### Pre-requisites

 - [Node.js](http://nodejs.org/).

 - [Grunt](http://gruntjs.com/).

#### Development Workflow

 1. **[Fork](https://github.com/rmariuzzo/dom-navigator/fork)** this respository.

 2. **Clone** your fork and create a feature branch from develop.

        git clone [email protected]:/dom-navigator.git

        git fetch origin

        git checkout develop

        git checkout -b feature-

 3. **Install** development dependencies.

        npm install

        bower install

 4. **Code** and be happy!

 5. **Test** your code using QUnit `grunt test`.

 6. Submit a **pull request** and grab popcorn.

### Credits

**dom-navigator** was created by [Rubens Mariuzzo](http://github.com/rmariuzzo) with all the love in the world.