https://github.com/vadikom/smartmenus

Advanced jQuery website menu plugin. Mobile first, responsive and accessible list-based website menus that work on all devices.
https://github.com/vadikom/smartmenus

Last synced: 12 days ago
JSON representation

Advanced jQuery website menu plugin. Mobile first, responsive and accessible list-based website menus that work on all devices.

• Host: GitHub
• URL: https://github.com/vadikom/smartmenus
• Owner: vadikom
• License: mit
• Created: 2013-06-01T19:24:44.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-04-19T15:02:32.000Z (7 months ago)
• Last Synced: 2024-10-31T07:04:29.719Z (12 days ago)
• Language: HTML
• Homepage: http://www.smartmenus.org
• Size: 1.17 MB
• Stars: 593
• Watchers: 50
• Forks: 163
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
# SmartMenus

Advanced jQuery website menu plugin. Mobile first, responsive and accessible list-based website menus that work on all devices.

Check out [the demo page](http://vadikom.github.io/smartmenus/src/demo/).

## Quick start

- [Download the latest release](http://www.smartmenus.org/download/).

- Install with [Bower](http://bower.io): `bower install smartmenus`.

- Install with [npm](https://www.npmjs.com): `npm install smartmenus`.

- Clone the repo: `git clone https://github.com/vadikom/smartmenus.git`.

Check out the [project documentation](http://www.smartmenus.org/docs/) for quick setup instructions, API reference, tutorials and more.

## Addons usage as modules

If you need to use any of the addons from the "addons" directory as an AMD or CommonJS module:

### AMD

Make sure your SmartMenus jQuery plugin module is named `smartmenus` since the addons require that name. For example, in RequireJS you may need to add this in your config:

```javascript

requirejs.config({

  "paths": {

    'smartmenus': 'jquery.smartmenus.min'

  }

  // ...

```

### CommonJS (npm)

The addons are available as separate npm packages so you could properly install/require them in your project in addition to `jquery` and `smartmenus`:

- Bootstrap 4 Addon: `npm install smartmenus-bootstrap-4`

- Bootstrap Addon: `npm install smartmenus-bootstrap`

- Keyboard Addon: `npm install smartmenus-keyboard`

#### Example with npm + Browserify

package.json:

```javascript

{

  "name": "myapp-using-smartmenus",

  "version": "1.0.0",

  "license": "MIT",

  "dependencies": {

    "jquery": ">=2.1.3",

    "smartmenus": ">=1.1.0",

    "smartmenus-keyboard": ">=0.4.0"

  },

  "devDependencies": {

    "browserify": ">=9.0.3"

  }

}

```

entry.js:

```javascript

var jQuery = require('jquery');

require('smartmenus');

require('smartmenus-keyboard');

jQuery(function() {

  jQuery('#main-menu').smartmenus();

});

```

Run browserify to create bundle.js: `browserify entry.js > bundle.js`

## Homepage

## Documentation

## Community and support

- Visit the [Community forums](http://www.smartmenus.org/forums/) for free support.

- [Premium support](http://www.smartmenus.org/support/premium-support/) is also available.

- Read and subscribe to [the project blog](http://www.smartmenus.org/blog/).

- Follow [@vadikom on Twitter](http://twitter.com/vadikom).

## Bugs and issues

For bugs and issues only please. For support requests please use the [Community forums](http://www.smartmenus.org/forums/) or contact us directly via our [Premium support](http://www.smartmenus.org/support/premium-support/).