github-mirror/framework
2
0
Fork 0
mirror of https://github.com/flarum/framework.git synced 2025-02-11 15:11:46 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify the use-case of the JS slug helper

Browse Source
This commit is contained in:
Franz Liedke 2020-01-24 17:42:14 +01:00
parent a2cc49b1d9
commit f22ba99214
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
framework/core/js/src/common/utils/string.js
View File

@ -16,6 +16,10 @@ export function truncate(string, length, start = 0) {
* Create a slug out of the given string. Non-alphanumeric characters are * Create a slug out of the given string. Non-alphanumeric characters are
* converted to hyphens. * converted to hyphens.
* *
* NOTE: This method does not use the comparably sophisticated transliteration
* mechanism that is employed in the backend. Therefore, it should only be used
* to *suggest* slugs that can be overridden by the user.
*
* @param {String} string * @param {String} string
* @return {String} * @return {String}
*/ */