https://github.com/vmitsaras/js-offcanvas

A lightweight, flexible jQuery off-canvas navigation plugin which lets you create fully accessible sidebar or top/bottom sliding (or push) panels with keyboard interactions and ARIA attributes.
https://github.com/vmitsaras/js-offcanvas

a11y accessibility aria jquery jquery-offcanvas jquery-plugin navigation offcanvas wai-aria

Last synced: 3 months ago
JSON representation

A lightweight, flexible jQuery off-canvas navigation plugin which lets you create fully accessible sidebar or top/bottom sliding (or push) panels with keyboard interactions and ARIA attributes.

• Host: GitHub
• URL: https://github.com/vmitsaras/js-offcanvas
• Owner: vmitsaras
• License: mit
• Created: 2016-09-25T14:43:35.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-10-16T09:49:00.000Z (over 5 years ago)
• Last Synced: 2024-11-07T20:08:19.378Z (3 months ago)
• Topics: a11y, accessibility, aria, jquery, jquery-offcanvas, jquery-plugin, navigation, offcanvas, wai-aria
• Language: JavaScript
• Homepage: http://codepen.io/vmitsaras/pen/gwGwJE
• Size: 190 KB
• Stars: 269
• Watchers: 9
• Forks: 30
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# js-offcanvas 

[![Downloads](https://img.shields.io/npm/dt/js-offcanvas.svg)](https://www.npmjs.com/package/js-offcanvas) [![Version](https://img.shields.io/npm/v/js-offcanvas.svg)](https://www.npmjs.com/package/js-offcanvas) [![AMA](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](http://twitter.com/?status=@vmitsaras) 

jQuery accessible Offcanvas plugin, using ARIA

- [Wiki](https://github.com/vmitsaras/js-offcanvas/wiki)

- [Demo](http://codepen.io/vmitsaras/pen/gwGwJE)

## Why it is accessible

- It relies on ARIA Design pattern for Dialogs

- The tab key loops through all of the keyboard focusable items within the offcanvas

- You can close it using Esc.

## Features

- Uses CSS transforms & transitions.

- BEM c-offcanvas c-offcanvas--left is-open

- From Any Direction: left, right, top and bottom.

- Overlay, Reveal and Push.

- API & Events

- Package managers Bower & NPM

***

 https://github.com/vmitsaras/js-offcanvas/wiki

## Dependencies

* jQuery

---

## License

Licensed under the MIT license.