Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Extends the String native object to have a slugify method, useful for url slugs.
JavaScript
branch: master
Failed to load latest commit information.
Source Adjusted dochead to YAML
README.md Update README.md
package.yml Adjusted dochead to YAML

README.md

String.Slugify

Extends the String native object to have a slugify method, useful for url slugs.

Screenshot

How to Use

String.Slugify extends the native String object, so it works on any ordinary string.

"slugify  ME    n%ø#w".slugify()

Returns "slugify-me-now"

Real world usage example

This example shows how you can use slugify on two text inputs to create valid slugs from an ordinary title field.

The title field <input id="title">, and the slug <input id="alias">.

We're listening to the change event on the slug input, and the keyup and keydown events additionally on the <input id="title"> element; This is to make the <input id="alias"> input update as you type the title and be slugified in the process:

    var aliasvalidator = function(){
        this.value = this.value.slugify();
    };
    var titlevalidator = function(){
        if(!$('alias').defaultValue) $('alias').value = this.value.slugify();
    };

    $('title').addEvents({'keyup': titlevalidator, 'keydown': titlevalidator, 'change': titlevalidator});
    $('alias').addEvents({'change': aliasvalidator});

Screenshots

Screenshot Screenshot

Something went wrong with that request. Please try again.