node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org »



npm-version travis-ci coveralls-status

var slugify = require('slugify')
slugify('some string') // some-string 
// if you prefer something other than '-' as separator 
slugify('some string', '_')  // some_string 
  • Vanilla ES5 JavaScript
  • No dependencies
  • Coerces foreign symbols to their english equivalent (check out the charMap in index.js for more details)
  • Works in the browser (window.slugify) and AMD/CommonJS-flavored module loaders


slugify('some string', {
  replacement: '-',    // replace spaces with replacement 
  remove: null,        // regex to remove characters 
  lower: true          // result in lower case 

For example to remove *+~.()'"!:@ from the result slug, you can use slugify('..', {remove: /[$*_+~.()'"!\-:@]/g})


Out of the box slugify comes with support for a handfull of Unicode symbols. For example the (radioactive) symbol is not defined in the charMap object in index.js and therefore it will be stripped by default:

slugify('unicode ♥ is ☢') // unicode-love-is 

However you can extend the supported symbols, or override the existing ones with your own:

slugify.extend({'': 'radioactive'})
slugify('unicode ♥ is ☢') // unicode-love-is-radioactive 

Keep in mind that the extend method extends/overrides the default charMap for the entire process. In case you need a fresh instance of the slugify's charMap object you have to clean up the module cache first:

delete require.cache[require.resolve('slugify')]
var slugify = require('slugify')

This module was originally a vanilla javascript port of node-slug.
Note that the original slug module has been ported to vanilla javascript too.
One major difference between the two modules is that slugify does not depend on the external unicode module.