Awesome Open Source
Awesome Open Source

Off-Canvas Sidebars

Add off-canvas sidebars using the Slidebars jQuery plugin.

WordPress Plugin version WordPress Plugin WP tested version WordPress Plugin downloads WordPress Plugin rating Travis Code Climate
License Donate Project Stats

Off-Canvas Sidebars

Description

This plugin will add various options to implement off-canvas sidebars in your WordPress theme using the Slidebars jQuery plugin.

Overview / Features

  • Add off-canvas sidebars to the left, right, top and bottom of your website
  • Use sidebar areas (widget-ready areas), menu locations or custom hooks to place content into the off-canvas sidebars
  • You can add control buttons with a widget, menu item, shortcode or with custom code
  • Various customisation options and settings available in the Appearances menu

Compatibility (IMPORTANT!)

The structure of your theme is of great importance for this plugin. Please read the installation guide carefully!!

This plugin should work with most themes and plugins although I can't be sure for all use-cases. At this point it's still a 0.x version... If the plugin does not work for your theme, please let me know through the support and add a plugins and themes list and I will take a look!

Fixed elements (like sticky menu's)

There are known issues with fixed elements and Slidebars. Click here for more information I've created two possible solutions for this:

  1. Legacy CSS solution. Use basic CSS2 positioning instead of CSS3 transform with hardware acceleration.
  2. JavaScript solution. It is slower but still allows the use of hardware acceleration.

It's not working! / I found a bug!

Please let me know through support and add a plugins and themes list! :)
Or submit an issue here on GitHub

Credits

  • Slidebars jQuery plugin by Adam, thank you for this great plugin!

Translations

Please help translating this plugin on https://translate.wordpress.org/projects/wp-plugins/off-canvas-sidebars!

Installation

Installation of this plugin works like any other plugin out there. Either:

  1. Upload the zip file to the '/wp-content/plugins/' directory
  2. Activate the plugin through the 'Plugins' menu in WordPress

Or search for "Off-Canvas Sidebars" via your plugins menu.

Theme setup

Off-Canvas Sidebars won't work "out of the box" with most themes, please read the documentation! Click here for theme setup documentation.

Actions | Filters | API

Other Notes

You can find me here:


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Php (404,763
Wordpress (7,519
Wordpress Plugin (3,435
Related Projects