mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
118 lines
3.3 KiB
TypeScript
118 lines
3.3 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 {
|
|
MonoTypeOperatorFunction,
|
|
Observable,
|
|
animationFrameScheduler,
|
|
of,
|
|
pipe
|
|
} from "rxjs"
|
|
import {
|
|
distinctUntilKeyChanged,
|
|
finalize,
|
|
observeOn,
|
|
switchMap,
|
|
tap
|
|
} from "rxjs/operators"
|
|
|
|
import { Viewport } from "browser"
|
|
|
|
import { Header, HeaderType } from "../_"
|
|
import {
|
|
resetHeaderTitleActive,
|
|
setHeaderTitleActive
|
|
} from "../set"
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Helper types
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Watch options
|
|
*/
|
|
interface WatchOptions {
|
|
viewport$: Observable<Viewport> /* Viewport observable */
|
|
}
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Functions
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Watch header
|
|
*
|
|
* The header is wrapped in an observable to pave the way for auto-hiding or
|
|
* other dynamic behaviors that may be implemented later on.
|
|
*
|
|
* @param el - Header element
|
|
* @param options - Options
|
|
*
|
|
* @return Header observable
|
|
*/
|
|
export function watchHeader(
|
|
el: HTMLElement, { viewport$ }: WatchOptions
|
|
): Observable<Omit<Header, "type">> {
|
|
return viewport$
|
|
.pipe(
|
|
distinctUntilKeyChanged("size"),
|
|
switchMap(() => {
|
|
const styles = getComputedStyle(el)
|
|
const sticky = [
|
|
"sticky", /* Modern browsers */
|
|
"-webkit-sticky" /* Old Safari */
|
|
].includes(styles.position)
|
|
return of({
|
|
sticky,
|
|
height: sticky ? el.offsetHeight : 0
|
|
})
|
|
})
|
|
)
|
|
}
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Apply header title type
|
|
*
|
|
* @param el - Header title element
|
|
*
|
|
* @return Operator function
|
|
*/
|
|
export function applyHeaderType(
|
|
el: HTMLElement
|
|
): MonoTypeOperatorFunction<HeaderType> {
|
|
return pipe(
|
|
|
|
/* Defer repaint to next animation frame */
|
|
observeOn(animationFrameScheduler),
|
|
tap(type => {
|
|
setHeaderTitleActive(el, type === "page")
|
|
}),
|
|
|
|
/* Reset on complete or error */
|
|
finalize(() => {
|
|
resetHeaderTitleActive(el)
|
|
})
|
|
)
|
|
}
|