@internetarchive/collection-browser 0.0.1-alpha.13 → 0.0.1-alpha.16

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

@@ -1,26 +1,37 @@
-import { LitElement, html, css, nothing, PropertyValues } from 'lit';
-import { customElement, property, state } from 'lit/decorators.js';
-import { CollectionDisplayMode, SortField } 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 { gridIcon } from './img/grid';
 import { listIcon } from './img/list';
 
-enum SortFieldName {
-  datearchived = 'Date Archived',
-  datepublished = 'Date Published',
-  datereviewed = 'Date Reviewed',
-  dateadded = 'Date Added',
-}
-
 @customElement('sort-filter-bar')
-export class SortFilterBar extends LitElement {
+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 = 'relevance';
+  @property({ type: String }) selectedSort: SortField = SortField.relevance;
 
   @property({ type: String }) selectedTitleFilter: string | null = null;
 
@@ -28,12 +39,24 @@ export class SortFilterBar extends LitElement {
 
   @property({ type: Boolean }) showRelevance: boolean = true;
 
+  @property({ type: Object }) resizeObserver?: SharedResizeObserverInterface;
+
   @state() titleSelectorVisible: boolean = false;
 
   @state() creatorSelectorVisible: boolean = false;
 
   @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="container">
@@ -45,143 +68,16 @@ export class SortFilterBar extends LitElement {
           : nothing}
 
         <div id="sort-bar">
-          <div id="sort-selector">
-            <ul>
-              <li>
-                <div id="sort-direction-container">
-                  <button
-                    id="sort-ascending-btn"
-                    class="sort-button ${this.sortDirection === 'asc'
-                      ? 'selected'
-                      : ''}"
-                    @click=${() => {
-                      this.sortDirection = 'asc';
-                    }}
-                  >
-                    ${sortIcon}
-                  </button>
-                  <button
-                    id="sort-descending-btn"
-                    class="sort-button ${this.sortDirection === 'desc'
-                      ? 'selected'
-                      : ''}"
-                    @click=${() => {
-                      this.sortDirection = 'desc';
-                    }}
-                  >
-                    ${sortIcon}
-                  </button>
-                </div>
-              </li>
-              <li id="sort-by-text">Sort By</li>
-              ${this.showRelevance
-                ? html`
-                    <li>
-                      <a
-                        href="#"
-                        @click=${(e: Event) => {
-                          e.preventDefault();
-                          this.selectedSort = 'relevance';
-                        }}
-                        class=${this.selectedSort === 'relevance'
-                          ? 'selected'
-                          : ''}
-                      >
-                        Relevance
-                      </a>
-                    </li>
-                  `
-                : nothing}
-              <li>
-                <a
-                  href="#"
-                  @click=${(e: Event) => {
-                    e.preventDefault();
-                    this.selectedSort = 'views';
-                  }}
-                  class=${this.selectedSort === 'views' ? 'selected' : ''}
-                >
-                  Views
-                </a>
-              </li>
-              <li>
-                <a
-                  href="#"
-                  @click=${(e: Event) => {
-                    e.preventDefault();
-                    this.titleSelectorVisible = !this.titleSelectorVisible;
-                    this.selectedSort = 'title';
-                  }}
-                  class=${this.selectedSort === 'title' ? 'selected' : ''}
-                >
-                  Title
-                </a>
-              </li>
-              <li>
-                <a
-                  href="#"
-                  @click=${(e: Event) => {
-                    e.preventDefault();
-                    this.dateSortSelectorVisible =
-                      !this.dateSortSelectorVisible;
-                    this.selectedSort = 'datearchived';
-                  }}
-                  class=${this.dateOptionSelected ? 'selected' : ''}
-                >
-                  ${this.dateSortField}
-                </a>
-              </li>
-              <li>
-                <a
-                  href="#"
-                  @click=${(e: Event) => {
-                    e.preventDefault();
-                    this.creatorSelectorVisible = !this.creatorSelectorVisible;
-                    this.selectedSort = 'creator';
-                  }}
-                  class=${this.selectedSort === 'creator' ? 'selected' : ''}
-                >
-                  Creator
-                </a>
-              </li>
-            </ul>
+          <div id="sort-direction-container">
+            ${this.sortDirectionSelectorTemplate}
           </div>
 
-          <div id="display-style">
-            <ul>
-              ${this.displayMode !== 'grid'
-                ? html`<li>
-                    <label id="show-details">
-                      <input
-                        type="checkbox"
-                        @click=${this.detailSelected}
-                        ?checked=${this.displayMode === 'list-detail'}
-                      />
-                      Show Details
-                    </label>
-                  </li>`
-                : nothing}
-
-              <li>
-                <button
-                  id="grid-button"
-                  @click=${this.gridSelected}
-                  class=${this.displayMode === 'grid' ? 'active' : ''}
-                >
-                  ${gridIcon}
-                </button>
-              </li>
-              <li>
-                <button
-                  id="list-button"
-                  @click=${this.listSelected}
-                  class=${this.displayMode !== 'grid' ? 'active' : ''}
-                >
-                  ${listIcon}
-                </button>
-              </li>
-            </ul>
+          <div id="sort-selector-container">
+            ${this.mobileSortSelectorTemplate}
+            ${this.desktopSortSelectorTemplate}
           </div>
+
+          <div id="display-style-selector">${this.displayOptionTemplate}</div>
         </div>
 
         ${this.dateSortSelectorVisible ? this.dateSortSelector : nothing}
@@ -196,13 +92,6 @@ export class SortFilterBar extends LitElement {
       this.displayModeChanged();
     }
 
-    if (
-      (changed.has('sortDirection') || changed.has('selectedSort')) &&
-      this.sortDirection !== null
-    ) {
-      this.sortChanged();
-    }
-
     if (changed.has('selectedSort') && this.sortDirection === null) {
       this.sortDirection = 'desc';
     }
@@ -214,57 +103,261 @@ export class SortFilterBar extends LitElement {
     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>
+        ${this.displayMode !== 'grid'
+          ? html`<li>
+              <label id="show-details">
+                <input
+                  type="checkbox"
+                  @click=${this.detailSelected}
+                  ?checked=${this.displayMode === 'list-detail'}
+                />
+                Show Details
+              </label>
+            </li>`
+          : nothing}
+
+        <li>
+          <button
+            id="grid-button"
+            @click=${this.gridSelected}
+            class=${this.displayMode === 'grid' ? 'active' : ''}
+          >
+            ${gridIcon}
+          </button>
+        </li>
+        <li>
+          <button
+            id="list-button"
+            @click=${this.listSelected}
+            class=${this.displayMode !== 'grid' ? 'active' : ''}
+          >
+            ${listIcon}
+          </button>
+        </li>
+      </ul>
+    `;
   }
 
   private get dateSortSelector() {
     return html`
       <div id="date-sort-selector">
         <ul>
-          <li>
-            <button
-              @click=${() => {
-                this.selectedSort = 'datepublished';
-                this.dateSortSelectorVisible = false;
-              }}
-            >
-              Date Archived
-            </button>
-          </li>
-          <li>
-            <button
-              @click=${() => {
-                this.selectedSort = 'datepublished';
-                this.dateSortSelectorVisible = false;
-              }}
-            >
-              Date Published
-            </button>
-          </li>
-          <li>
-            <button
-              @click=${() => {
-                this.selectedSort = 'datereviewed';
-                this.dateSortSelectorVisible = false;
-              }}
-            >
-              Date Reviewed
-            </button>
-          </li>
-          <li>
-            <button
-              @click=${() => {
-                this.selectedSort = 'dateadded';
-                this.dateSortSelectorVisible = false;
-              }}
-            >
-              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.
    *
@@ -293,10 +386,7 @@ export class SortFilterBar extends LitElement {
    * @memberof SortFilterBar
    */
   private get dateSortField(): string {
-    return (
-      SortFieldName[this.selectedSort as keyof typeof SortFieldName] ??
-      'Date Archived'
-    );
+    return SortFieldDisplayName[this.selectedSort] ?? 'Date Archived';
   }
 
   private get titleSelectorBar() {
@@ -333,16 +423,19 @@ export class SortFilterBar extends LitElement {
 
   private gridSelected() {
     this.displayMode = 'grid';
+    this.emitSortChangedEvent();
   }
 
   private listSelected() {
     this.displayMode = 'list-compact';
+    this.emitSortChangedEvent();
   }
 
   private detailSelected(e: Event) {
     this.displayMode = (e.target as HTMLInputElement).checked
       ? 'list-detail'
       : 'list-compact';
+    this.emitSortChangedEvent();
   }
 
   private displayModeChanged() {
@@ -352,7 +445,7 @@ export class SortFilterBar extends LitElement {
     this.dispatchEvent(event);
   }
 
-  private sortChanged() {
+  private emitSortChangedEvent() {
     const event = new CustomEvent<{
       selectedSort: SortField;
       sortDirection: 'asc' | 'desc' | null;
@@ -378,6 +471,10 @@ export class SortFilterBar extends LitElement {
       padding: 0.5rem 1.5rem;
     }
 
+    #sort-direction-container {
+      flex: 0;
+    }
+
     #sort-by-text {
       text-transform: uppercase;
     }
@@ -417,6 +514,11 @@ export class SortFilterBar extends LitElement {
       opacity: 1;
     }
 
+    .sort-button:disabled {
+      opacity: 0.25;
+      cursor: default;
+    }
+
     #show-details {
       text-transform: uppercase;
       cursor: pointer;
@@ -426,43 +528,72 @@ export class SortFilterBar extends LitElement {
       transform: rotate(180deg);
     }
 
-    #sort-direction-container {
+    #sort-direction-selector {
       display: flex;
       flex-direction: column;
       gap: 3px;
+      margin-right: 1rem;
     }
 
-    #sort-selector li {
+    #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;
+    }
+
+    #desktop-sort-selector li {
       display: flex;
       align-items: center;
     }
 
-    #sort-selector li a {
+    #desktop-sort-selector li a {
       text-decoration: none;
       text-transform: uppercase;
       font-size: 1.4rem;
       color: #333;
     }
 
-    #sort-selector li a.selected {
+    #desktop-sort-selector li a.selected {
       font-weight: bold;
     }
 
-    #sort-selector li::after {
+    #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 button {
+    #display-style-selector {
+      flex: 0;
+    }
+
+    #display-style-selector button {
       background: none;
       color: inherit;
       border: none;
@@ -472,11 +603,11 @@ export class SortFilterBar extends LitElement {
       opacity: 0.5;
     }
 
-    #display-style button.active {
+    #display-style-selector button.active {
       opacity: 1;
     }
 
-    #display-style button svg {
+    #display-style-selector button svg {
       width: 24px;
       height: 24px;
     }