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

Convert highlight helper to Typescript (#2532)

Browse Source
This commit is contained in:
daniellesniak 2021-01-23 22:43:40 +01:00 committed by GitHub
parent fbdc36dfbd
commit 912a0381c3
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
framework/core/js/src/common/helpers/highlight.js → framework/core/js/src/common/helpers/highlight.tsx
View File

@ -1,16 +1,16 @@
import * as Mithril from 'mithril';
import { truncate } from '../utils/string'; import { truncate } from '../utils/string';
/** /**
* The `highlight` helper searches for a word phrase in a string, and wraps * The `highlight` helper searches for a word phrase in a string, and wraps
* matches with the <mark> tag. * matches with the <mark> tag.
* *
* @param {String} string The string to highlight. * @param string The string to highlight.
* @param {String|RegExp} phrase The word or words to highlight. * @param phrase The word or words to highlight.
* @param {Integer} [length] The number of characters to truncate the string to. * @param [length] The number of characters to truncate the string to.
* The string will be truncated surrounding the first match. * The string will be truncated surrounding the first match.
* @return {Object}
*/ */
export default function highlight(string, phrase, length) { export default function highlight(string: string, phrase: string | RegExp, length?: number): Mithril.Vnode<any, any> | string {
if (!phrase && !length) return string; if (!phrase && !length) return string;
// Convert the word phrase into a global regular expression (if it isn't // Convert the word phrase into a global regular expression (if it isn't