SpeakingURL

Generate a slug with a lot of options; create a so-called Semantic URL or 'Clean URL' or 'Pretty URL' or 'nice-looking URL' or 'Speaking URL' or 'user-friendly URL' or 'SEO-friendly URL' from a string. This module aims to transliterate the input string.

For use in browser and server - no dependencies!

NPM Badge

Installation

npm

1npm install speakingurl --save

yarn

1yarn add speakingurl --dev

Bower

1bower install --save speakingurl

Component

1component install pid/speakingurl

Ruby on Rails

1# Add to Gemfile
2gem 'speakingurl-rails'

Download Package

copy the file speakingurl.min.js to your script directory

CDN/cloudflare

available versions:

• www.cdnjs.com/libraries/speakingurl/
• use //cdnjs.cloudflare.com/ajax/libs/speakingurl/14.0.1/speakingurl.min.js

CDN/maxcdn

available versions:

• www.jsdelivr.com/#!speakingurl
• use //cdn.jsdelivr.net/npm/speakingurl@14.0.1/speakingurl.min.js

Usage

getSlug(input, [options]);

input: {string} to convert

options {object|string} config object or separator string (see below)

• options {object}

  • separator {string} default: '-'
    • char that replaces the whitespaces
  • lang {string|boolean} default: 'en' // ISO 639-1 Codes
    • language specific transliteration (
      • 'ar' // Arabic
      • 'az' // Azerbaijani*
      • 'cs' // Czech
      • 'de' // German
      • 'dv' // Divehi
      • 'en' // English
      • 'es' // Spanish
      • 'fa' // Persian
      • 'fi' // Finnish
      • 'fr' // French
      • 'ge' // Georgian
      • 'gr' // Greek*
      • 'hu' // Hungarian
      • 'it' // Italian
      • 'lt' // Lithuanian*
      • 'lv' // Latvian
      • 'my' // Burmese
      • 'mk' // Macedonian*
      • 'nl' // Dutch
      • 'pl' // Polish
      • 'pt' // Portuguese
      • 'ro' // Romanian
      • 'ru' // Russian
      • 'sv' // Swedish
      • 'sk' // Slovak
      • 'sr' // Serbian*
      • 'tr' // Turkish
      • 'uk' // Ukranian
      • 'vn' // Vietnamese
  • symbols {boolean} default: true
    • false -> don't convert symbols
    • true -> convert symbols according to the 'lang' setting
  • maintainCase {boolean} default: false
    • true -> maintain case chars
    • false -> convert all chars to lower case
  • titleCase {boolean|array} default: false
    • true -> convert input string to title-case
    • array -> titlecase = true, but omit the words from in the array
  • truncate {number} default: 0
    • 0 -> don't trim length
    • >= 1 -> trim to max length while not breaking any words
  • uric {boolean} default: false
    • true -> additionally allow chars: ";", "?", ":", "@", "&", "=", "+", "$", ",", "/"
    • false
  • uricNoSlash {boolean} default: false
    • true -> additionally allow chars: ";", "?", ":", "@", "&", "=", "+", "$", ","
  • mark {boolean} default: false
    • true -> additionally allow chars: "-", "_", ".", "!", "~", "*", "'", "(", ")"
  • custom {object|array} default: {}
    • object -> custom map for translation, overwrites all i.e. { '&': '#', '*': ' star ' }
    • array -> add chars to allowed charMap (see example)

• options {string} separator

notes: default only Base64 chars are allowed (/A-Za-z0-9_-/), setting uric, uricNoSlash or/and mark to true will add the specified chars to the list of allowed characters. The separator-character is always allowed.

Node.js

1var getSlug = require('speakingurl');

Browser

1<script src="bower_components/speakingurl/speakingurl.min.js"></script>

Ruby on Rails

1# Add to application.js
2//= require speakingurl

Examples

1var slug;
2
3slug = getSlug("Schöner Titel läßt grüßen!? Bel été !");
4console.log(slug); // Output: schoener-titel-laesst-gruessen-bel-ete
5
6slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", '*');
7console.log(slug); // Output: schoener*titel*laesst*gruessen*bel*ete
8
9slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
10        separator: '_'
11	});
12console.log(slug); // Output: schoener_titel_laesst_gruessen_bel_ete
13
14slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
15        uric: true
16	});
17console.log(slug); // Output: schoener-titel-laesst-gruessen?-bel-ete
18
19slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
20    	uricNoSlash: true
21	});
22console.log(slug); // Output: schoener-titel-laesst-gruessen?-bel-ete
23
24slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
25    	mark: true
26	});
27console.log(slug); // Output: schoener-titel-laesst-gruessen!-bel-ete-!
28
29slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
30    	truncate: 20
31	});
32console.log(slug); // Output: schoener-titel
33
34slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
35	    maintainCase: true
36	});
37console.log(slug); // Output: Schoener-Titel-laesst-gruessen-Bel-ete
38
39slug = getSlug("Äpfel & Birnen!", {
40	    lang: 'de'
41	});
42console.log(slug); // Output: aepfel-und-birnen
43
44slug = getSlug("မြန်မာ သာဓက", {
45	    lang: 'my'
46	});
47console.log(slug); // Output: myanma-thadak
48
49slug = getSlug('މިއަދަކީ ހދ ރީތި ދވހކވ', {
50        lang: 'dv'
51    });
52console.log(slug); // Output: miadhakee hd reethi dvhkv
53
54slug = getSlug("Apple & Pear!", {
55	    lang: 'en' // lang: "en" is default, just to clarify
56	});
57console.log(slug); // Output: apple-and-pear
58
59slug = getSlug('Foo & Bar * Baz', {
60	    custom: {
61	        '&': ' doo '
62	    },
63	    uric:true
64	});
65console.log(slug); // Output: foo-doo-bar-baz
66
67slug = getSlug('Foo ♥ Bar');
68console.log(slug); // Output: foo-love-bar
69
70slug = getSlug('Foo & Bar | (Baz) * Doo', {
71	    custom: {
72	        '*': 'Boo'
73	    },
74	    mark:true
75	});
76console.log(slug); // Output: foo-and-bar-or-(baz)-boo-doo
77
78slug = getSlug('Foo and Bar or Baz', {
79	    custom: {
80	        'and': 'und',
81	        'or': ''
82	    }
83	});
84console.log(slug); // Output: foo-und-bar-baz
85
86slug = getSlug('[Knöpfe]', {
87		custom: [
88			'[',
89			']'
90		]
91	});
92console.log(slug); // Output: [knoepfe]
93
94slug = getSlug('NEXUS4 only $299');
95console.log(slug); // Output: nexus-4-only-usd299
96
97slug = getSlug('NEXUS4 only €299', {
98	    maintainCase: true
99	});
100console.log(slug); // Output: NEXUS-4-only-EUR299
101
102slug = getSlug('Don\'t drink and drive', {
103	    titleCase: true
104	});
105console.log(slug); // Output: Don-t-Drink-And-Drive
106
107slug = getSlug('Don\'t drink and drive', {
108	    titleCase: ['and']
109	});
110console.log(slug); // Output: Don-t-Drink-and-Drive
111
112slug = getSlug('Foo & Bar ♥ Foo < Bar', {
113	    lang: false
114	});
115console.log(slug); // Output: foo-bar-foo-bar
116
117slug = getSlug('Foo & Bar ♥ Foo < Bar', {
118	    symbols: false
119	});
120console.log(slug); // Output: foo-bar-foo-bar
121
122slug = getSlug('ä♥ä', {
123		lang: 'tr',
124	    symbols: false
125	});
126console.log(slug); // Output: a

createSlug([options])

options: {object|string} config object or separator string (see above)

Create your own specially configured function.

1var options = {
2	    maintainCase: true,
3	    separator: '_'
4	};
5
6var mySlug = require('speakingurl').createSlug(options);
7// in browser:
8// var mySlug = createSlug(options);
9
10var slug = mySlug("Schöner Titel läßt grüßen!? Bel été !");
11console.log(slug); // Output: Schoener_Titel_laesst_gruessen_Bel_ete

Create your own specially configured function with title-case feature.

1var options = {
2	    titleCase: [
3	        "a","an","and","as","at","but",
4	        "by","en","for","if","in","nor",
5	        "of","on","or","per","the","to","vs"
6	    ]
7	};
8
9var mySlug = require('speakingurl').createSlug(options);
10// in browser:
11// var mySlug = createSlug(options);
12
13var slug = mySlug('welcome to the jungle');
14console.log(slug); // Output: Welcome-to-the-Jungle

Changelog

see CHANGELOG.md

Tests

1npm test

Contribution

1
2# fork pid/speakingurl on Github
3$ git clone git@github.com:<YOUR_USER>/speakingurl.git
4$ cd speakingurl
5$ npm install
6# add your stuff
7# add tests
8# add example for new feature
9# add release info to CHANGELOG.md
10# add description/example to README.md
11$ gulp
12$ commit files (speakingurl.min.js,...)
13# if everything works fine, commit, push to your repository
14# create pull request

Release

1$ gulp bumpup --patch  # --minor # --major
2$ gulp
3$ gulp release

Release to RubyGems.org

1$ gulp
2$ gem build speakingurl-rails.gemspec
3$ gem push speakingurl-rails-x.x.x.gem

References

• https://tools.ietf.org/html/rfc3986
• https://en.wikipedia.org/wiki/Transliteration

Use in other environments

• SpeakingURL with AngularJS
• SpeakingURL with Meteor
• SpeakingURL with Ruby on Rails

Ports

• Java https://github.com/Weltraumschaf/speakingurl thanks to@Weltraumschaf

Credits

• @dypsilon
• @simov
• @henrikjoreteg

License

The BSD 3-Clause License (BSD3)

Copyright (c) 2013-2017 Sascha Droste pid@posteo.net All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.