onoffcanvas jQuery package
Please consider following this project's author, onokumus, and consider starring the project to show your :heart: and support.
Getting started
Install
Install with npm:$ npm install --save @onoffcanvas/jquery
Install with yarn:
$ yarn add @onoffcanvas/jquery
Usage
commonjs
const OnoffCanvas = require('@onoffcanvas/jquery');
const oc = new OnoffCanvas(element, options);
es2015 module or typescript
import OnoffCanvas from '@onoffcanvas/jquery';
const oc = new OnoffCanvas(element, options);
browser
- Include
onoffcanvas
StyleSheet
```html ```
- Include
onoffcanvas
plugin's code
- Add class
onoffcanvas
andid
attribute todiv
tag.
- Add trigger button: Be sure to add
data-toggle="onoffcanvas"
.
Canvas Options
- Position Options :
onoffcanvas
is in absolute position by default
is-fixed
to fixed position```html ```
- Direction Options :
onoffcanvas
is in full-screen by default
is-top
- is-right
- is-bottom
,
- is-left
- is-center
```html ```
- Opened/Closed Options :
onoffcanvas
is closed by default
is-open
to open.```html ```
- Hoverable Options :
onoffcanvas-container
to parent element
- add class is-hoverable
to onoffcanvas
```html
<div class="onoffcanvas is-hoverable" id="side-canvas"></div>
Trigger Options
- Type
href
```html toggle onoffcanvas ```
2. button with
data-target
```html toggle onoffcanvas ```
- Style
onoffcanvas
, add class onoffcanvas-toggler
```html ```
OR
```html ```
Author
onokumusLicense
Copyright © 2018, onokumus. Released under the MIT License.This file was generated by verb-generate-readme, v0.8.0, on September 19, 2018.