mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2026-07-29 01:02:42 -04:00
Refactored main and header observables
This commit is contained in:
squidfunk
@@ -21,4 +21,5 @@
|
||||
*/
|
||||
|
||||
export * from "./_"
|
||||
export * from "./main"
|
||||
export * from "./search"
|
||||
|
||||
74
src/assets/javascripts/components2/main/index.ts
Normal file
74
src/assets/javascripts/components2/main/index.ts
Normal file
@@ -0,0 +1,74 @@
|
||||
/*
|
||||
* 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 { shareReplay, switchMap } from "rxjs/operators"
|
||||
|
||||
import {
|
||||
Header,
|
||||
Main,
|
||||
Viewport,
|
||||
paintHeaderShadow,
|
||||
watchMain
|
||||
} from "observables"
|
||||
|
||||
import { useComponent } from "../_"
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
* Helper types
|
||||
* ------------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Mount options
|
||||
*/
|
||||
interface MountOptions {
|
||||
header$: Observable<Header> /* Header observable */
|
||||
viewport$: Observable<Viewport> /* Viewport observable */
|
||||
}
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
* Functions
|
||||
* ------------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Mount main area from source observable
|
||||
*
|
||||
* @param options - Options
|
||||
*
|
||||
* @return Main area observable
|
||||
*/
|
||||
export function mountMain(
|
||||
{ header$, viewport$ }: MountOptions
|
||||
): OperatorFunction<HTMLElement, Main> {
|
||||
return pipe(
|
||||
switchMap(el => useComponent("header")
|
||||
.pipe(
|
||||
switchMap(header => watchMain(el, { header$, viewport$ })
|
||||
.pipe(
|
||||
paintHeaderShadow(header)
|
||||
)
|
||||
)
|
||||
)
|
||||
),
|
||||
shareReplay(1)
|
||||
)
|
||||
}
|
||||
@@ -1,128 +0,0 @@
|
||||
// /*
|
||||
// * 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, combineLatest, pipe } from "rxjs"
|
||||
// import { map, shareReplay, switchMap } from "rxjs/operators"
|
||||
|
||||
// import { switchMapIf } from "extensions"
|
||||
// import { Agent, getElements } from "utilities"
|
||||
|
||||
// import { HeaderState } from "../../header"
|
||||
// import {
|
||||
// MainState,
|
||||
// SidebarState,
|
||||
// paintSidebar,
|
||||
// watchSidebar
|
||||
// } from "../../main"
|
||||
// import {
|
||||
// AnchorList,
|
||||
// paintAnchorList,
|
||||
// watchAnchorList
|
||||
// } from "../anchor"
|
||||
|
||||
// /* ----------------------------------------------------------------------------
|
||||
// * Types
|
||||
// * ------------------------------------------------------------------------- */
|
||||
|
||||
// /**
|
||||
// * Table of contents
|
||||
// */
|
||||
// export interface TableOfContents {
|
||||
// sidebar: SidebarState /* Sidebar state */
|
||||
// anchors: AnchorList /* Anchor list */
|
||||
// }
|
||||
|
||||
// /* ----------------------------------------------------------------------------
|
||||
// * Helper types
|
||||
// * ------------------------------------------------------------------------- */
|
||||
|
||||
// /**
|
||||
// * Options
|
||||
// */
|
||||
// interface Options {
|
||||
// header$: Observable<Header> /* Header observable */
|
||||
// main$: Observable<Main> /* Main area observable */
|
||||
// }
|
||||
|
||||
// /* ----------------------------------------------------------------------------
|
||||
// * Functions
|
||||
// * ------------------------------------------------------------------------- */
|
||||
|
||||
// /**
|
||||
// * Watch table of contents
|
||||
// *
|
||||
// * @param el - Table of contents element
|
||||
// * @param agent - Agent
|
||||
// * @param options - Options
|
||||
// *
|
||||
// * @return Table of contents observable
|
||||
// */
|
||||
// export function watchTableOfContents(
|
||||
// el: HTMLElement, agent: Agent, { header$, main$ }: Options
|
||||
// ): Observable<TableOfContents> {
|
||||
|
||||
// /* Watch and paint sidebar */
|
||||
// const sidebar$ = watchSidebar(el, agent, { main$ })
|
||||
// .pipe(
|
||||
// paintSidebar(el)
|
||||
// )
|
||||
|
||||
// /* Watch and paint anchor list (scroll spy) */
|
||||
// const els = getElements<HTMLAnchorElement>(".md-nav__link", el)
|
||||
// const anchors$ = watchAnchorList(els, agent, { header$ })
|
||||
// .pipe(
|
||||
// paintAnchorList(els)
|
||||
// )
|
||||
|
||||
// /* Combine into a single hot observable */
|
||||
// return combineLatest([sidebar$, anchors$])
|
||||
// .pipe(
|
||||
// map(([sidebar, anchors]) => ({ sidebar, anchors }))
|
||||
// )
|
||||
// }
|
||||
|
||||
// /* ------------------------------------------------------------------------- */
|
||||
|
||||
// /**
|
||||
// * Mount table of contents from source observable
|
||||
// *
|
||||
// * @param agent - Agent
|
||||
// * @param options - Options
|
||||
// *
|
||||
// * @return Operator function
|
||||
// */
|
||||
// export function mountTableOfContents(
|
||||
// agent: Agent, options: Options
|
||||
// ): OperatorFunction<HTMLElement, TableOfContents> {
|
||||
// const { media } = agent
|
||||
// return pipe(
|
||||
// switchMap(el => media.tablet$
|
||||
// .pipe(
|
||||
// switchMap(tablet => {
|
||||
// return watchTableOfContents(el, agent, options)
|
||||
// })
|
||||
// )
|
||||
// ),
|
||||
// switchMapIf(media.tablet$, el => watchTableOfContents(el, agent, options)),
|
||||
// shareReplay(1)
|
||||
// )
|
||||
// }
|
||||
Reference in New Issue
Block a user