A permissive slug generator that works with unicode.
Package: uslug
Created by: jeremys
Last modified: Tue, 28 Jun 2022 06:59:57 GMT
Version: 1.0.4
Downloads: 153,495
Repository: https://github.com/jeremys/uslug
Install
npm install uslug
yarn add uslug
Uslug.js
Permissive slug generator that works with unicode.
We keep only characters from the categories Letter, Number and Separator (see Unicode Categories)
and the common CJK Unified Ideographs as defined in the version 6.0.0 of the Unicode specification.
Inspired by unicode-slugify.
Note that this slug generator is different from node-slug which focus on translating unicode characters to english or latin equivalent.
Quick Examples
uslug('Быстрее и лучше!') // 'быстрее-и-лучше'
uslug('汉语/漢語') // '汉语漢語'
uslug('Y U NO', { lower: false })) // 'Y-U-NO'
uslug('Y U NO', { spaces: true })) // 'y u no'
uslug('Y-U|NO', { allowedChars: '|' })) // 'yu|no'
Installation
npm install uslug
Options
uslug(string, options)
Generate a slug for the string passed.
Arguments
- string - The string you want to slugify.
- options - An optional object that can contain:
- allowedChars: a String of chars that you want to be whitelisted. Default: '-_~'.
- lower: a Boolean to force to lower case the slug. Default: true.
- spaces: a Boolean to allow spaces. Default: false.
License
This project is distributed under the MIT License. See LICENSE file for more information.
