jquery-slugger
A jQuery plugin to auto generate a url friendly slug ('slugger' as in slugify
is already taken).
Getting Started
This guide will help you install and use jQuery Slugger. It should work on jQuery v1.2.3 and above.
Installation
via bower:
bower install jquery-slugger
via npm:
npm install jquery-slugger
or download or clone on GitHub.
Usage
Just add it to your project and identify the elements using data-slugger
.
- Sample use case (basic):
Title <!-- auto initialize via data-slugger --> Slug <!-- jQuery Slugger, by default, will target all `[name=slug]` --> ...<!-- jQuery is, of course, a dependency --><!-- Our main man here -->
- Using a custom target:
Title <!-- auto initialize via data-slugger --> Slug URL
- Using a custom separator:
Full Name <!-- auto initialize via `data-slugger`, `data-slug-separator` is for defining custom space replacer --> Username
Options
The plugin have options you can modify. Below is the list of options with their default values:
$('#slugger-element').slugger({
bindToEvent: 'keypress keyup', // The event to bind to.
target: '[name=slug]',
separator: '-',
convertToLowerCase: true,
isUrlFriendly: true,
beforeConvert: function (self) {},
afterConvert: function (self) {},
debug: false,
});
Deployment
Copy the /dist/*.min.js folder to your project
Versioning
The project uses SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- John Lioneil Dionisio
See also the list of contributors who participated in this project.
License
Acknowledgment
- Various resources.
- to the Muses of Inspiration.