aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/src/templates/assets/javascripts/components/announce/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src/templates/assets/javascripts/components/announce/index.ts')
-rw-r--r--docs/src/templates/assets/javascripts/components/announce/index.ts110
1 files changed, 110 insertions, 0 deletions
diff --git a/docs/src/templates/assets/javascripts/components/announce/index.ts b/docs/src/templates/assets/javascripts/components/announce/index.ts
new file mode 100644
index 00000000..dd04b4ff
--- /dev/null
+++ b/docs/src/templates/assets/javascripts/components/announce/index.ts
@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2016-2023 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 {
+ EMPTY,
+ Observable,
+ Subject,
+ defer,
+ finalize,
+ fromEvent,
+ map,
+ tap
+} from "rxjs"
+
+import { feature } from "~/_"
+import { getElement } from "~/browser"
+
+import { Component } from "../_"
+
+/* ----------------------------------------------------------------------------
+ * Types
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Announcement bar
+ */
+export interface Announce {
+ hash: number /* Content hash */
+}
+
+/* ----------------------------------------------------------------------------
+ * Functions
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Watch announcement bar
+ *
+ * @param el - Announcement bar element
+ *
+ * @returns Announcement bar observable
+ */
+export function watchAnnounce(
+ el: HTMLElement
+): Observable<Announce> {
+ const button = getElement(".md-typeset > :first-child", el)
+ return fromEvent(button, "click", { once: true })
+ .pipe(
+ map(() => getElement(".md-typeset", el)),
+ map(content => ({ hash: __md_hash(content.innerHTML) }))
+ )
+}
+
+/**
+ * Mount announcement bar
+ *
+ * @param el - Announcement bar element
+ *
+ * @returns Announcement bar component observable
+ */
+export function mountAnnounce(
+ el: HTMLElement
+): Observable<Component<Announce>> {
+ if (!feature("announce.dismiss") || !el.childElementCount)
+ return EMPTY
+
+ /* Support instant navigation - see https://t.ly/3FTme */
+ if (!el.hidden) {
+ const content = getElement(".md-typeset", el)
+ if (__md_hash(content.innerHTML) === __md_get("__announce"))
+ el.hidden = true
+ }
+
+ /* Mount component on subscription */
+ return defer(() => {
+ const push$ = new Subject<Announce>()
+ push$.subscribe(({ hash }) => {
+ el.hidden = true
+
+ /* Persist preference in local storage */
+ __md_set<number>("__announce", hash)
+ })
+
+ /* Create and return component */
+ return watchAnnounce(el)
+ .pipe(
+ tap(state => push$.next(state)),
+ finalize(() => push$.complete()),
+ map(state => ({ ref: el, ...state }))
+ )
+ })
+}