@internetarchive/collection-browser 2.3.0 → 2.4.0-e2e-test-0

package/src/tiles/hover/tile-hover-pane.ts

@@ -1,7 +1,14 @@
 import type { SortParam } from '@internetarchive/search-service';
-import { css, CSSResultGroup, html, LitElement, TemplateResult } from 'lit';
+import {
+  css,
+  CSSResultGroup,
+  html,
+  LitElement,
+  nothing,
+  TemplateResult,
+} from 'lit';
 import { customElement, property } from 'lit/decorators.js';
-import type { TileModel } from '../../models';
+import { suppressedCollections, type TileModel } from '../../models';
 import type { CollectionTitles } from '../../data-source/models';
 import '../list/tile-list';
 
@@ -17,31 +24,79 @@ export class TileHoverPane extends LitElement {
 
   @property({ type: Object }) sortParam?: SortParam;
 
+  @property({ type: Number }) mobileBreakpoint?: number;
+
+  @property({ type: Number }) currentWidth?: Number;
+
   @property({ type: Object })
   collectionTitles?: CollectionTitles;
 
   protected render(): TemplateResult {
     return html`
       <div id="container">
-        <tile-list
-          .model=${this.model}
-          .baseNavigationUrl=${this.baseNavigationUrl}
-          .baseImageUrl=${this.baseImageUrl}
-          .loggedIn=${this.loggedIn}
-          .sortParam=${this.sortParam}
-          .collectionTitles=${this.collectionTitles}
-        ></tile-list>
+        ${this.headerTemplate}
+        <div id="hover-tile-list">
+          <tile-list
+            .model=${this.model}
+            .baseNavigationUrl=${this.baseNavigationUrl}
+            .baseImageUrl=${this.baseImageUrl}
+            .loggedIn=${this.loggedIn}
+            .sortParam=${this.sortParam}
+            .collectionTitles=${this.collectionTitles}
+            .mobileBreakpoint=${this.mobileBreakpoint}
+            .currentWidth=${this.currentWidth}
+          ></tile-list>
+        </div>
+      </div>
+    `;
+  }
+
+  private get headerTemplate(): TemplateResult | typeof nothing {
+    // early return if item does't have parent collection
+    if (this.model?.collections.length === 0) return nothing;
+
+    let collectionTitle = '';
+    let collectionIdentifier = '';
+
+    for (const collection of this.model?.collections || []) {
+      if (
+        !suppressedCollections[collection] &&
+        !collection.startsWith('fav-')
+      ) {
+        collectionTitle = this.collectionTitles?.get(collection) ?? collection;
+        collectionIdentifier = collection;
+        break;
+      }
+    }
+
+    // sometimes item does have collections but they are in suppressed or favorite list,
+    // let's not render that
+    if (!collectionIdentifier) return nothing;
+
+    return html`
+      <div id="list-line-header">
+        <a href="${this.baseNavigationUrl}/details/${collectionIdentifier}">
+          <img
+            src="${this.baseImageUrl}/services/img/${collectionIdentifier}"
+            alt=""
+          /><span>${collectionTitle}</span>
+        </a>
       </div>
     `;
   }
 
   static get styles(): CSSResultGroup {
+    const hoverPaneHeaderBGColor = css`var(--hoverPaneHeaderBGColor, #edf0ff)`;
+    const iaLinkColor = css`var(--ia-theme-link-color, #4b64ff)`;
+    const iaFontFamily = css`var(--ia-theme-base-font-family, "Helvetica Neue", Helvetica, Arial, sans-serif);`;
+
     return css`
       :host {
         visibility: hidden;
         opacity: 0;
         transform: translateY(8px);
         transition: opacity 0.1s ease-in, transform 0.1s ease-in;
+        --image-width: auto;
       }
 
       :host(.visible) {
@@ -62,7 +117,6 @@ export class TileHoverPane extends LitElement {
       #container {
         width: max-content;
         max-width: min(45vw, 600px);
-        padding: 10px;
         border: 1px solid #ddd;
         border-radius: 4px;
         box-shadow: 4px 4px 8px 0 rgba(0, 0, 0, 0.8);
@@ -74,6 +128,41 @@ export class TileHoverPane extends LitElement {
           max-width: 80vw;
         }
       }
+
+      /* main tile-list container */
+      #hover-tile-list {
+        padding: 10px;
+      }
+
+      /* header on hover panel to show collection icon and title */
+      #list-line-header {
+        background: ${hoverPaneHeaderBGColor};
+      }
+      #list-line-header a {
+        display: flex;
+        align-items: center;
+        column-gap: 5px;
+        height: 3.4rem;
+        padding: 0 10px;
+        width: fit-content;
+        font-size: 1.4rem;
+        color: ${iaLinkColor};
+        font-family: ${iaFontFamily};
+        text-decoration: none;
+        width: auto;
+      }
+      #list-line-header a span {
+        white-space: nowrap;
+        overflow: hidden;
+        text-overflow: ellipsis;
+      }
+      #list-line-header a:hover {
+        text-decoration: underline;
+      }
+      #list-line-header a img {
+        width: 30px;
+        max-height: 30px;
+      }
     `;
   }
 }

package/src/tiles/image-block.ts

@@ -125,7 +125,7 @@ export class ImageBlock extends LitElement {
       }
 
       .list.mobile {
-        width: 90px;
+        width: var(--image-width, 90px);
         height: 90px;
       }
 

package/test/tiles/hover/tile-hover-pane.test.ts

@@ -1,5 +1,6 @@
 import { expect, fixture } from '@open-wc/testing';
 import { html } from 'lit';
+import type { TileModel } from '../../../src/models';
 import type { TileHoverPane } from '../../../src/tiles/hover/tile-hover-pane';
 
 import '../../../src/tiles/hover/tile-hover-pane';
@@ -16,4 +17,64 @@ describe('Tile Hover Pane', () => {
     expect(container).to.exist;
     expect(listView).to.exist;
   });
+
+  it('should render component with header element', async () => {
+    const model: Partial<TileModel> = {
+      mediatype: 'texts',
+      collections: ['collection1', 'fav-jack-sparrow'],
+    };
+
+    const el = await fixture<TileHoverPane>(
+      html`<tile-hover-pane .model=${model}></tile-hover-pane>`
+    );
+
+    const container = el.shadowRoot?.querySelector('#container');
+    const listView = container?.querySelector('tile-list');
+    const headerElement = container?.querySelector('#list-line-header');
+
+    expect(container).to.exist;
+    expect(listView).to.exist;
+    expect(headerElement).to.exist;
+    expect(headerElement?.querySelector('a')?.getAttribute('href')).contains(
+      '/details/collection1'
+    );
+  });
+
+  it('should NOT render header element when fav- collection', async () => {
+    const model: Partial<TileModel> = {
+      mediatype: 'texts',
+      collections: ['fav-jack-sparrow'],
+    };
+
+    const el = await fixture<TileHoverPane>(
+      html`<tile-hover-pane .model=${model}></tile-hover-pane>`
+    );
+
+    const container = el.shadowRoot?.querySelector('#container');
+    const listView = container?.querySelector('tile-list');
+    const headerElement = container?.querySelector('#list-line-header');
+
+    expect(container).to.exist;
+    expect(listView).to.exist;
+    expect(headerElement).not.exist;
+  });
+
+  it('should NOT render header element when no collections', async () => {
+    const model: Partial<TileModel> = {
+      mediatype: 'texts',
+      collections: [],
+    };
+
+    const el = await fixture<TileHoverPane>(
+      html`<tile-hover-pane .model=${model}></tile-hover-pane>`
+    );
+
+    const container = el.shadowRoot?.querySelector('#container');
+    const listView = container?.querySelector('tile-list');
+    const headerElement = container?.querySelector('#list-line-header');
+
+    expect(container).to.exist;
+    expect(listView).to.exist;
+    expect(headerElement).not.exist;
+  });
 });

package/tsconfig.json

@@ -1,21 +1,21 @@
-{
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noEmitOnError": true,
-    "lib": ["es2017", "dom"],
-    "strict": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "importHelpers": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "inlineSources": true,
-    "rootDir": "./",
-    "declaration": true,
-    "importsNotUsedAsValues": "error"
-  },
-  "include": ["src", "test", "index.ts", "types"],
-}
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noEmitOnError": true,
+    "lib": ["es2017", "dom"],
+    "strict": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "inlineSources": true,
+    "rootDir": "./",
+    "declaration": true,
+    "importsNotUsedAsValues": "error"
+  },
+  "include": ["src", "test", "index.ts", "types"],
+}

package/web-dev-server.config.mjs

@@ -1,30 +1,30 @@
-// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
-
-/** Use Hot Module replacement by adding --hmr to the start command */
-const hmr = process.argv.includes('--hmr');
-
-export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
-  nodeResolve: true,
-  open: '/',
-  watch: !hmr,
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto'
-
-  /** Set appIndex to enable SPA routing */
-  // appIndex: 'demo/index.html',
-
-  /** Confgure bare import resolve plugin */
-  // nodeResolve: {
-  //   exportConditions: ['browser', 'development']
-  // },
-
-  plugins: [
-    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
-    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
-  ],
-
-  http2: true,
-  sslCert: './local.archive.org.cert',
-  sslKey: './local.archive.org.key',
-});
+// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
+
+/** Use Hot Module replacement by adding --hmr to the start command */
+const hmr = process.argv.includes('--hmr');
+
+export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
+  nodeResolve: true,
+  open: '/',
+  watch: !hmr,
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto'
+
+  /** Set appIndex to enable SPA routing */
+  // appIndex: 'demo/index.html',
+
+  /** Confgure bare import resolve plugin */
+  // nodeResolve: {
+  //   exportConditions: ['browser', 'development']
+  // },
+
+  plugins: [
+    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
+    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
+  ],
+
+  http2: true,
+  sslCert: './local.archive.org.cert',
+  sslKey: './local.archive.org.key',
+});

package/web-test-runner.config.mjs

@@ -1,41 +1,41 @@
-// import { playwrightLauncher } from '@web/test-runner-playwright';
-
-const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
-
-export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
-  /** Test files to run */
-  files: 'dist/test/**/*.test.js',
-
-  /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
-
-  /** Filter out lit dev mode logs */
-  filterBrowserLogs(log) {
-    for (const arg of log.args) {
-      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
-        return false;
-      }
-    }
-    return true;
-  },
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto',
-
-  /** Amount of browsers to run concurrently */
-  // concurrentBrowsers: 2,
-
-  /** Amount of test files per browser to test concurrently */
-  // concurrency: 1,
-
-  /** Browsers to run tests on */
-  // browsers: [
-  //   playwrightLauncher({ product: 'chromium' }),
-  //   playwrightLauncher({ product: 'firefox' }),
-  //   playwrightLauncher({ product: 'webkit' }),
-  // ],
-
-  // See documentation for all available options
-});
+// import { playwrightLauncher } from '@web/test-runner-playwright';
+
+const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
+
+export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
+  /** Test files to run */
+  files: 'dist/test/**/*.test.js',
+
+  /** Resolve bare module imports */
+  nodeResolve: {
+    exportConditions: ['browser', 'development'],
+  },
+
+  /** Filter out lit dev mode logs */
+  filterBrowserLogs(log) {
+    for (const arg of log.args) {
+      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
+        return false;
+      }
+    }
+    return true;
+  },
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto',
+
+  /** Amount of browsers to run concurrently */
+  // concurrentBrowsers: 2,
+
+  /** Amount of test files per browser to test concurrently */
+  // concurrency: 1,
+
+  /** Browsers to run tests on */
+  // browsers: [
+  //   playwrightLauncher({ product: 'chromium' }),
+  //   playwrightLauncher({ product: 'firefox' }),
+  //   playwrightLauncher({ product: 'webkit' }),
+  // ],
+
+  // See documentation for all available options
+});