/* * Copyright (c) 2016-2021 Martin Donath * * 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 ClipboardJS from "clipboard" import { NEVER, Observable, Subject, fromEvent, merge, of } from "rxjs" import { distinctUntilKeyChanged, finalize, map, switchMap, tap, withLatestFrom } from "rxjs/operators" import { resetFocusable, setFocusable } from "~/actions" import { Viewport, getElementContentSize, getElementSize, getElements, watchMedia } from "~/browser" import { renderClipboardButton } from "~/templates" import { Component } from "../../_" /* ---------------------------------------------------------------------------- * Types * ------------------------------------------------------------------------- */ /** * Code block */ export interface CodeBlock { scroll: boolean /* Code block overflows */ } /* ---------------------------------------------------------------------------- * Helper types * ------------------------------------------------------------------------- */ /** * Watch options */ interface WatchOptions { viewport$: Observable /* Viewport observable */ } /** * Mount options */ interface MountOptions { viewport$: Observable /* Viewport observable */ } /* ---------------------------------------------------------------------------- * Data * ------------------------------------------------------------------------- */ /** * Global index for Clipboard.js integration */ let index = 0 /* ---------------------------------------------------------------------------- * Functions * ------------------------------------------------------------------------- */ /** * Watch code block * * This function monitors size changes of the viewport, as well as switches of * content tabs with embedded code blocks, as both may trigger overflow. * * @param el - Code block element * @param options - Options * * @returns Code block observable */ export function watchCodeBlock( el: HTMLElement, { viewport$ }: WatchOptions ): Observable { const container$ = of(el) .pipe( switchMap(child => { const container = child.closest("[data-tabs]") if (container instanceof HTMLElement) { return merge( ...getElements("input", container) .map(input => fromEvent(input, "change")) ) } return NEVER }) ) /* Check overflow on resize and tab change */ return merge( viewport$.pipe(distinctUntilKeyChanged("size")), container$ ) .pipe( map(() => { const visible = getElementSize(el) const content = getElementContentSize(el) return { scroll: content.width > visible.width } }), distinctUntilKeyChanged("scroll") ) } /** * Mount code block * * This function ensures that an overflowing code block is focusable through * keyboard, so it can be scrolled without a mouse to improve on accessibility. * * @param el - Code block element * @param options - Options * * @returns Code block component observable */ export function mountCodeBlock( el: HTMLElement, options: MountOptions ): Observable> { const internal$ = new Subject() internal$ .pipe( withLatestFrom(watchMedia("(hover)")) ) .subscribe(([{ scroll }, hover]) => { if (scroll && hover) setFocusable(el) else resetFocusable(el) }) /* Render button for Clipboard.js integration */ if (ClipboardJS.isSupported()) { const parent = el.closest("pre")! parent.id = `__code_${index++}` parent.insertBefore( renderClipboardButton(parent.id), el ) } /* Create and return component */ return watchCodeBlock(el, options) .pipe( tap(state => internal$.next(state)), finalize(() => internal$.complete()), map(state => ({ ref: el, ...state })) ) }