@internetarchive/collection-browser 0.0.1-alpha.2 → 0.0.1-alpha.22

package/src/sort-filter-bar/sort-filter-bar.ts

@@ -1,16 +1,46 @@
-import { SortParam } from '@internetarchive/search-service';
-import { LitElement, html, css, nothing, PropertyValues } from 'lit';
-import { customElement, property, state } from 'lit/decorators.js';
-import { CollectionDisplayMode } from '../models';
+import {
+  LitElement,
+  html,
+  css,
+  nothing,
+  PropertyValues,
+  TemplateResult,
+} from 'lit';
+import { customElement, property, query, state } from 'lit/decorators.js';
+import {
+  SharedResizeObserverInterface,
+  SharedResizeObserverResizeHandlerInterface,
+} from '@internetarchive/shared-resize-observer';
+import {
+  CollectionDisplayMode,
+  SortField,
+  SortFieldDisplayName,
+} from '../models';
 import './alpha-bar';
 
+import { sortIcon } from './img/sort-triangle';
+import { tileIcon } from './img/tile';
+import { listIcon } from './img/list';
+import { compactIcon } from './img/compact';
+
 @customElement('sort-filter-bar')
-export class SortFilterBar extends LitElement {
-  @property({ type: String }) displayMode: CollectionDisplayMode = 'grid';
+export class SortFilterBar
+  extends LitElement
+  implements SharedResizeObserverResizeHandlerInterface
+{
+  @property({ type: String }) displayMode?: CollectionDisplayMode;
+
+  @property({ type: String }) sortDirection: 'asc' | 'desc' | null = null;
+
+  @property({ type: String }) selectedSort: SortField = SortField.relevance;
+
+  @property({ type: String }) selectedTitleFilter: string | null = null;
+
+  @property({ type: String }) selectedCreatorFilter: string | null = null;
 
-  @property({ type: String }) sortDirection: 'asc' | 'desc' = 'desc';
+  @property({ type: Boolean }) showRelevance: boolean = true;
 
-  @property({ type: String }) sortField = 'week';
+  @property({ type: Object }) resizeObserver?: SharedResizeObserverInterface;
 
   @state() titleSelectorVisible: boolean = false;
 
@@ -18,90 +48,43 @@ export class SortFilterBar extends LitElement {
 
   @state() dateSortSelectorVisible = false;
 
+  @state() desktopSelectorBarWidth = 0;
+
+  @state() selectorBarContainerWidth = 0;
+
+  @query('#desktop-sort-selector')
+  private desktopSortSelector!: HTMLUListElement;
+
+  @query('#sort-selector-container')
+  private sortSelectorContainer!: HTMLDivElement;
+
   render() {
     return html`
-      <div id="sort-bar">
-        <div id="sort-selector">
-          <ul>
-            <li>
-              <button
-                @click=${() => {
-                  this.sortDirection = 'desc';
-                }}
-              >
-                Desc
-              </button>
-              <button
-                @click=${() => {
-                  this.sortDirection = 'asc';
-                }}
-              >
-                Asc</button
-              >Sort By
-            </li>
-            <li>
-              <button
-                @click=${() => {
-                  this.sortField = 'week';
-                }}
-              >
-                Views
-              </button>
-            </li>
-            <li>
-              <button
-                @click=${() => {
-                  this.titleSelectorVisible = !this.titleSelectorVisible;
-                  this.sortField = 'titleSorter';
-                }}
-              >
-                Title
-              </button>
-            </li>
-            <li>
-              <button
-                @click=${() => {
-                  this.dateSortSelectorVisible = !this.dateSortSelectorVisible;
-                }}
-              >
-                Date Archived
-              </button>
-            </li>
-            <li>
-              <button
-                @click=${() => {
-                  this.creatorSelectorVisible = !this.creatorSelectorVisible;
-                  this.sortField = 'creatorSorter';
-                }}
-              >
-                Creator
-              </button>
-            </li>
-          </ul>
-        </div>
+      <div id="container">
+        ${this.titleSelectorVisible || this.selectedSort === 'title'
+          ? this.titleSelectorBar
+          : nothing}
+        ${this.creatorSelectorVisible || this.selectedSort === 'creator'
+          ? this.creatorSelectorBar
+          : nothing}
+
+        <div id="sort-bar">
+          <div id="sort-direction-container">
+            ${this.sortDirectionSelectorTemplate}
+          </div>
 
-        <div id="display-style">
-          <ul>
-            ${this.displayMode !== 'grid'
-              ? html`<li>
-                  <input type="checkbox" @click=${this.detailSelected} />
-                  Details
-                </li>`
-              : nothing}
-
-            <li>
-              <button id="grid-button" @click=${this.gridSelected}>Grid</button>
-            </li>
-            <li>
-              <button id="list-button" @click=${this.listSelected}>List</button>
-            </li>
-          </ul>
+          <div id="sort-selector-container">
+            ${this.mobileSortSelectorTemplate}
+            ${this.desktopSortSelectorTemplate}
+          </div>
+
+          <div id="display-style-selector">${this.displayOptionTemplate}</div>
         </div>
-      </div>
 
-      ${this.dateSortSelectorVisible ? this.dateSortSelector : nothing}
-      ${this.titleSelectorVisible ? this.titleSelectorBar : nothing}
-      ${this.creatorSelectorVisible ? this.creatorSelectorBar : nothing}
+        ${this.dateSortSelectorVisible ? this.dateSortSelector : nothing}
+
+        <div id="bottom-shadow"></div>
+      </div>
     `;
   }
 
@@ -110,66 +93,318 @@ export class SortFilterBar extends LitElement {
       this.displayModeChanged();
     }
 
-    if (changed.has('sortDirection') || changed.has('sortField')) {
-      this.sortChanged();
+    if (changed.has('selectedSort') && this.sortDirection === null) {
+      this.sortDirection = 'desc';
+    }
+
+    if (changed.has('selectedTitleFilter') && this.selectedTitleFilter) {
+      this.titleSelectorVisible = true;
+    }
+
+    if (changed.has('selectedCreatorFilter') && this.selectedCreatorFilter) {
+      this.creatorSelectorVisible = true;
+    }
+
+    if (changed.has('resizeObserver')) {
+      const oldObserver = changed.get(
+        'resizeObserver'
+      ) as SharedResizeObserverInterface;
+      if (oldObserver) this.disconnectResizeObserver(oldObserver);
+      this.setupResizeObserver();
+    }
+  }
+
+  disconnectedCallback(): void {
+    if (this.resizeObserver) {
+      this.disconnectResizeObserver(this.resizeObserver);
+    }
+  }
+
+  private disconnectResizeObserver(
+    resizeObserver: SharedResizeObserverInterface
+  ) {
+    resizeObserver.removeObserver({
+      target: this.sortSelectorContainer,
+      handler: this,
+    });
+
+    resizeObserver.removeObserver({
+      target: this.desktopSortSelector,
+      handler: this,
+    });
+  }
+
+  private setupResizeObserver() {
+    if (!this.resizeObserver) return;
+    this.resizeObserver.addObserver({
+      target: this.sortSelectorContainer,
+      handler: this,
+    });
+
+    this.resizeObserver.addObserver({
+      target: this.desktopSortSelector,
+      handler: this,
+    });
+  }
+
+  private get mobileSelectorVisible() {
+    return this.selectorBarContainerWidth - 10 < this.desktopSelectorBarWidth;
+  }
+
+  handleResize(entry: ResizeObserverEntry): void {
+    if (entry.target === this.desktopSortSelector)
+      this.desktopSelectorBarWidth = entry.contentRect.width;
+    else if (entry.target === this.sortSelectorContainer)
+      this.selectorBarContainerWidth = entry.contentRect.width;
+  }
+
+  private get sortDirectionSelectorTemplate() {
+    return html`
+      <div id="sort-direction-selector">
+        <button
+          id="sort-ascending-btn"
+          class="sort-button ${this.sortDirection === 'asc' ? 'selected' : ''}"
+          ?disabled=${this.selectedSort === 'relevance'}
+          @click=${() => {
+            this.setSortDirections('asc');
+          }}
+        >
+          ${sortIcon}
+        </button>
+        <button
+          id="sort-descending-btn"
+          class="sort-button ${this.sortDirection === 'desc' ? 'selected' : ''}"
+          ?disabled=${this.selectedSort === 'relevance'}
+          @click=${() => {
+            this.setSortDirections('desc');
+          }}
+        >
+          ${sortIcon}
+        </button>
+      </div>
+    `;
+  }
+
+  private get desktopSortSelectorTemplate() {
+    return html`
+      <ul
+        id="desktop-sort-selector"
+        class=${this.mobileSelectorVisible ? 'hidden' : 'visible'}
+      >
+        <li id="sort-by-text">Sort By</li>
+        <li>
+          ${this.showRelevance
+            ? this.getSortDisplayOption(SortField.relevance)
+            : nothing}
+        </li>
+        <li>${this.getSortDisplayOption(SortField.views)}</li>
+        <li>${this.getSortDisplayOption(SortField.title)}</li>
+        <li>
+          ${this.getSortDisplayOption(SortField.datearchived, {
+            additionalClickEvent: () => {
+              this.dateSortSelectorVisible = !this.dateSortSelectorVisible;
+            },
+            displayName: html`${this.dateSortField}`,
+            isSelected: () => this.dateOptionSelected,
+          })}
+        </li>
+        <li>
+          ${this.getSortDisplayOption(SortField.creator, {
+            additionalClickEvent: () => {
+              this.creatorSelectorVisible = !this.creatorSelectorVisible;
+            },
+          })}
+        </li>
+      </ul>
+    `;
+  }
+
+  /**
+   * This generates each of the sort option links.
+   *
+   * It manages the display value and the selected state of the option.
+   *
+   * @param sortField
+   * @param options {
+   *    additionalClickEvent?: () => void; If this is provided, it will also be called when the option is clicked.
+   *    displayName?: TemplateResult; The name to display for the option. Defaults to the sortField display name.
+   *    isSelected?: () => boolean; A function that returns true if the option is selected. Defaults to the selectedSort === sortField.
+   * }
+   * @returns
+   */
+  private getSortDisplayOption(
+    sortField: SortField,
+    options?: {
+      additionalClickEvent?: (e: Event) => void;
+      isSelected?: () => boolean;
+      displayName?: TemplateResult;
     }
+  ): TemplateResult {
+    const isSelected =
+      options?.isSelected ?? (() => this.selectedSort === sortField);
+    const displayName = options?.displayName ?? SortFieldDisplayName[sortField];
+    return html`
+      <a
+        href="#"
+        @click=${(e: Event) => {
+          e.preventDefault();
+          this.setSelectedSort(sortField);
+          options?.additionalClickEvent?.(e);
+        }}
+        class=${isSelected() ? 'selected' : ''}
+      >
+        ${displayName}
+      </a>
+    `;
+  }
+
+  private get mobileSortSelectorTemplate() {
+    return html`
+      <select
+        id="mobile-sort-selector"
+        @change=${this.mobileSortChanged}
+        class=${this.mobileSelectorVisible ? 'visible' : 'hidden'}
+      >
+        ${Object.keys(SortField).map(
+          field => html`
+            <option value="${field}" ?selected=${this.selectedSort === field}>
+              ${SortFieldDisplayName[field as SortField]}
+            </option>
+          `
+        )}
+      </select>
+    `;
+  }
+
+  private mobileSortChanged(e: Event) {
+    const target = e.target as HTMLSelectElement;
+    this.setSelectedSort(target.value as SortField);
+  }
+
+  private get displayOptionTemplate() {
+    return html`
+      <ul>
+        <li>
+          <button
+            id="grid-button"
+            @click=${() => {
+              this.displayMode = 'grid';
+            }}
+            class=${this.displayMode === 'grid' ? 'active' : ''}
+          >
+            ${tileIcon}
+          </button>
+        </li>
+        <li>
+          <button
+            id="grid-button"
+            @click=${() => {
+              this.displayMode = 'list-detail';
+            }}
+            class=${this.displayMode === 'list-detail' ? 'active' : ''}
+          >
+            ${listIcon}
+          </button>
+        </li>
+        <li>
+          <button
+            id="list-button"
+            @click=${() => {
+              this.displayMode = 'list-compact';
+            }}
+            class=${this.displayMode === 'list-compact' ? 'active' : ''}
+          >
+            ${compactIcon}
+          </button>
+        </li>
+      </ul>
+    `;
   }
 
   private get dateSortSelector() {
     return html`
       <div id="date-sort-selector">
         <ul>
-          <li>
-            <button
-              @click=${() => {
-                this.sortField = 'publicdate';
-              }}
-            >
-              Date Archived
-            </button>
-          </li>
-          <li>
-            <button
-              @click=${() => {
-                this.sortField = 'date';
-              }}
-            >
-              Date Published
-            </button>
-          </li>
-          <li>
-            <button
-              @click=${() => {
-                this.sortField = 'reviewdate';
-              }}
-            >
-              Date Reviewed
-            </button>
-          </li>
-          <li>
-            <button
-              @click=${() => {
-                this.sortField = 'addeddate';
-              }}
-            >
-              Date Added
-            </button>
-          </li>
+          <li>${this.getDateSortButton(SortField.datearchived)}</li>
+          <li>${this.getDateSortButton(SortField.datepublished)}</li>
+          <li>${this.getDateSortButton(SortField.datereviewed)}</li>
+          <li>${this.getDateSortButton(SortField.dateadded)}</li>
         </ul>
       </div>
     `;
   }
 
+  private getDateSortButton(sortField: SortField) {
+    return html`
+      <button
+        @click=${() => {
+          this.selectDateSort(sortField);
+        }}
+      >
+        ${SortFieldDisplayName[sortField]}
+      </button>
+    `;
+  }
+
+  private selectDateSort(sortField: SortField) {
+    this.dateSortSelectorVisible = false;
+    this.setSelectedSort(sortField);
+  }
+
+  private setSortDirections(sortDirection: 'asc' | 'desc') {
+    this.sortDirection = sortDirection;
+    this.emitSortChangedEvent();
+  }
+
+  private setSelectedSort(sort: SortField) {
+    this.selectedSort = sort;
+    this.emitSortChangedEvent();
+  }
+
+  /**
+   * There are four date sort options.
+   *
+   * This checks to see if the current sort is one of them.
+   *
+   * @readonly
+   * @private
+   * @type {boolean}
+   * @memberof SortFilterBar
+   */
+  private get dateOptionSelected(): boolean {
+    return [
+      'datearchived',
+      'datepublished',
+      'datereviewed',
+      'dateadded',
+    ].includes(this.selectedSort);
+  }
+
+  /**
+   * The display name of the current date field
+   *
+   * @readonly
+   * @private
+   * @type {string}
+   * @memberof SortFilterBar
+   */
+  private get dateSortField(): string {
+    const defaultSort = SortFieldDisplayName[SortField.datearchived];
+    return this.dateOptionSelected
+      ? SortFieldDisplayName[this.selectedSort] ?? defaultSort
+      : defaultSort;
+  }
+
   private get titleSelectorBar() {
     return html` <alpha-bar
-      headline="Title Starts With"
+      .selectedLetter=${this.selectedTitleFilter}
       @letterChanged=${this.titleLetterChanged}
     ></alpha-bar>`;
   }
 
   private get creatorSelectorBar() {
     return html` <alpha-bar
-      headline="Creator Starts With"
+      .selectedLetter=${this.selectedCreatorFilter}
       @letterChanged=${this.creatorLetterChanged}
     ></alpha-bar>`;
   }
@@ -192,20 +427,6 @@ export class SortFilterBar extends LitElement {
     this.dispatchEvent(event);
   }
 
-  private gridSelected() {
-    this.displayMode = 'grid';
-  }
-
-  private listSelected() {
-    this.displayMode = 'list-compact';
-  }
-
-  private detailSelected(e: Event) {
-    this.displayMode = (e.target as HTMLInputElement).checked
-      ? 'list-detail'
-      : 'list-compact';
-  }
-
   private displayModeChanged() {
     const event = new CustomEvent('displayModeChanged', {
       detail: { displayMode: this.displayMode },
@@ -213,10 +434,15 @@ export class SortFilterBar extends LitElement {
     this.dispatchEvent(event);
   }
 
-  private sortChanged() {
-    const sort = new SortParam(this.sortField, this.sortDirection);
-    const event = new CustomEvent('sortChanged', {
-      detail: { sort },
+  private emitSortChangedEvent() {
+    const event = new CustomEvent<{
+      selectedSort: SortField;
+      sortDirection: 'asc' | 'desc' | null;
+    }>('sortChanged', {
+      detail: {
+        selectedSort: this.selectedSort,
+        sortDirection: this.sortDirection,
+      },
     });
     this.dispatchEvent(event);
   }
@@ -225,6 +451,24 @@ export class SortFilterBar extends LitElement {
     #sort-bar {
       display: flex;
       justify-content: space-between;
+      border: 1px solid rgb(232, 232, 232);
+      align-items: center;
+      padding: 0.5rem 1.5rem;
+    }
+
+    #sort-direction-container {
+      flex: 0;
+    }
+
+    #sort-by-text {
+      text-transform: uppercase;
+    }
+
+    #bottom-shadow {
+      height: 1px;
+      width: 100%;
+      box-shadow: 0 1px 3px rgba(0, 0, 0, 0.5);
+      background-color: #bbb;
     }
 
     ul {
@@ -236,21 +480,127 @@ export class SortFilterBar extends LitElement {
     }
 
     li {
-      padding: 0.5rem 0 0.5rem 0;
+      padding: 0;
+    }
+
+    .sort-button {
+      background: none;
+      color: inherit;
+      border: none;
+      padding: 0;
+      cursor: pointer;
+      outline: inherit;
+      width: 12px;
+      height: 12px;
+      opacity: 0.5;
+    }
+
+    .sort-button.selected {
+      opacity: 1;
+    }
+
+    .sort-button:disabled {
+      opacity: 0.25;
+      cursor: default;
+    }
+
+    #show-details {
+      text-transform: uppercase;
+      cursor: pointer;
+      display: flex;
+    }
+
+    #show-details input {
+      margin-right: 0.5rem;
+      flex: 0 0 12px;
+    }
+
+    #sort-descending-btn {
+      transform: rotate(180deg);
+    }
+
+    #sort-direction-selector {
+      display: flex;
+      flex-direction: column;
+      gap: 3px;
+      margin-right: 1rem;
+    }
+
+    #sort-selector-container {
+      flex: 1;
+    }
+
+    /*
+      we move the desktop sort selector offscreen instead of display: none
+      because we need to observe the width of it vs its container to determine
+      if it's wide enough to display the desktop version and if you displY: none,
+      the width becomes 0
+    */
+    #desktop-sort-selector.hidden {
+      position: absolute;
+      top: -9999px;
+      left: -9999px;
+    }
+
+    #mobile-sort-selector.hidden {
+      display: none;
+    }
+
+    #desktop-sort-selector {
+      display: inline-flex;
     }
 
-    #sort-selector li::after {
+    #desktop-sort-selector li {
+      display: flex;
+      align-items: center;
+    }
+
+    #desktop-sort-selector li a {
+      text-decoration: none;
+      text-transform: uppercase;
+      font-size: 1.4rem;
+      color: #333;
+    }
+
+    #desktop-sort-selector li a.selected {
+      font-weight: bold;
+    }
+
+    #desktop-sort-selector li::after {
       content: '•';
       padding-left: 1rem;
       padding-right: 1rem;
     }
 
-    #sort-selector li:first-child::after {
+    #desktop-sort-selector li:first-child::after {
       content: '';
     }
 
-    #sort-selector li:last-child::after {
+    #desktop-sort-selector li:last-child::after {
       content: '';
     }
+
+    #display-style-selector {
+      flex: 0;
+    }
+
+    #display-style-selector button {
+      background: none;
+      color: inherit;
+      border: none;
+      appearance: none;
+      cursor: pointer;
+      -webkit-appearance: none;
+      opacity: 0.5;
+    }
+
+    #display-style-selector button.active {
+      opacity: 1;
+    }
+
+    #display-style-selector button svg {
+      width: 24px;
+      height: 24px;
+    }
   `;
 }