Files
mkdocs-material/src/overrides/assets/javascripts/components/iconsearch/_/index.ts
2024-05-03 18:50:43 +02:00

117 lines
3.5 KiB
TypeScript

/*
* Copyright (c) 2016-2024 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 { BehaviorSubject, Observable, fromEvent, map, merge } from "rxjs"
import { configuration } from "~/_"
import { requestJSON } from "~/browser"
import {
Component,
getComponentElement,
getComponentElements
} from "../../_"
import {
IconSearchQuery,
mountIconSearchQuery
} from "../query"
import {
IconSearchResult,
mountIconSearchResult
} from "../result"
/* ----------------------------------------------------------------------------
* Types
* ------------------------------------------------------------------------- */
/**
* Icon category
*/
export interface IconCategory {
base: string /* Category base URL */
data: Record<string, string> /* Category data */
}
/**
* Icon search index
*/
export interface IconSearchIndex {
icons: IconCategory /* Icons */
emojis: IconCategory /* Emojis */
}
/* ------------------------------------------------------------------------- */
/**
* Icon search
*/
export type IconSearch =
| IconSearchQuery
| IconSearchResult
/**
* Icon search mode
*/
export type IconSearchMode =
| "all"
| "icons"
| "emojis"
/* ----------------------------------------------------------------------------
* Functions
* ------------------------------------------------------------------------- */
/**
* Mount icon search
*
* @param el - Icon search element
*
* @returns Icon search component observable
*/
export function mountIconSearch(
el: HTMLElement
): Observable<Component<IconSearch>> {
const config = configuration()
const index$ = requestJSON<IconSearchIndex>(
new URL("assets/javascripts/iconsearch_index.json", config.base)
)
/* Retrieve query and result components */
const query = getComponentElement("iconsearch-query", el)
const result = getComponentElement("iconsearch-result", el)
/* Retrieve select component */
const mode$ = new BehaviorSubject<IconSearchMode>("all")
const selects = getComponentElements("iconsearch-select", el)
for (const select of selects) {
fromEvent(select, "change").pipe(
map(ev => (ev.target as HTMLSelectElement).value as IconSearchMode)
)
.subscribe(mode$)
}
/* Create and return component */
const query$ = mountIconSearchQuery(query)
const result$ = mountIconSearchResult(result, { index$, query$, mode$ })
return merge(query$, result$)
}