mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
85 lines
2.7 KiB
TypeScript
85 lines
2.7 KiB
TypeScript
/*
|
|
* Copyright (c) 2016-2020 Martin Donath <martin.donath@squidfunk.com>
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to
|
|
* deal in the Software without restriction, including without limitation the
|
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
* sell copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
* IN THE SOFTWARE.
|
|
*/
|
|
|
|
import { SearchIndexConfig } from "../_"
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Types
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Search highlight function
|
|
*
|
|
* @param value - Value
|
|
*
|
|
* @return Highlighted value
|
|
*/
|
|
export type SearchHighlightFn = (value: string) => string
|
|
|
|
/**
|
|
* Search highlight factory function
|
|
*
|
|
* @param query - Query value
|
|
*
|
|
* @return Search highlight function
|
|
*/
|
|
export type SearchHighlightFactoryFn = (query: string) => SearchHighlightFn
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Functions
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Create a search highlighter
|
|
*
|
|
* @param config - Search index configuration
|
|
*
|
|
* @return Search highlight factory function
|
|
*/
|
|
export function setupSearchHighlighter(
|
|
config: SearchIndexConfig
|
|
): SearchHighlightFactoryFn {
|
|
const separator = new RegExp(config.separator, "img")
|
|
const highlight = (_: unknown, data: string, term: string) => {
|
|
return `${data}<mark data-md-highlight>${term}</mark>`
|
|
}
|
|
|
|
/* Return factory function */
|
|
return (query: string) => {
|
|
query = query
|
|
.replace(/[\s*+\-:~^]+/g, " ")
|
|
.trim()
|
|
|
|
/* Create search term match expression */
|
|
const match = new RegExp(`(^|${config.separator})(${
|
|
query
|
|
.replace(/[|\\{}()[\]^$+*?.-]/g, "\\$&")
|
|
.replace(separator, "|")
|
|
})`, "img")
|
|
|
|
/* Highlight string value */
|
|
return value => value
|
|
.replace(match, highlight)
|
|
.replace(/<\/mark>(\s+)<mark[^>]*>/img, "\$1")
|
|
}
|
|
}
|