slugify

Slugify a string

Useful for URLs, filenames, and IDs.

It handles most major languages, including German (umlauts), Vietnamese, Arabic, Russian, and more.

Install

$ npm install @sindresorhus/slugify

Usage

1import slugify from '@sindresorhus/slugify';
2
3slugify('I ♥ Dogs');
4//=> 'i-love-dogs'
5
6slugify('  Déjà Vu!  ');
7//=> 'deja-vu'
8
9slugify('fooBar 123 $#%');
10//=> 'foo-bar-123'
11
12slugify('я люблю единорогов');
13//=> 'ya-lyublyu-edinorogov'

API

slugify(string, options?)

string

Type: string

String to slugify.

options

Type: object

separator

Type: string
Default: '-'

1import slugify from '@sindresorhus/slugify';
2
3slugify('BAR and baz');
4//=> 'bar-and-baz'
5
6slugify('BAR and baz', {separator: '_'});
7//=> 'bar_and_baz'
8
9slugify('BAR and baz', {separator: ''});
10//=> 'barandbaz'

lowercase

Type: boolean
Default: true

Make the slug lowercase.

1import slugify from '@sindresorhus/slugify';
2
3slugify('Déjà Vu!');
4//=> 'deja-vu'
5
6slugify('Déjà Vu!', {lowercase: false});
7//=> 'Deja-Vu'

decamelize

Type: boolean
Default: true

Convert camelcase to separate words. Internally it does fooBar → foo bar.

1import slugify from '@sindresorhus/slugify';
2
3slugify('fooBar');
4//=> 'foo-bar'
5
6slugify('fooBar', {decamelize: false});
7//=> 'foobar'

customReplacements

Type: Array<string[]>
Default: [ ['&', ' and '], ['🦄', ' unicorn '], ['♥', ' love '] ]

Add your own custom replacements.

The replacements are run on the original string before any other transformations.

This only overrides a default replacement if you set an item with the same key, like &.

1import slugify from '@sindresorhus/slugify';
2
3slugify('Foo@unicorn', {
4	customReplacements: [
5		['@', 'at']
6	]
7});
8//=> 'fooatunicorn'

Add a leading and trailing space to the replacement to have it separated by dashes:

1import slugify from '@sindresorhus/slugify';
2
3slugify('foo@unicorn', {
4	customReplacements: [
5		['@', ' at ']
6	]
7});
8//=> 'foo-at-unicorn'

Another example:

1import slugify from '@sindresorhus/slugify';
2
3slugify('I love 🐶', {
4	customReplacements: [
5		['🐶', 'dogs']
6	]
7});
8//=> 'i-love-dogs'

preserveLeadingUnderscore

Type: boolean
Default: false

If your string starts with an underscore, it will be preserved in the slugified string.

Sometimes leading underscores are intentional, for example, filenames representing hidden paths on a website.

1import slugify from '@sindresorhus/slugify';
2
3slugify('_foo_bar');
4//=> 'foo-bar'
5
6slugify('_foo_bar', {preserveLeadingUnderscore: true});
7//=> '_foo-bar'

preserveTrailingDash

Type: boolean
Default: false

If your string ends with a dash, it will be preserved in the slugified string.

For example, using slugify on an input field would allow for validation while not preventing the user from writing a slug.

1import slugify from '@sindresorhus/slugify';
2
3slugify('foo-bar-');
4//=> 'foo-bar'
5
6slugify('foo-bar-', {preserveTrailingDash: true});
7//=> 'foo-bar-'

preserveCharacters

Type: string[]
Default: []

Preserve certain characters.

It cannot contain the separator.

For example, if you want to slugify URLs, but preserve the HTML fragment # character.

1import slugify from '@sindresorhus/slugify';
2
3slugify('foo_bar#baz', {preserveCharacters: ['#']});
4//=> 'foo-bar#baz'

slugifyWithCounter()

Returns a new instance of slugify(string, options?) with a counter to handle multiple occurrences of the same string.

Example

1import {slugifyWithCounter} from '@sindresorhus/slugify';
2
3const slugify = slugifyWithCounter();
4
5slugify('foo bar');
6//=> 'foo-bar'
7
8slugify('foo bar');
9//=> 'foo-bar-2'
10
11slugify.reset();
12
13slugify('foo bar');
14//=> 'foo-bar'

Use-case example of counter

If, for example, you have a document with multiple sections where each subsection has an example.

1## Section 1
2
3### Example
4
5## Section 2
6
7### Example

You can then use slugifyWithCounter() to generate unique HTML id's to ensure anchors will link to the right headline.

slugify.reset()

Reset the counter

Example

1import {slugifyWithCounter} from '@sindresorhus/slugify';
2
3const slugify = slugifyWithCounter();
4
5slugify('foo bar');
6//=> 'foo-bar'
7
8slugify('foo bar');
9//=> 'foo-bar-2'
10
11slugify.reset();
12
13slugify('foo bar');
14//=> 'foo-bar'

Related

• slugify-cli - CLI for this module
• transliterate - Convert Unicode characters to Latin characters using transliteration
• filenamify - Convert a string to a valid safe filename