mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2026-08-01 02:08:46 -04:00
Improved overall structure
This commit is contained in:
@@ -21,11 +21,12 @@
|
||||
*/
|
||||
|
||||
import * as ClipboardJS from "clipboard"
|
||||
import { NEVER, Observable, fromEventPattern } from "rxjs"
|
||||
import { shareReplay } from "rxjs/operators"
|
||||
import { NEVER, Observable, Subject, fromEventPattern } from "rxjs"
|
||||
import { mapTo, shareReplay, tap } from "rxjs/operators"
|
||||
|
||||
import { getElements } from "observables"
|
||||
import { renderClipboard } from "templates"
|
||||
import { translate } from "utilities"
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
* Helper types
|
||||
@@ -36,6 +37,7 @@ import { renderClipboard } from "templates"
|
||||
*/
|
||||
interface SetupOptions {
|
||||
document$: Observable<Document> /* Document observable */
|
||||
dialog$: Subject<string> /* Dialog subject */
|
||||
}
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
@@ -53,7 +55,7 @@ interface SetupOptions {
|
||||
* @return Clipboard observable
|
||||
*/
|
||||
export function setupClipboard(
|
||||
{ document$ }: SetupOptions
|
||||
{ document$, dialog$ }: SetupOptions
|
||||
): Observable<ClipboardJS.Event> {
|
||||
if (!ClipboardJS.isSupported())
|
||||
return NEVER
|
||||
@@ -74,9 +76,15 @@ export function setupClipboard(
|
||||
new ClipboardJS(".md-clipboard").on("success", next)
|
||||
})
|
||||
|
||||
// TODO: integrate rendering of dialog
|
||||
/* Display notification upon clipboard copy */
|
||||
clipboard$
|
||||
.pipe(
|
||||
tap(ev => ev.clearSelection()),
|
||||
mapTo(translate("clipboard.copied"))
|
||||
)
|
||||
.subscribe(dialog$)
|
||||
|
||||
/* */
|
||||
/* Return clipboard as hot observable */
|
||||
return clipboard$
|
||||
.pipe(
|
||||
shareReplay(1)
|
||||
|
||||
90
src/assets/javascripts/integrations/dialog/index.ts
Normal file
90
src/assets/javascripts/integrations/dialog/index.ts
Normal file
@@ -0,0 +1,90 @@
|
||||
/*
|
||||
* 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 { Subject, animationFrameScheduler } from "rxjs"
|
||||
import {
|
||||
delay,
|
||||
map,
|
||||
observeOn,
|
||||
switchMap,
|
||||
tap
|
||||
} from "rxjs/operators"
|
||||
|
||||
import { useComponent } from "components"
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
* Types
|
||||
* ------------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Setup options
|
||||
*/
|
||||
interface SetupOptions {
|
||||
duration?: number /* Display duration (default: 2s) */
|
||||
}
|
||||
|
||||
/* ----------------------------------------------------------------------------
|
||||
* Functions
|
||||
* ------------------------------------------------------------------------- */
|
||||
|
||||
/**
|
||||
* Setup dialog
|
||||
*
|
||||
* @param options - Options
|
||||
*
|
||||
* @return Dialog observable
|
||||
*/
|
||||
export function setupDialog(
|
||||
{ duration }: SetupOptions = {}
|
||||
): Subject<string> {
|
||||
const dialog$ = new Subject<string>()
|
||||
|
||||
/* Create dialog */
|
||||
const dialog = document.createElement("div") // TODO: improve scoping
|
||||
dialog.classList.add("md-dialog", "md-typeset")
|
||||
|
||||
/* Display dialog */
|
||||
dialog$
|
||||
.pipe(
|
||||
switchMap(text => useComponent("container")
|
||||
.pipe(
|
||||
map(container => container.appendChild(dialog)),
|
||||
delay(1), // Strangley it doesnt work when we push things to the new animation frame...
|
||||
tap(el => {
|
||||
el.innerHTML = text
|
||||
el.setAttribute("data-md-state", "open")
|
||||
}),
|
||||
delay(duration || 2000),
|
||||
tap(el => el.removeAttribute("data-md-state")),
|
||||
delay(400),
|
||||
tap(el => {
|
||||
el.innerHTML = ""
|
||||
el.remove()
|
||||
})
|
||||
)
|
||||
)
|
||||
)
|
||||
.subscribe()
|
||||
|
||||
/* Return dialog subject */
|
||||
return dialog$
|
||||
}
|
||||
@@ -198,6 +198,6 @@ export function setupKeyboard(): Observable<Keyboard> {
|
||||
}
|
||||
})
|
||||
|
||||
/* Return keyboard observable */
|
||||
/* Return keyboard */
|
||||
return keyboard$
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user