mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2026-07-23 14:23:39 -04:00
Refactored header title component
This commit is contained in:
42
src/assets/javascripts/components/header/_/index.ts
Normal file
42
src/assets/javascripts/components/header/_/index.ts
Normal file
@@ -0,0 +1,42 @@
|
||||
/*
|
||||
* 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 { OperatorFunction, pipe } from "rxjs"
|
||||
import { shareReplay, switchMap } from "rxjs/operators"
|
||||
|
||||
import { Header, watchHeader } from "observables"
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
* Functions
|
||||
* ------------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Mount header from source observable
|
||||
*
|
||||
* @return Header observable
|
||||
*/
|
||||
export function mountHeader(): OperatorFunction<HTMLElement, Header> {
|
||||
return pipe(
|
||||
switchMap(watchHeader),
|
||||
shareReplay(1)
|
||||
)
|
||||
}
|
||||
@@ -20,23 +20,5 @@
|
||||
* IN THE SOFTWARE.
|
||||
*/
|
||||
|
||||
import { OperatorFunction, pipe } from "rxjs"
|
||||
import { shareReplay, switchMap } from "rxjs/operators"
|
||||
|
||||
import { Header, watchHeader } from "observables"
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
* Functions
|
||||
* ------------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Mount header from source observable
|
||||
*
|
||||
* @return Header observable
|
||||
*/
|
||||
export function mountHeader(): OperatorFunction<HTMLElement, Header> {
|
||||
return pipe(
|
||||
switchMap(watchHeader),
|
||||
shareReplay(1)
|
||||
)
|
||||
}
|
||||
export * from "./_"
|
||||
export * from "./title"
|
||||
|
||||
75
src/assets/javascripts/components/header/title/index.ts
Normal file
75
src/assets/javascripts/components/header/title/index.ts
Normal file
@@ -0,0 +1,75 @@
|
||||
/*
|
||||
* 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 { Observable, OperatorFunction, pipe } from "rxjs"
|
||||
import { map, switchMap } from "rxjs/operators"
|
||||
|
||||
import {
|
||||
Header,
|
||||
Viewport,
|
||||
getElementOrThrow,
|
||||
paintHeaderTitle,
|
||||
watchViewportAt
|
||||
} from "observables"
|
||||
|
||||
import { useComponent } from "../../_"
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
* Helper types
|
||||
* ------------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Mount options
|
||||
*/
|
||||
interface MountOptions {
|
||||
header$: Observable<Header> /* Header observable */
|
||||
viewport$: Observable<Viewport> /* Viewport observable */
|
||||
}
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
* Functions
|
||||
* ------------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Mount header title from source observable
|
||||
*
|
||||
* @param options - Options
|
||||
*
|
||||
* @return Header title observable
|
||||
*/
|
||||
export function mountHeaderTitle(
|
||||
{ header$, viewport$ }: MountOptions
|
||||
): OperatorFunction<HTMLElement, any> {
|
||||
return pipe(
|
||||
switchMap(el => useComponent("main")
|
||||
.pipe(
|
||||
map(main => getElementOrThrow("h1, h2, h3, h4, h5, h6", main)),
|
||||
switchMap(headline => watchViewportAt(headline, { header$, viewport$ })
|
||||
.pipe(
|
||||
map(({ offset: { y } }) => y >= headline.offsetHeight),
|
||||
paintHeaderTitle(el)
|
||||
)
|
||||
)
|
||||
)
|
||||
)
|
||||
)
|
||||
}
|
||||
@@ -27,7 +27,7 @@ import {
|
||||
Header,
|
||||
Viewport,
|
||||
paintHideable,
|
||||
watchViewportFrom
|
||||
watchViewportAt
|
||||
} from "observables"
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
@@ -68,7 +68,7 @@ export function mountHero(
|
||||
{ header$, viewport$ }: MountOptions
|
||||
): OperatorFunction<HTMLElement, Hero> {
|
||||
return pipe(
|
||||
switchMap(el => watchViewportFrom(el, { header$, viewport$ })
|
||||
switchMap(el => watchViewportAt(el, { header$, viewport$ })
|
||||
.pipe(
|
||||
paintHideable(el, 20),
|
||||
map(hidden => ({ hidden }))
|
||||
|
||||
@@ -24,12 +24,7 @@ import { Observable, OperatorFunction, combineLatest, pipe } from "rxjs"
|
||||
import { map, shareReplay, switchMap } from "rxjs/operators"
|
||||
|
||||
import { SearchResult } from "integrations/search"
|
||||
import {
|
||||
Key,
|
||||
SearchQuery,
|
||||
Viewport,
|
||||
WorkerHandler
|
||||
} from "observables"
|
||||
import { Key, SearchQuery, WorkerHandler } from "observables"
|
||||
import { SearchMessage } from "workers"
|
||||
|
||||
import { useComponent } from "../_"
|
||||
@@ -57,7 +52,6 @@ export interface Search {
|
||||
* Mount options
|
||||
*/
|
||||
interface MountOptions {
|
||||
viewport$: Observable<Viewport> /* Viewport observable */
|
||||
keyboard$: Observable<Key> /* Keyboard observable */
|
||||
}
|
||||
|
||||
@@ -74,7 +68,7 @@ interface MountOptions {
|
||||
* @return Search observable
|
||||
*/
|
||||
export function mountSearch(
|
||||
handler: WorkerHandler<SearchMessage>, { viewport$, keyboard$ }: MountOptions
|
||||
handler: WorkerHandler<SearchMessage>, { keyboard$ }: MountOptions
|
||||
): OperatorFunction<HTMLElement, Search> {
|
||||
return pipe(
|
||||
switchMap(() => {
|
||||
@@ -88,14 +82,14 @@ export function mountSearch(
|
||||
/* Mount search query */
|
||||
const query$ = useComponent<HTMLInputElement>("search-query")
|
||||
.pipe(
|
||||
mountSearchQuery(handler, { reset$ }),
|
||||
mountSearchQuery(handler),
|
||||
shareReplay(1)
|
||||
)
|
||||
|
||||
/* Mount search result */
|
||||
const result$ = useComponent("search-result")
|
||||
.pipe(
|
||||
mountSearchResult(handler, { query$, viewport$, keyboard$ })
|
||||
mountSearchResult(handler, { query$, keyboard$ })
|
||||
)
|
||||
|
||||
/* Combine into a single hot observable */
|
||||
|
||||
@@ -37,7 +37,6 @@ import { SearchResult } from "integrations/search"
|
||||
import {
|
||||
Key,
|
||||
SearchQuery,
|
||||
Viewport,
|
||||
WorkerHandler,
|
||||
getActiveElement,
|
||||
getElements,
|
||||
@@ -64,7 +63,6 @@ import { useComponent } from "../../_"
|
||||
*/
|
||||
interface MountOptions {
|
||||
query$: Observable<SearchQuery> /* Search query observable */
|
||||
viewport$: Observable<Viewport> /* Viewport observable */
|
||||
keyboard$: Observable<Key> /* Keyboard observable */
|
||||
}
|
||||
|
||||
@@ -81,8 +79,7 @@ interface MountOptions {
|
||||
* @return Operator function
|
||||
*/
|
||||
export function mountSearchResult(
|
||||
{ rx$ }: WorkerHandler<SearchMessage>,
|
||||
{ query$, viewport$, keyboard$ }: MountOptions
|
||||
{ rx$ }: WorkerHandler<SearchMessage>, { query$, keyboard$ }: MountOptions
|
||||
): OperatorFunction<HTMLElement, SearchResult[]> {
|
||||
const toggle$ = useToggle("search")
|
||||
return pipe(
|
||||
@@ -90,7 +87,7 @@ export function mountSearchResult(
|
||||
const container = el.parentElement!
|
||||
|
||||
/* Compute whether there are more search results to fetch */
|
||||
const fetch$ = watchElementOffset(container, { viewport$ })
|
||||
const fetch$ = watchElementOffset(container)
|
||||
.pipe(
|
||||
map(({ y }) => {
|
||||
return y >= container.scrollHeight - container.offsetHeight - 16
|
||||
|
||||
@@ -27,7 +27,7 @@ import {
|
||||
Header,
|
||||
Viewport,
|
||||
paintHideable,
|
||||
watchViewportFrom
|
||||
watchViewportAt
|
||||
} from "observables"
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
@@ -75,7 +75,7 @@ export function mountTabs(
|
||||
|
||||
/* Mount tabs above screen breakpoint */
|
||||
if (screen) {
|
||||
return watchViewportFrom(el, { header$, viewport$ })
|
||||
return watchViewportAt(el, { header$, viewport$ })
|
||||
.pipe(
|
||||
paintHideable(el, 10),
|
||||
map(hidden => ({ hidden }))
|
||||
|
||||
Reference in New Issue
Block a user