mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2026-08-04 19:45:08 -04:00
98 lines
3.0 KiB
TypeScript
98 lines
3.0 KiB
TypeScript
/*
|
|
* Copyright (c) 2016-2019 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, of, pipe } from "rxjs"
|
|
import {
|
|
distinctUntilKeyChanged,
|
|
finalize,
|
|
shareReplay,
|
|
tap
|
|
} from "rxjs/operators"
|
|
|
|
import { Container } from "../../container"
|
|
import { resetHeaderShadow, setHeaderShadow } from "../element"
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Types
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Header
|
|
*/
|
|
export interface Header {
|
|
sticky: boolean /* Header stickyness */
|
|
height: number /* Header visible height */
|
|
}
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Functions
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Create an observable to watch the 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
|
|
*
|
|
* @return Header observable
|
|
*/
|
|
export function watchHeader(
|
|
el: HTMLElement
|
|
): Observable<Header> {
|
|
const sticky = getComputedStyle(el)
|
|
.getPropertyValue("position") === "fixed"
|
|
|
|
/* Return header as hot observable */
|
|
return of({
|
|
sticky,
|
|
height: sticky ? el.offsetHeight : 0
|
|
})
|
|
.pipe(
|
|
shareReplay({ bufferSize: 1, refCount: true })
|
|
)
|
|
}
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Paint header shadow from source observable
|
|
*
|
|
* @param el - Header element
|
|
*
|
|
* @return Operator function
|
|
*/
|
|
export function paintHeaderShadow(
|
|
el: HTMLElement
|
|
): MonoTypeOperatorFunction<Container> {
|
|
return pipe(
|
|
distinctUntilKeyChanged("active"),
|
|
tap(({ active }) => {
|
|
setHeaderShadow(el, active)
|
|
}),
|
|
finalize(() => {
|
|
resetHeaderShadow(el)
|
|
})
|
|
)
|
|
}
|