Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 2.24 KB

README.md

File metadata and controls

67 lines (42 loc) · 2.24 KB

SIDEBAR

Commitizen friendly lerna code style: prettier

Sidebar is a collection of javascript packages distributed via the npm registry. It aims to simplicity and to provide a range of tool that allow users to implement sidebar (or side navs) in their web apps!


Packages


Demo

You can play with all sidebars in this codepen collection.

simpler-sidebar

simpler-sidebar is the most downloaded package. It's a jQuery plugin that allows to create a side nav as in modern mobile apps. It aims to simplicity so that everybody can use it no matter if expert programmers or not. It is written entirely in javascript so that you won't need to include any css file and the only css you must adds is not even required!

// Install

// with npm
npm install simpler-sidebar

// with yarn
yarn add simpler-sidebar

The full documentation is available here.

simpler-sidebar-css3

simpler-sidebar-css3 is a fork of simpler-sidebar plugin. The difference between the two is that this package doesn't use jquery animation method but it uses CSS3 animations! This should make this package less brutal against memory! Options differ slightly so read the documentation first if you intend to migrate to this package!

// Install

// with npm
npm install @ctrlmaniac/simpler-sidebar-css3

// with yarn
yarn add @ctrlmaniac/simpler-sidebar-css3

The full documentation is available here.

vanilla-sidebar

vanilla is a simple sidebar package written in plain vanilla javascript. It aims to have no dependencies!

// install

// with npm
npm install @ctrlmaniac/vanilla-sidebar

// with yarn
yarn add @ctrlmaniac/vanilla-sidebar