@simplyhexagonal/simple-strings
v2.0.0
Published
Convenient functions to normalize strings with international special characters (diacritics)
Downloads
460
Maintainers
Readme
Simple Strings
Convenient functions to normalize strings with international special characters (diacritics).
Great for creating url-safe strings, i.e. normalize header titles into url slugs.
Open source notice
This project is open to updates by its users, I ensure that PRs are relevant to the community. In other words, if you find a bug or want a new feature, please help us by becoming one of the contributors ✌️ ! See the contributing section
Like this module? ❤
Please consider:
- Buying me a coffee ☕
- Supporting Simply Hexagonal on Open Collective 🏆
- Starring this repo on Github 🌟
Install
pnpm i @simplyhexagonal/simple-strings
# or
yarn add @simplyhexagonal/simple-strings
# or
npm install @simplyhexagonal/simple-strings
Usage
import {
removeDiacritics,
makeUrlSafe,
simpleSearchTermIndex,
} from '@simplyhexagonal/simple-strings';
console.log(
removeDiacritics('¿¡Árvíztűrő tükörfúrógép!?')
);
// ¿¡Arvizturo tukorfurogep!?
console.log(
makeUrlSafe('¿¡Árvíztűrő tükörfúrógép!?')
);
// arvizturo-tukorfurogep
console.log(
simpleSearchTermIndex('bee ¿¡Árvíztűrő -minus +"include, this" ')
);
// arvizturo bee +"include this" -minus
Browser
<script src="https://cdn.jsdelivr.net/npm/@simplyhexagonal/simple-strings@latest/dist/simple-strings.min.js"></script>
<script>
const {
removeDiacritics,
makeUrlSafe,
simpleSearchTermIndex,
} = SimpleStrings;
alert(
removeDiacritics('¿¡Árvíztűrő tükörfúrógép!?')
);
// ¿¡Arvizturo tukorfurogep!?
alert(
makeUrlSafe('¿¡Árvíztűrő tükörfúrógép!?')
);
// arvizturo-tukorfurogep
alert(
simpleSearchTermIndex('bee ¿¡Árvíztűrő -minus +"include, this" ')
);
// arvizturo bee +"include this" -minus
</script>
Contributing
Yes, thank you! This plugin is community-driven, most of its features are from different authors.
Please update the docs and tests and add your name to the simple-strings.json
file.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
License
Copyright (c) 2021-Present Simple Strings Contributors. Licensed under the Apache License 2.0.