Off-Canvas Sidebars

Description

This plugin will add various options to implement off-canvas sidebars in your WordPress theme based on 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!

You can find me here:

Actions | Filters | API

Credits

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

Ideas?

Please let me know through the support page!

Screenshots

  • Settings page
  • Sidebars settings page (sidebars closed)
  • Sidebars settings page (sidebar opened)
  • Shortcode generator page
  • Control Widget
  • Menu item
  • Sidebar left (Push effect) -> image from Slidebars website
  • Sidebar left (Overlay effect) -> image from Slidebars website
  • Sidebar top (Push effect) -> image from Slidebars website

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.

FAQ

Installation Instructions

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.

1. Will this plugin work with any theme?

No, due to the difference in structure not all theme’s are compatible.
Though most themes can be made compatible with some modifications!

2. Can I add as many sidebars as I like?

Yes you can, keep in mind that the more sidebars you add the heavier the load on the server (PHP) and browser (JS) will be.

3. How do I change the CSS for the sidebars?

This plugin only provides the framework that handles the off-canvas part.
There are some settings that slightly change the display but this is very limited.
For more advanced customisations either:
1. Edit your theme style.css file (usually located in /wp-content/themes/YOURTHEME/).
2. Use a plugin such as Simple Custom CSS.

Reviews

Awesome plugin and great support

I used this plugin to create a slide-in sidebar that included a menu and about info. It was super easy to install and saved me so much time. There was a minor bug which Jory fixed for me as soon as I brought it up. Legend!

Great plugin, great service

I used this for adding a second mobile menu that would replace the desktop sidebar pages menu. The plugin is very easy to work with. There was an issue with the plugin disabling some of my jQuery interactions so I asked Jory about it and he let me know it is a theme compatibility issue and sent me a link to his development branch in which he is working to address this. It worked perfectly with my theme which is ThemeBlvd Jumpstart. His communication is superb. Please donate to ongoing development if it works for you!

Effortless to install and easy to use

I really like Slidebars and thanks to this plugin, I was able to install it in on my site (genesis sample child theme) effortlessly and in no time.

I was wondering if I can change the direction of the slide out somewhere on the front end? I would really like to adjust the width as well (my menu is very simple and takes up little space). I started fiddling with the CSS, but I was wondering if there is an easier way…

Thanks again for writing the plugin

Seems pretty solid!

Works well. Haven’t had any issues, seems well executed. Nice function included to be able to implement trigger in menus. Good job! Feature request: It would be nice to create a unique short code or html link for novice users that appears when they “create a new sidebar” in the plugin settings. This way they can place the code wherever they want a trigger button outside of menu or widget.

Great plugin and support

Really easy to use plugin which does exactly what it says on the tin. Also comes with great support. I had a small user issue, emailed Jory and he responded with a solution very quickly!

Read all 7 reviews

Contributors & Developers

“Off-Canvas Sidebars” is open source software. The following people have contributed to this plugin.

Contributors

“Off-Canvas Sidebars” has been translated into 1 locale. Thank you to the translators for their contributions.

Translate “Off-Canvas Sidebars” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

0.4.2

  • Enhancement: Keep scrollbar visible when scroll lock is active. #44 & PR #45
  • Enhancement: (Slidebars library) Make sure that percentage based widths are rounded to actual pixels to prevent 1px differences on display.
  • Fix: PHP Notice on fixed_elements key.
  • Compatibility: Tested with WordPress 4.9

Detailed info: PR on GitHub

0.4.1

  • Fix: Loading the correct menu in an off-canvas sidebar was not working correctly. #37
  • Fix: Scroll lock feature with CSS instead of JavaScript. #39
  • Enhancement: Add active sidebar ID to the html element classes. #41

Detailed info: PR on GitHub

0.4

  • Feature: [ocs_trigger] shortcode to display trigger buttons/elements anywhere you like, click here for documentation. #24
    • Shortcode generator available in the settings page.
    • Integrate a shortcode generator with the WP Editor. #32
  • Enhancement: New “Legacy CSS” mode. Modified the Slidebars library to support older CSS2 animations. Can fix a lot of issues with fixed elements. #26
  • Compatibility: Modified the default Slidebars CSS to support anchor links and common smooth scroll implementations.
  • Compatibility: Some enhancements for compatibility with the WP Admin Bar.
  • UI: Improve widget UI #27
  • Fix: Enhance the codebase to be more aligned with the WP coding standards with CodeClimate.

Detailed info: PR on GitHub

0.3.1.1

  • Fix: Settings page checkbox bug when saving

0.3.1

  • Feature: Allow changing this plugin capability to show the settings page
  • Fix: Update fixed element compat for the new Slidebars version (still experimental, Slidebars still doesn’t fully support fixed elements within the site container)
  • Fix: Don’t echo empty sidebar CSS selectors if no styles are set
  • UI: Set .ocs-button to cursor: pointer; by default
  • Update textdomain hook

Detailed info: PR on GitHub

0.3

  • Feature: Allow sidebars to overwrite some general settings
  • Feature: Option to set padding to sidebars
  • Feature: Option to choose other content types than only a WP sidebar for an off-canvas sidebar
  • Feature: Option to set your own CSS prefix (some classes are fixes to ocs and can’t be changed, the prefix ocs is also the default prefix for new installations)
  • Feature: Added various actions, filters and JS hooks – Click here for info
  • Feature: OCS API functions to output off canvas sidebars in your theme instead of using this plugin frontend functions – Click here for info
  • Fix: Sidebar ID validation wasn’t correct

Detailed info: PR on GitHub

0.2.2

  • Feature: Option to set the animation speed for sidebars
  • Feature: Option to use the FastClick library – Click here for info
  • Fix: Disabling sidebars on global settings page didn’t work

0.2.1

  • Fix: Add touch events for iOS mobile device compatibility
  • Enhancement: Added some actions for front-end (see Other Notes)

0.2.0.1

  • Fix: Global variable bug
  • UI: Improve settings page

0.2

  • Update Slidebars plugin to v2.0.2: click here for info
  • Feature: An unlimited amount of off-canvas sidebars (No longer just one left, one right)
  • Feature: 2 new locations (top and bottom)
  • Feature: 2 new effects (reveal and shift)
  • UI: Improved settings pages
  • I18n: Translations are now managed at translate.wordpress.org
  • Screenshots updated
  • Tested with WordPress 4.6

0.1.2

  • Feature: First experiment for compatibility with fixed elements within the site container with the use of transform: translateZ (needed for -webkit- and -moz- only). See problem here
  • Improvement: Usage of a single instance of the class

0.1.1

  • Feature: Added the option to change the website_before and website_after hook names

0.1

Created from nothingness just to be one of the cool kids. Yay!