terrier-engine 4.9.1 → 4.10.3

package/package.json

@@ -4,7 +4,7 @@
   "files": [
     "*"
   ],
-  "version": "4.9.1",
+  "version": "4.10.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/Terrier-Tech/terrier-engine"

package/terrier/list-viewer.ts

@@ -1,23 +1,166 @@
 import TerrierPart from "./parts/terrier-part"
-import {PartTag} from "tuff-core/parts"
+import {Part, PartConstructor, PartTag, StatelessPart} from "tuff-core/parts"
 import Messages from "tuff-core/messages"
 import {Logger} from "tuff-core/logging"
-import Html from "tuff-core/html"
+import {PageBreakpoints} from "./parts/page-part"
 
 const log = new Logger('List Viewer')
+Logger.level = 'debug'
+
+/**
+ * Optional values to return from rendering a list item that control
+ * its rendering behavior.
+ */
+export type ListItemRenderOptions = {
+    style?: 'panel' | 'header'
+    clickable?: boolean
+}
+
+/**
+ * All list items should have an `id` value so that we can distinguish them.
+ */
+export type ListItem = {id: string}
+
+/**
+ * One of these gets created for each item in the list.
+ */
+class ListItemPart<T extends ListItem> extends Part<T> {
+
+    viewer!: ListViewerPart<T>
+
+    render(parent: PartTag) {
+        const isCurrent = this.viewer.detailsContext?.id == this.state.id
+
+        parent.div('.tt-list-viewer-item', itemView => {
+            const opts = this.viewer.renderListItem(itemView, this.state)
+            const style = opts?.style || 'panel'
+            itemView.class(style)
+            if (opts?.clickable) {
+                itemView.class('clickable')
+                itemView.emitClick(this.viewer.itemClickedKey, {id: this.state.id})
+            }
+            if (isCurrent) {
+                itemView.class('current')
+            }
+        }).id(`item-${this.state.id}`)
+
+        // render the details if this is the current item and it's supposed to be rendered inline
+        if (isCurrent && this.viewer.layout == 'inline') {
+            log.debug(`ListItemPart: rendering inline item details`)
+            if (this.viewer.currentDetailsPart) {
+                parent.part(this.viewer.currentDetailsPart)
+            }
+        }
+    }
+
+}
+
+/**
+ * Allows ListViewerPart subclasses to either directly render content for
+ * the list details or make a part to do it.
+ */
+export class ListViewerDetailsContext<T extends ListItem> {
+
+    /**
+     * The item id for which this context is representing the details.
+     */
+    get id(): string {
+        return this.item.id
+    }
+
+    /**
+     * The part created by `makePart()` to render the details.
+     */
+    part?: StatelessPart
+
+    /**
+     * The part representing this item in the list.
+     */
+    itemPart?: ListItemPart<T>
+
+    constructor(readonly viewer: ListViewerPart<T>, readonly item: T) {
+    }
+
+    /**
+     * Make a part to render the details for the list item.
+     * @param partType
+     * @param state
+     */
+    makePart<PartType extends Part<StateType>, StateType>(partType: PartConstructor<PartType, StateType>, state: StateType) {
+        if (this.viewer.layout == 'side') {
+            this.part = this.viewer.sideContainerPart.makePart(partType, state)
+        }
+        else {
+            this.part = this.viewer.currentItemPart?.makePart(partType, state)
+        }
+    }
+
+    /**
+     * Ensure that the rendered part is disposed and the related item part is marked dirty.
+     */
+    clear() {
+        if (this.part) {
+            this.viewer.removeChild(this.part)
+            this.part = undefined
+        }
+        if (this.itemPart) {
+            this.itemPart.dirty()
+        }
+    }
+}
+
+/**
+ * This part sits permanently on the side and will render the details if
+ * the viewer's detailsLocation = 'side'.
+ */
+class SideContainerPart extends Part<{viewer: ListViewerPart<any>}> {
+
+    viewer!: ListViewerPart<any>
+
+    async init() {
+        this.viewer = this.state.viewer
+    }
+
+    get parentClasses(): Array<string> {
+        return ['tt-list-viewer-side-details']
+    }
+
+    render(parent: PartTag) {
+        if (this.viewer.currentDetailsPart) {
+            log.debug(`[SideContainerPart] Rendering details part`, this.viewer.currentDetailsPart)
+            parent.part(this.viewer.currentDetailsPart)
+        }
+        else {
+            log.debug(`[SideContainerPart] No details part to render`)
+        }
+    }
+
+}
 
-const detailsSelector = '.tt-list-viewer-details'
 
 /**
  * Part for viewing a list of items and the details associated with them.
  * Each item must have an `id` so that they can be distinguished.
  */
-export abstract class ListViewerPart<T extends {id: string}> extends TerrierPart<any> {
+export abstract class ListViewerPart<T extends ListItem> extends TerrierPart<any> {
+
+    sideContainerPart!: SideContainerPart
+
+    detailsContext?: ListViewerDetailsContext<T>
+    layout: 'inline' | 'side' = 'side'
+
+    get currentDetailsPart(): StatelessPart | undefined  {
+        return this.detailsContext?.part
+    }
+
+    get currentItemPart(): StatelessPart | undefined  {
+        return this.detailsContext?.itemPart
+    }
 
     items: T[] = []
-    itemMap: Record<string, T> = {}
+    itemPartMap: Record<string, ListItemPart<T>> = {}
 
-    itemClickedKey = Messages.typedKey<{id: string}>()
+    itemClickedKey = Messages.typedKey<ListItem>()
 
     /**
      * A message with this key gets emitted whenever the details are shown.
@@ -27,10 +170,12 @@ export abstract class ListViewerPart<T extends {id: string}> extends TerrierPart
     async init() {
         await super.init()
 
+        this.sideContainerPart = this.makePart(SideContainerPart, {viewer: this})
+
         await this.reload()
 
         this.onClick(this.itemClickedKey, m => {
-            log.info(`Clicked on list item ${m.data.id}`, m)
+            log.debug(`Clicked on list item ${m.data.id}`, m)
             this.showDetails(m.data.id)
         })
     }
@@ -38,13 +183,36 @@ export abstract class ListViewerPart<T extends {id: string}> extends TerrierPart
 
     /// Fetching
 
+    /**
+     * Subclasses must implement this to provide a list of items to render.
+     */
     abstract fetchItems(): Promise<T[]>
 
+    /**
+     * Fetches the items with `fetchItems()` and re-renders the list.
+     */
     async reload() {
         this.items = await this.fetchItems()
-        this.items.forEach((item) => {
-            this.itemMap[item.id] = item
+        this.assignCollection('items', ListItemPart, this.items)
+        this.getCollectionParts('items').forEach(itemPart => {
+            // HACK
+            (itemPart as ListItemPart<T>).viewer = this
+            // log.debug(`Adding item part ${itemPart.state.id}`, itemPart)
+            this.itemPartMap[itemPart.state.id] = (itemPart as ListItemPart<T>)
         })
+        this.relayout()
+    }
+
+    /**
+     * Determine whether the details should be shown inline with the list or
+     * off to the side, based on screen size.
+     */
+    relayout() {
+        if (window.innerWidth > PageBreakpoints.phone) {
+            this.layout = 'side'
+        } else {
+            this.layout = 'inline'
+        }
         this.dirty()
     }
 
@@ -56,91 +224,57 @@ export abstract class ListViewerPart<T extends {id: string}> extends TerrierPart
     }
 
     render(parent: PartTag): any {
+        log.debug(`Rendering the viewer`)
         parent.div('.tt-list-viewer-list', list => {
-            for (const item of this.items) {
-                list.a('.tt-list-viewer-item', {id: `item-${item.id}`}, itemView => {
-                    this.renderListItem(itemView, item)
-                }).emitClick(this.itemClickedKey, {id: item.id})
-            }
-        })
-        parent.div('.tt-list-viewer-details-container', detailsView => {
-            detailsView.div(detailsSelector)
+            this.renderCollection(list, 'items')
         })
+        if (this.layout == 'side') {
+            log.debug(`Rendering sideContainerPart inside the viewer`)
+            parent.part(this.sideContainerPart)
+        }
     }
-    abstract renderListItem(parent: PartTag, item: T): any
-
-    abstract renderItemDetail(parent: PartTag, item: T): any
 
+    /**
+     * Subclasses must override this to render the content of an item.
+     * @param parent
+     * @param item
+     */
+    abstract renderListItem(parent: PartTag, item: T): ListItemRenderOptions | void
 
-    // Details
+    /**
+     * Subclasses must implement this to render an item details or provide a part to do so.
+     * @param context
+     */
+    abstract renderDetails(context: ListViewerDetailsContext<T>): any
 
-    private setCurrent(id: string) {
-        // clear any existing current item
-        const existingCurrents = this.element!.querySelectorAll('.tt-list-viewer-list a.current')
-        existingCurrents.forEach((elem) => {
-            elem.classList.remove('current')
-        })
 
-        // add .current to the new item
-        const itemView = this.element!.querySelector(`#item-${id}`)
-        if (itemView) {
-            itemView.classList.add('current')
-        }
-    }
+    // Details
 
     /**
      * Show the details view for the item with the given id
      * @param id
      */
     showDetails(id: string) {
-        this.setCurrent(id)
-        const item = this.itemMap[id]
-        if (!item) {
-            throw `No item ${id}`
-        }
-        const container = this.element!.querySelector(detailsSelector)
-        if (container) {
-            // render the details
-            const detailsView = Html.createElement('div', div => {
-                this.renderItemDetail(div, item)
-            })
-            container.innerHTML = detailsView.innerHTML
-            this.arrangeDetails(id, container as HTMLElement)
-
-            // let the world know
-            this.emitMessage(this.detailsShownKey, {id})
-        }
-        else {
-            log.warn(`Tried to show item ${id} but there was no ${detailsSelector}`)
-        }
-    }
+        this.detailsContext?.clear()
 
-    /**
-     * If necessary, move the details next to the item
-     * @param id the item id
-     * @param detailsView
-     */
-    arrangeDetails(id: string, detailsView: HTMLElement) {
-        const itemView = this.element!.querySelector(`#item-${id}`)
-        if (itemView) {
-            // const listView = itemIVew.parentElement
-            log.info(`Item is ${itemView.clientWidth} wide and the window is ${window.innerWidth} wide`)
-            // crude but effective way to determine if the list is collapsed due to the media breakpoint
-            if (itemView.clientWidth > window.innerWidth * 0.8) {
-                // move the details to right after the list item
-                itemView.after(detailsView)
-            }
-            else {
-                // move the details back to the container
-                const detailsContainer = this.element!.querySelector(`.tt-list-viewer-details-container`)
-                if (detailsContainer) {
-                    detailsContainer.append(detailsView)
-                }
-            }
+        const itemPart = this.itemPartMap[id]
+        if (!itemPart) {
+            log.debug(`${Object.keys(this.itemPartMap).length} item parts: `, this.itemPartMap)
+            throw `No item part ${id}`
         }
-        else {
-            log.warn(`No item view for ${id}`)
+
+        this.detailsContext = new ListViewerDetailsContext(this, itemPart.state)
+        this.detailsContext.itemPart = itemPart
+        this.renderDetails(this.detailsContext)
+        if (this.layout == 'side') {
+            this.sideContainerPart.dirty()
         }
+        itemPart.dirty()
+
+        // let the world know
+        this.emitMessage(this.detailsShownKey, {id})
+
     }
 
+
 }

package/terrier/parts/page-part.ts

@@ -12,6 +12,16 @@ const log = new Logger("Terrier PagePart")
  */
 export type ContentWidth = "normal" | "wide" | "fill"
 
+/**
+ * The width breakpoints for various device classes used by the styles.
+ */
+export const PageBreakpoints = {
+    phone: 550,
+    mobile: 850,
+    tablet: 1050,
+    fixed: 320
+}
+
 /// Toolbar fields
 
 type BaseFieldDef = { name: string } & ToolbarFieldDefOptions