Implemented lazy rendering of search results

src/assets/javascripts/actions/index.ts

@@ -22,4 +22,5 @@
 
 export * from "./header"
 export * from "./hidden"
+export * from "./search"
 export * from "./sidebar"

src/assets/javascripts/actions/search/index.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2016-2019 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.
+ */
+
+export * from "./result"

src/assets/javascripts/actions/search/result/index.ts

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2016-2019 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.
+ */
+
+/* ----------------------------------------------------------------------------
+ * Functions
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Add an element to the search result list
+ *
+ * @param el - Search result list element
+ * @param child - Search result element
+ */
+export function addToSearchResultList(
+  el: HTMLElement, child: HTMLElement
+): void {
+  el.appendChild(child)
+}
+
+/**
+ * Reset search result list
+ *
+ * @param el - Search result list element
+ */
+export function resetSearchResultList(
+  el: HTMLElement
+): void {
+  el.innerHTML = ""
+}

src/assets/javascripts/components/header/offset/index.ts

@@ -54,12 +54,12 @@ interface Options {
  * This function returns an observable that computes the relative offset to the
  * top of the given element based on the current viewport offset.
  *
- * @param el - Element
+ * @param el - HTML element
  * @param options - Options
  *
  * @return Viewport offset observable
  */
-export function watchTopOffset(
+export function watchHeaderOffsetToTopOf(
   el: HTMLElement, { size$, offset$, header$ }: Options
 ): Observable<ViewportOffset> {
 
@@ -85,12 +85,12 @@ export function watchTopOffset(
  * This function returns an observable that computes the relative offset to the
  * bottom of the given element based on the current viewport offset.
  *
- * @param el - Element
+ * @param el - HTML element
  * @param options - Options
  *
  * @return Viewport offset observable
  */
-export function watchBottomOffset(
+export function watchHeaderOffsetToBottomOf(
   el: HTMLElement, { size$, offset$, header$ }: Options
 ): Observable<ViewportOffset> {
 

src/assets/javascripts/components/search/index.ts

@@ -22,3 +22,4 @@
 
 // export * from "./query"
 export * from "./reset"
+export * from "./result"

src/assets/javascripts/components/search/query/index.ts

@@ -19,4 +19,3 @@
  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  * IN THE SOFTWARE.
  */
-

src/assets/javascripts/components/search/result/index.ts

@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) 2016-2019 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 { identity } from "ramda"
+import {
+  MonoTypeOperatorFunction,
+  Observable,
+  animationFrameScheduler,
+  pipe
+} from "rxjs"
+import {
+  distinctUntilChanged,
+  filter,
+  finalize,
+  map,
+  mapTo,
+  observeOn,
+  scan,
+  switchMap
+} from "rxjs/operators"
+
+import { addToSearchResultList, resetSearchResultList } from "actions"
+import { SearchResult } from "modules"
+import { renderSearchResult } from "templates"
+import { ViewportSize, watchElementOffset } from "utilities"
+
+/* ----------------------------------------------------------------------------
+ * Helper types
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Options
+ */
+interface Options {
+  size$: Observable<ViewportSize>      /* Viewport size observable */
+}
+
+/* ----------------------------------------------------------------------------
+ * Functions
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Paint search result from source observable
+ *
+ * @param el - Search result element
+ *
+ * @return Operator function
+ */
+export function paintSearchResult(
+  el: HTMLElement, { size$ }: Options
+): MonoTypeOperatorFunction<SearchResult[]> {
+  const container = el.parentElement!
+
+  /* Compute whether the container is near the bottom offset */
+  const render$ = watchElementOffset(container, { size$ })
+    .pipe(
+      map(({ y }) => y >= container.scrollHeight - container.offsetHeight - 16),
+      distinctUntilChanged(),
+      filter(identity)
+    )
+
+  /* Paint search results lazily */
+  const [meta, list] = Array.from(el.children) as HTMLElement[]
+  return pipe(
+    switchMap(result => render$
+      .pipe(
+
+        /* Defer repaint to next animation frame */
+        observeOn(animationFrameScheduler),
+        scan(index => {
+          while (index < result.length) {
+            addToSearchResultList(list, renderSearchResult(result[index++]))
+            if (container.scrollHeight - container.offsetHeight > 16)
+              break
+          }
+          return index
+        }, 0),
+        mapTo(result),
+
+        /* Reset on complete or error */
+        finalize(() => {
+          resetSearchResultList(list)
+        })
+      )
+    )
+  )
+}

src/assets/javascripts/templates/search/_/index.tsx

@@ -20,7 +20,7 @@
  * IN THE SOFTWARE.
  */
 
-import { h, toElement } from "extensions"
+import { h, toHTMLElement } from "extensions"
 import { SearchResult } from "modules"
 
 import { renderArticleDocument } from "../article"
@@ -46,12 +46,12 @@ const css = {
  *
  * @param article - Search result
  *
- * @return Element
+ * @return HTML element
  */
 export function renderSearchResult(
   { article, sections }: SearchResult
-): Element {
-  return toElement(
+): HTMLElement {
+  return toHTMLElement(
     <li class={css.item}>
       {renderArticleDocument(article)}
       {...sections.map(renderSectionDocument)}

src/assets/javascripts/templates/search/article/index.tsx

@@ -20,7 +20,7 @@
  * IN THE SOFTWARE.
  */
 
-import { h, toElement } from "extensions"
+import { h, toHTMLElement } from "extensions"
 import { ArticleDocument } from "modules"
 import { truncate } from "utilities"
 
@@ -47,12 +47,12 @@ const css = {
  *
  * @param article - Article document
  *
- * @return Element
+ * @return HTML element
  */
 export function renderArticleDocument(
   { location, title, text }: ArticleDocument
-): Element {
-  return toElement(
+): HTMLElement {
+  return toHTMLElement(
     <a href={location} title={title} class={css.link} tabIndex={-1}>
       <article class={css.article}>
         <h1 class={css.title}>{title}</h1>

src/assets/javascripts/templates/search/section/index.tsx

@@ -20,7 +20,7 @@
  * IN THE SOFTWARE.
  */
 
-import { h, toElement } from "extensions"
+import { h, toHTMLElement } from "extensions"
 import { SectionDocument } from "modules"
 import { truncate } from "utilities"
 
@@ -47,12 +47,12 @@ const css = {
  *
  * @param section - Section document
  *
- * @return Element
+ * @return HTML element
  */
 export function renderSectionDocument(
   { location, title, text }: SectionDocument
-): Element {
-  return toElement(
+): HTMLElement {
+  return toHTMLElement(
     <a href={location} title={title} class={css.link} tabIndex={-1}>
       <article class={css.article}>
         <h1 class={css.title}>{title}</h1>

src/assets/javascripts/utilities/agent/element/_/index.ts

@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2016-2019 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.
+ */
+
+/* ----------------------------------------------------------------------------
+ * Functions
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Retrieve an element matching the query selector
+ *
+ * @template T - Element type
+ *
+ * @param selector - Query selector
+ * @param node - Node of reference
+ *
+ * @return Element
+ */
+export function getElement<T extends HTMLElement>(
+  selector: string, node: ParentNode = document
+): T | undefined {
+  return node.querySelector<T>(selector) || undefined
+}
+
+/**
+ * Retrieve all elements matching the query selector
+ *
+ * @template T - Element type
+ *
+ * @param selector - Query selector
+ * @param node - Node of reference
+ *
+ * @return Elements
+ */
+export function getElements<T extends HTMLElement>(
+  selector: string, node: ParentNode = document
+): T[] {
+  return Array.from(node.querySelectorAll<T>(selector))
+}

src/assets/javascripts/utilities/agent/element/index.ts

@@ -20,38 +20,5 @@
  * IN THE SOFTWARE.
  */
 
-/* ----------------------------------------------------------------------------
- * Functions
- * ------------------------------------------------------------------------- */
-
-/**
- * Retrieve an element matching the query selector
- *
- * @template T - Element type
- *
- * @param selector - Query selector
- * @param node - Node of reference
- *
- * @return Element
- */
-export function getElement<T extends HTMLElement>(
-  selector: string, node: ParentNode = document
-): T | undefined {
-  return node.querySelector<T>(selector) || undefined
-}
-
-/**
- * Retrieve all elements matching the query selector
- *
- * @template T - Element type
- *
- * @param selector - Query selector
- * @param node - Node of reference
- *
- * @return Elements
- */
-export function getElements<T extends HTMLElement>(
-  selector: string, node: ParentNode = document
-): T[] {
-  return Array.from(node.querySelectorAll<T>(selector))
-}
+export * from "./_"
+export * from "./offset"

src/assets/javascripts/utilities/agent/element/offset/index.ts

@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2016-2019 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, fromEvent, merge } from "rxjs"
+import { map, shareReplay, startWith } from "rxjs/operators"
+
+import { ViewportSize } from "../../viewport"
+
+/* ----------------------------------------------------------------------------
+ * Types
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Element offset
+ */
+export interface ElementOffset {
+  x: number                            /* Horizontal offset */
+  y: number                            /* Vertical offset */
+}
+
+/* ----------------------------------------------------------------------------
+ * Helper types
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Options
+ */
+interface Options {
+  size$: Observable<ViewportSize>      /* Viewport size observable */
+}
+
+/* ----------------------------------------------------------------------------
+ * Functions
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Retrieve element offset
+ *
+ * @param el - HTML element
+ *
+ * @return Element offset
+ */
+export function getElementOffset(el: HTMLElement): ElementOffset {
+  return {
+    x: el.scrollLeft,
+    y: el.scrollTop
+  }
+}
+
+/* ------------------------------------------------------------------------- */
+
+/**
+ * Watch element offset
+ *
+ * @paramel - Element
+ * @param options - Options
+ *
+ * @return Element offset observable
+ */
+export function watchElementOffset(
+  el: HTMLElement, { size$ }: Options
+): Observable<ElementOffset> {
+  const scroll$ = fromEvent(el, "scroll")
+  return merge(scroll$, size$)
+    .pipe(
+      map(() => getElementOffset(el)),
+      startWith(getElementOffset(el)),
+      shareReplay(1)
+    )
+}

src/assets/javascripts/utilities/agent/worker/index.ts

@@ -45,7 +45,7 @@ export interface WorkerMessage {
  * @template T - Worker message type
  */
 interface Options<T extends WorkerMessage> {
-  message$: Observable<T>              /* Message observable */
+  send$: Observable<T>                 /* Message observable */
 }
 
 /* ----------------------------------------------------------------------------
@@ -65,22 +65,22 @@ interface Options<T extends WorkerMessage> {
  * @return Worker message observable
  */
 export function watchWorker<T extends WorkerMessage>(
-  worker: Worker, { message$ }: Options<T>
+  worker: Worker, { send$ }: Options<T>
 ): Observable<T> {
 
   /* Observable for messages from web worker */
-  const worker$ = fromEvent(worker, "message")
+  const recv$ = fromEvent(worker, "message")
     .pipe(
       pluck<Event, T>("data"),
       share()
     )
 
   /* Send and receive messages, return hot observable */
-  return message$
+  return send$
     .pipe(
-      throttle(() => worker$, { leading: true, trailing: true }),
+      throttle(() => recv$, { leading: true, trailing: true }),
       tap(message => worker.postMessage(message)),
-      switchMapTo(worker$),
+      switchMapTo(recv$),
       share()
     )
 }

src/assets/javascripts/utilities/string/index.ts

@@ -35,7 +35,7 @@
 export function truncate(string: string, n: number): string {
   let i = n
   if (string.length > i) {
-    while (string[i] !== " " && --i > 0);
+    while (string[i] !== " " && --i > 0); // tslint:disable-line
     return `${string.substring(0, i)}...`
   }
   return string