Skip to content
A light-weight, responsive, mobile-like navigation menu plugin
JavaScript CSS
Branch: master
Clone or download
Latest commit 9e8d066 Jul 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist Refactoring Jul 14, 2019
docs Bug fix Jul 14, 2019
src Refactoring Jul 14, 2019
.gitignore Version 4 Oct 24, 2017
.prettierignore Refactoring Jul 14, 2019
babel.config.js Dependencies upgraded Jul 14, 2019
bower.json Refactoring Jul 14, 2019
license Dependencies upgraded Jul 14, 2019
package.json Refactoring Jul 14, 2019
prettier.config.js Dependencies upgraded Jul 14, 2019
readme.md Dependencies upgraded Jul 14, 2019
slinky.png Artwork updated Jul 12, 2018
webpack.config.js Dependencies upgraded Jul 14, 2019
yarn.lock Refactoring Jul 14, 2019

readme.md

Slinky

Rather sweet menus

A light-weight, responsive, mobile-like navigation menu plugin

Demo

Installation

Download the latest version. The files you need are

Bower

bower install jquery-slinky

Include these files

<link rel="stylesheet" src="bower_components/slinky/dist/slinky.min.css" />
<script src="bower_components/slinky/dist/slinky.min.js"></script>

NPM

npm install jquery-slinky

Include these files

<link rel="stylesheet" src="node_modules/slinky/dist/slinky.min.css" />
<script src="node_modules/slinky/dist/slinky.min.js"></script>

Usage

const slinky = $('.menu').slinky(options)

Options

Option Default Description
resize true Resize menu height to match content on navigation
speed 300 Animation speed in milliseconds
theme slinky-theme-default Slinky theme
title false Show title of sub menu

API

.home(animate)

Navigate back to the root menu

Option Default value Description
animate true Pass false to skip animation

.jump(target, animate)

Navigate to a sub menu

Option Default value Description
to Selector for ul target to jump to
animate true Pass false to skip animation

.destroy()

Remove Slinky

Tips

  • Set .active on a ul element to jump there on init
You can’t perform that action at this time.