mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
95 lines
3.1 KiB
TypeScript
95 lines
3.1 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 * as ClipboardJS from "clipboard"
|
|
import { NEVER, Observable, Subject } from "rxjs"
|
|
import { mapTo, share, tap } from "rxjs/operators"
|
|
|
|
import { getElements } from "browser"
|
|
import { renderClipboardButton } from "templates"
|
|
import { translate } from "utilities"
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Helper types
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Setup options
|
|
*/
|
|
interface SetupOptions {
|
|
document$: Observable<Document> /* Document observable */
|
|
dialog$: Subject<string> /* Dialog subject */
|
|
}
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Functions
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Set up clipboard
|
|
*
|
|
* This function implements the Clipboard.js integration and injects a button
|
|
* into all code blocks when the document changes.
|
|
*
|
|
* @param options - Options
|
|
*
|
|
* @return Clipboard observable
|
|
*/
|
|
export function setupClipboard(
|
|
{ document$, dialog$ }: SetupOptions
|
|
): Observable<ClipboardJS.Event> {
|
|
if (!ClipboardJS.isSupported())
|
|
return NEVER
|
|
|
|
/* Inject 'copy-to-clipboard' buttons */
|
|
document$.subscribe(() => {
|
|
const blocks = getElements("pre > code")
|
|
blocks.forEach((block, index) => {
|
|
const parent = block.parentElement!
|
|
parent.id = `__code_${index}`
|
|
parent.insertBefore(
|
|
renderClipboardButton(parent.id),
|
|
block
|
|
)
|
|
})
|
|
})
|
|
|
|
/* Initialize clipboard */
|
|
const clipboard$ = new Observable<ClipboardJS.Event>(subscriber => {
|
|
new ClipboardJS(".md-clipboard").on("success", ev => subscriber.next(ev))
|
|
})
|
|
.pipe(
|
|
share()
|
|
)
|
|
|
|
/* Display notification for clipboard event */
|
|
clipboard$
|
|
.pipe(
|
|
tap(ev => ev.clearSelection()),
|
|
mapTo(translate("clipboard.copied"))
|
|
)
|
|
.subscribe(dialog$)
|
|
|
|
/* Return clipboard */
|
|
return clipboard$
|
|
}
|