search

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.
http://codepen.io/vmitsaras/pen/gwGwJE
MIT License
270 stars 30 forks source link

Inconsistencies between Website Demo/Guide and the Github #4

Closed GeorgeWL closed 6 years ago

GeorgeWL commented 7 years ago

On the Website the only listed Dependencies are:

On the Github the listed Dependencies are:

Which is it then? @vmitsaras

lribi commented 7 years ago

I also found an issue with the documentation. When initializing with jQuery you also need to add the class "js-offcanvas-trigger" to the trigger button. This isn't documented clearly enough.

GeorgeWL commented 7 years ago

@lrtr I'd say make it a seperate issue tbh.

lribi commented 7 years ago

From my view it's all connected, the documentation in general isn't that great. Now to your issue, I think it's only jQuery and Modernizr, if you use "js-offcanvas.pkgd.js" then the other three dependencies seem to be already included.

NuclearMachine commented 6 years ago

this application has a very confusing documentation or atleast not instructed properly

GeorgeWL commented 6 years ago

@vmitsaras It's a great library based on your demo...but it's so badly documented that it's not going to get many users if its not cleaned up.

please spend the time to cleanup the documentation and heck, why not refactor whilst you're at it?

vmitsaras commented 6 years ago

Hey Guys, thanks for the Feedback. Please check the updated documentation.