@justeattakeaway/pie-thumbnail 0.4.0 → 0.5.0

package/custom-elements.json

@@ -36,6 +36,14 @@
           },
           "default": "{\n    default: 'c-thumbnail--backgroundDefault',\n    subtle: 'c-thumbnail--backgroundSubtle',\n    strong: 'c-thumbnail--backgroundStrong',\n    dark: 'c-thumbnail--backgroundDark',\n    inverse: 'c-thumbnail--backgroundInverse',\n    'inverse-alternative': 'c-thumbnail--backgroundInverseAlternative',\n}"
         },
+        {
+          "kind": "variable",
+          "name": "aspectRatios",
+          "type": {
+            "text": "['1by1', '4by3', '16by9']"
+          },
+          "default": "['1by1', '4by3', '16by9']"
+        },
         {
           "kind": "variable",
           "name": "sizes",
@@ -47,7 +55,7 @@
           "type": {
             "text": "DefaultProps"
           },
-          "default": "{\n    variant: 'default',\n    size: 48,\n    src: '',\n    alt: '',\n    disabled: false,\n    hasPadding: false,\n    backgroundColor: 'default',\n    placeholder: {\n        src: '',\n        alt: '',\n    },\n}"
+          "default": "{\n    variant: 'default',\n    size: 48,\n    src: '',\n    alt: '',\n    disabled: false,\n    hasPadding: false,\n    backgroundColor: 'default',\n    aspectRatio: '1by1',\n    placeholder: {\n        src: '',\n        alt: '',\n    },\n}"
         }
       ],
       "exports": [
@@ -75,6 +83,14 @@
             "module": "src/defs.js"
           }
         },
+        {
+          "kind": "js",
+          "name": "aspectRatios",
+          "declaration": {
+            "name": "aspectRatios",
+            "module": "src/defs.js"
+          }
+        },
         {
           "kind": "js",
           "name": "sizes",
@@ -114,6 +130,12 @@
               "privacy": "public",
               "attribute": "size"
             },
+            {
+              "kind": "field",
+              "name": "aspectRatio",
+              "privacy": "public",
+              "attribute": "aspectRatio"
+            },
             {
               "kind": "field",
               "name": "src",
@@ -169,7 +191,8 @@
                 "type": {
                   "text": "string"
                 }
-              }
+              },
+              "description": "Assigns the thumbnail size and border radius CSS variables\nbased on the size prop."
             },
             {
               "kind": "method",
@@ -193,6 +216,10 @@
               "name": "size",
               "fieldName": "size"
             },
+            {
+              "name": "aspectRatio",
+              "fieldName": "aspectRatio"
+            },
             {
               "name": "src",
               "fieldName": "src"

package/dist/index.d.ts

@@ -3,6 +3,8 @@ import type { CSSResult } from 'lit';
 import type { LitElement } from 'lit';
 import type { TemplateResult } from 'lit-html';
 
+export declare const aspectRatios: readonly ["1by1", "4by3", "16by9"];
+
 export declare const backgroundColorClassNames: Record<typeof backgroundColors[number], string>;
 
 export declare const backgroundColors: readonly ["default", "subtle", "strong", "dark", "inverse", "inverse-alternative"];
@@ -17,6 +19,7 @@ export declare const defaultProps: DefaultProps;
 export declare class PieThumbnail extends LitElement implements ThumbnailProps {
     variant: "default" | "outline";
     size: number;
+    aspectRatio: "1by1" | "4by3" | "16by9";
     src: string;
     alt: string;
     disabled: boolean;
@@ -24,6 +27,10 @@ export declare class PieThumbnail extends LitElement implements ThumbnailProps {
     backgroundColor: "default" | "subtle" | "strong" | "dark" | "inverse" | "inverse-alternative";
     placeholder: ThumbnailProps['placeholder'];
     private img;
+    /**
+     * Assigns the thumbnail size and border radius CSS variables
+     * based on the size prop.
+     */
     private _generateSizeStyles;
     /**
      * Handles image load errors by replacing the src and alt props
@@ -80,6 +87,10 @@ export declare interface ThumbnailProps {
      * What placeholder should be used when the image fails to load.
      */
     placeholder?: PlaceholderProps;
+    /**
+     * Sets the aspect-ratio of the thumbnail image.
+     */
+    aspectRatio?: typeof aspectRatios[number];
 }
 
 export declare const variants: readonly ["default", "outline"];

package/dist/index.js

@@ -1,28 +1,28 @@
-import { LitElement as f, html as y, unsafeCSS as k } from "lit";
-import { validPropertyValues as b, defineCustomElement as S } from "@justeattakeaway/pie-webc-core";
-import { classMap as z } from "lit/directives/class-map.js";
-import { property as o, query as _ } from "lit/decorators.js";
-const C = [
+import { LitElement as f, html as k, unsafeCSS as S } from "lit";
+import { validPropertyValues as d, defineCustomElement as z } from "@justeattakeaway/pie-webc-core";
+import { classMap as _ } from "lit/directives/class-map.js";
+import { property as n, query as C } from "lit/decorators.js";
+const E = [
   "default",
   "outline"
-], E = [
+], I = [
   "default",
   "subtle",
   "strong",
   "dark",
   "inverse",
   "inverse-alternative"
-], I = {
+], R = {
   default: "c-thumbnail--backgroundDefault",
   subtle: "c-thumbnail--backgroundSubtle",
   strong: "c-thumbnail--backgroundStrong",
   dark: "c-thumbnail--backgroundDark",
   inverse: "c-thumbnail--backgroundInverse",
   "inverse-alternative": "c-thumbnail--backgroundInverseAlternative"
-}, m = 8, g = 24, x = 128, $ = Object.freeze(Array.from(
-  { length: (x - g) / m + 1 },
-  (c, t) => g + t * m
-)), e = {
+}, $ = ["1by1", "4by3", "16by9"], m = 8, p = 24, x = 128, P = Object.freeze(Array.from(
+  { length: (x - p) / m + 1 },
+  (u, t) => p + t * m
+)), r = {
   variant: "default",
   size: 48,
   src: "",
@@ -30,26 +30,31 @@ const C = [
   disabled: !1,
   hasPadding: !1,
   backgroundColor: "default",
+  aspectRatio: "1by1",
   placeholder: {
     src: "",
     alt: ""
   }
-}, P = ".c-thumbnail{--thumbnail-size: 48px;--thumbnail-border-radius: var(--dt-radius-rounded-b);--thumbnail-bg-color: var(--dt-color-container-default);--thumbnail-border-color: transparent;--thumbnail-padding: calc(var(--dt-spacing-a) / 2);display:flex;justify-content:center;align-items:center;box-sizing:border-box;overflow:hidden;width:var(--thumbnail-size);height:var(--thumbnail-size);border-radius:var(--thumbnail-border-radius);border:1px solid var(--thumbnail-border-color);background-color:var(--thumbnail-bg-color)}.c-thumbnail.c-thumbnail--outline{--thumbnail-border-color: var(--dt-color-border-default)}.c-thumbnail.c-thumbnail--disabled{opacity:.5}.c-thumbnail.c-thumbnail--backgroundSubtle{--thumbnail-bg-color: var(--dt-color-container-subtle)}.c-thumbnail.c-thumbnail--backgroundStrong{--thumbnail-bg-color: var(--dt-color-container-strong)}.c-thumbnail.c-thumbnail--backgroundDark{--thumbnail-bg-color: var(--dt-color-container-dark)}.c-thumbnail.c-thumbnail--backgroundInverse{--thumbnail-bg-color: var(--dt-color-container-inverse)}.c-thumbnail.c-thumbnail--backgroundInverseAlternative{--thumbnail-bg-color: var(--dt-color-container-inverse-alternative)}.c-thumbnail.c-thumbnail--padding{padding:var(--thumbnail-padding)}.c-thumbnail .c-thumbnail-img{width:100%;height:auto}";
-var A = Object.defineProperty, i = (c, t, r, u) => {
-  for (var n = void 0, l = c.length - 1, s; l >= 0; l--)
-    (s = c[l]) && (n = s(t, r, n) || n);
-  return n && A(t, r, n), n;
+}, A = ".c-thumbnail{--thumbnail-size: 48px;--thumbnail-border-radius: var(--dt-radius-rounded-b);--thumbnail-bg-color: var(--dt-color-container-default);--thumbnail-padding: calc(var(--dt-spacing-a) / 2);--thumbnail-img-border-radius: unset;display:flex;justify-content:center;align-items:center;box-sizing:border-box;overflow:hidden;width:var(--thumbnail-size);height:var(--thumbnail-size);border-radius:var(--thumbnail-border-radius);background-color:var(--thumbnail-bg-color)}.c-thumbnail.c-thumbnail--outline{border:1px solid var(--dt-color-border-default)}.c-thumbnail.c-thumbnail--disabled{opacity:.5}.c-thumbnail.c-thumbnail--backgroundSubtle{--thumbnail-bg-color: var(--dt-color-container-subtle)}.c-thumbnail.c-thumbnail--backgroundStrong{--thumbnail-bg-color: var(--dt-color-container-strong)}.c-thumbnail.c-thumbnail--backgroundDark{--thumbnail-bg-color: var(--dt-color-container-dark)}.c-thumbnail.c-thumbnail--backgroundInverse{--thumbnail-bg-color: var(--dt-color-container-inverse)}.c-thumbnail.c-thumbnail--backgroundInverseAlternative{--thumbnail-bg-color: var(--dt-color-container-inverse-alternative)}.c-thumbnail.c-thumbnail--padding{--thumbnail-img-border-radius: calc(var(--thumbnail-border-radius) - var(--thumbnail-padding));padding:var(--thumbnail-padding)}.c-thumbnail.c-thumbnail--4by3{height:calc(var(--thumbnail-size) * 3 / 4)}.c-thumbnail.c-thumbnail--16by9{height:calc(var(--thumbnail-size) * 9 / 16)}.c-thumbnail .c-thumbnail-img{width:100%;height:100%;border-radius:var(--thumbnail-img-border-radius);object-fit:cover}";
+var j = Object.defineProperty, i = (u, t, a, b) => {
+  for (var o = void 0, l = u.length - 1, c; l >= 0; l--)
+    (c = u[l]) && (o = c(t, a, o) || o);
+  return o && j(t, a, o), o;
 };
-const d = "pie-thumbnail", h = class h extends f {
+const s = "pie-thumbnail", h = class h extends f {
   constructor() {
-    super(...arguments), this.variant = e.variant, this.size = e.size, this.src = e.src, this.alt = e.alt, this.disabled = e.disabled, this.hasPadding = e.hasPadding, this.backgroundColor = e.backgroundColor, this.placeholder = e.placeholder;
+    super(...arguments), this.variant = r.variant, this.size = r.size, this.aspectRatio = r.aspectRatio, this.src = r.src, this.alt = r.alt, this.disabled = r.disabled, this.hasPadding = r.hasPadding, this.backgroundColor = r.backgroundColor, this.placeholder = r.placeholder;
   }
+  /**
+   * Assigns the thumbnail size and border radius CSS variables
+   * based on the size prop.
+   */
   _generateSizeStyles() {
     const { size: t } = this;
-    let r = "--dt-radius-rounded-c";
-    return t <= 40 ? r = "--dt-radius-rounded-a" : t <= 56 && (r = "--dt-radius-rounded-b"), `
+    let a = "--dt-radius-rounded-c";
+    return t <= 40 ? a = "--dt-radius-rounded-a" : t <= 56 && (a = "--dt-radius-rounded-b"), `
             --thumbnail-size: ${t}px;
-            --thumbnail-border-radius: var(${r});
+            --thumbnail-border-radius: var(${a});
         `;
   }
   /**
@@ -57,8 +62,8 @@ const d = "pie-thumbnail", h = class h extends f {
    * with the placeholder props.
    */
   _handleImageError() {
-    var t, r;
-    (t = this.placeholder) != null && t.src && this.setAttribute("src", this.placeholder.src), (r = this.placeholder) != null && r.alt && this.setAttribute("alt", this.placeholder.alt);
+    var t, a;
+    (t = this.placeholder) != null && t.src && this.setAttribute("src", this.placeholder.src), (a = this.placeholder) != null && a.alt && this.setAttribute("alt", this.placeholder.alt);
   }
   /**
    * Detects image load status and applies the placeholder on failure.
@@ -66,8 +71,8 @@ const d = "pie-thumbnail", h = class h extends f {
    */
   _checkImageError() {
     if (this.img) {
-      const { complete: t, naturalHeight: r } = this.img;
-      t && r === 0 && this._handleImageError.call(this);
+      const { complete: t, naturalHeight: a } = this.img;
+      t && a === 0 && this._handleImageError.call(this);
     }
   }
   firstUpdated() {
@@ -76,71 +81,78 @@ const d = "pie-thumbnail", h = class h extends f {
   render() {
     const {
       variant: t,
-      src: r,
-      alt: u,
-      disabled: n,
+      src: a,
+      alt: b,
+      disabled: o,
       hasPadding: l,
-      backgroundColor: s
-    } = this, p = {
+      backgroundColor: c,
+      aspectRatio: g
+    } = this, v = {
       "c-thumbnail": !0,
       [`c-thumbnail--${t}`]: !0,
-      [I[s]]: !0,
-      "c-thumbnail--disabled": n,
+      [`c-thumbnail--${g}`]: !0,
+      [R[c]]: !0,
+      "c-thumbnail--disabled": o,
       "c-thumbnail--padding": l
-    }, v = this._generateSizeStyles();
-    return y`
+    }, y = this._generateSizeStyles();
+    return k`
             <div data-test-id="pie-thumbnail"
-             class="${z(p)}"
-             style="${v}">
+             class="${_(v)}"
+             style="${y}">
                 <img
                     data-test-id="pie-thumbnail-img"
-                    src="${r}"
+                    src="${a}"
                     class="c-thumbnail-img"
-                    alt="${u}"
+                    alt="${b}"
                     @error="${this._handleImageError}"
                 />
             </div>
         `;
   }
 };
-h.styles = k(P);
-let a = h;
+h.styles = S(A);
+let e = h;
+i([
+  n({ type: String }),
+  d(s, E, r.variant)
+], e.prototype, "variant");
 i([
-  o({ type: String }),
-  b(d, C, e.variant)
-], a.prototype, "variant");
+  n({ type: Number }),
+  d(s, P, r.size)
+], e.prototype, "size");
 i([
-  o({ type: Number }),
-  b(d, $, e.size)
-], a.prototype, "size");
+  n({ type: String }),
+  d(s, $, r.aspectRatio)
+], e.prototype, "aspectRatio");
 i([
-  o({ type: String })
-], a.prototype, "src");
+  n({ type: String })
+], e.prototype, "src");
 i([
-  o({ type: String })
-], a.prototype, "alt");
+  n({ type: String })
+], e.prototype, "alt");
 i([
-  o({ type: Boolean })
-], a.prototype, "disabled");
+  n({ type: Boolean })
+], e.prototype, "disabled");
 i([
-  o({ type: Boolean })
-], a.prototype, "hasPadding");
+  n({ type: Boolean })
+], e.prototype, "hasPadding");
 i([
-  o({ type: String }),
-  b(d, E, e.backgroundColor)
-], a.prototype, "backgroundColor");
+  n({ type: String }),
+  d(s, I, r.backgroundColor)
+], e.prototype, "backgroundColor");
 i([
-  o({ type: Object })
-], a.prototype, "placeholder");
+  n({ type: Object })
+], e.prototype, "placeholder");
 i([
-  _("img")
-], a.prototype, "img");
-S(d, a);
+  C("img")
+], e.prototype, "img");
+z(s, e);
 export {
-  a as PieThumbnail,
-  I as backgroundColorClassNames,
-  E as backgroundColors,
-  e as defaultProps,
-  $ as sizes,
-  C as variants
+  e as PieThumbnail,
+  $ as aspectRatios,
+  R as backgroundColorClassNames,
+  I as backgroundColors,
+  r as defaultProps,
+  P as sizes,
+  E as variants
 };

package/dist/react.d.ts

@@ -4,6 +4,8 @@ import type { LitElement } from 'lit';
 import * as React_2 from 'react';
 import type { TemplateResult } from 'lit-html';
 
+export declare const aspectRatios: readonly ["1by1", "4by3", "16by9"];
+
 export declare const backgroundColorClassNames: Record<typeof backgroundColors[number], string>;
 
 export declare const backgroundColors: readonly ["default", "subtle", "strong", "dark", "inverse", "inverse-alternative"];
@@ -20,6 +22,7 @@ export declare const PieThumbnail: React_2.ForwardRefExoticComponent<ThumbnailPr
 declare class PieThumbnail_2 extends LitElement implements ThumbnailProps {
     variant: "default" | "outline";
     size: number;
+    aspectRatio: "1by1" | "4by3" | "16by9";
     src: string;
     alt: string;
     disabled: boolean;
@@ -27,6 +30,10 @@ declare class PieThumbnail_2 extends LitElement implements ThumbnailProps {
     backgroundColor: "default" | "subtle" | "strong" | "dark" | "inverse" | "inverse-alternative";
     placeholder: ThumbnailProps['placeholder'];
     private img;
+    /**
+     * Assigns the thumbnail size and border radius CSS variables
+     * based on the size prop.
+     */
     private _generateSizeStyles;
     /**
      * Handles image load errors by replacing the src and alt props
@@ -85,6 +92,10 @@ export declare interface ThumbnailProps {
      * What placeholder should be used when the image fails to load.
      */
     placeholder?: PlaceholderProps;
+    /**
+     * Sets the aspect-ratio of the thumbnail image.
+     */
+    aspectRatio?: typeof aspectRatios[number];
 }
 
 export declare const variants: readonly ["default", "outline"];

package/dist/react.js

@@ -1,19 +1,20 @@
 import * as a from "react";
 import { createComponent as e } from "@lit/react";
 import { PieThumbnail as o } from "./index.js";
-import { backgroundColorClassNames as l, backgroundColors as p, defaultProps as u, sizes as b, variants as c } from "./index.js";
-const i = e({
+import { aspectRatios as l, backgroundColorClassNames as p, backgroundColors as c, defaultProps as u, sizes as b, variants as h } from "./index.js";
+const t = e({
   displayName: "PieThumbnail",
   elementClass: o,
   react: a,
   tagName: "pie-thumbnail",
   events: {}
-}), r = i;
+}), s = t;
 export {
-  r as PieThumbnail,
-  l as backgroundColorClassNames,
-  p as backgroundColors,
+  s as PieThumbnail,
+  l as aspectRatios,
+  p as backgroundColorClassNames,
+  c as backgroundColors,
   u as defaultProps,
   b as sizes,
-  c as variants
+  h as variants
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@justeattakeaway/pie-thumbnail",
   "description": "PIE Design System Thumbnail built using Web Components",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",

package/src/defs.ts

@@ -17,6 +17,8 @@ export const backgroundColorClassNames: Record<typeof backgroundColors[number],
     'inverse-alternative': 'c-thumbnail--backgroundInverseAlternative',
 };
 
+export const aspectRatios = ['1by1', '4by3', '16by9'] as const;
+
 const SIZE_INCREMENT_BY = 8;
 const SIZE_MIN = 24;
 const SIZE_MAX = 128;
@@ -64,6 +66,10 @@ export interface ThumbnailProps {
      * What placeholder should be used when the image fails to load.
      */
     placeholder?: PlaceholderProps;
+     /**
+     * Sets the aspect-ratio of the thumbnail image.
+     */
+     aspectRatio?: typeof aspectRatios[number];
 }
 
 export type DefaultProps = ComponentDefaultProps<ThumbnailProps>;
@@ -76,6 +82,7 @@ export const defaultProps: DefaultProps = {
     disabled: false,
     hasPadding: false,
     backgroundColor: 'default',
+    aspectRatio: '1by1',
     placeholder: {
         src: '',
         alt: '',

package/src/index.ts

@@ -13,6 +13,7 @@ import {
     backgroundColors,
     backgroundColorClassNames,
     sizes,
+    aspectRatios,
 } from './defs';
 import styles from './thumbnail.scss?inline';
 
@@ -33,6 +34,10 @@ export class PieThumbnail extends LitElement implements ThumbnailProps {
     @validPropertyValues(componentSelector, sizes, defaultProps.size)
     public size = defaultProps.size;
 
+    @property({ type: String })
+    @validPropertyValues(componentSelector, aspectRatios, defaultProps.aspectRatio)
+    public aspectRatio = defaultProps.aspectRatio;
+
     @property({ type: String })
     public src = defaultProps.src;
 
@@ -55,6 +60,10 @@ export class PieThumbnail extends LitElement implements ThumbnailProps {
     @query('img')
     private img!: HTMLImageElement;
 
+    /**
+     * Assigns the thumbnail size and border radius CSS variables
+     * based on the size prop.
+     */
     private _generateSizeStyles (): string {
         const { size } = this;
         let borderRadius = '--dt-radius-rounded-c';
@@ -103,11 +112,13 @@ export class PieThumbnail extends LitElement implements ThumbnailProps {
             disabled,
             hasPadding,
             backgroundColor,
+            aspectRatio,
         } = this;
 
         const wrapperClasses = {
             'c-thumbnail': true,
             [`c-thumbnail--${variant}`]: true,
+            [`c-thumbnail--${aspectRatio}`]: true,
             [backgroundColorClassNames[backgroundColor]]: true,
             'c-thumbnail--disabled': disabled,
             'c-thumbnail--padding': hasPadding,

package/src/thumbnail.scss

@@ -2,8 +2,8 @@
   --thumbnail-size: 48px;
   --thumbnail-border-radius: var(--dt-radius-rounded-b);
   --thumbnail-bg-color: var(--dt-color-container-default);
-  --thumbnail-border-color: transparent;
   --thumbnail-padding: calc(var(--dt-spacing-a) / 2);
+  --thumbnail-img-border-radius: unset;
 
   display: flex;
   justify-content: center;
@@ -13,11 +13,10 @@
   width: var(--thumbnail-size);
   height: var(--thumbnail-size);
   border-radius: var(--thumbnail-border-radius);
-  border: 1px solid var(--thumbnail-border-color);
   background-color: var(--thumbnail-bg-color);
 
   &.c-thumbnail--outline {
-    --thumbnail-border-color: var(--dt-color-border-default);
+    border: 1px solid var(--dt-color-border-default);
   }
 
   &.c-thumbnail--disabled {
@@ -45,11 +44,22 @@
   }
 
   &.c-thumbnail--padding {
+    --thumbnail-img-border-radius: calc(var(--thumbnail-border-radius) - var(--thumbnail-padding));
     padding: var(--thumbnail-padding);
   }
 
+  &.c-thumbnail--4by3 {
+    height: calc(var(--thumbnail-size) * 3 / 4)
+  }
+
+  &.c-thumbnail--16by9 {
+    height: calc(var(--thumbnail-size) * 9 / 16)
+  }
+
   .c-thumbnail-img {
     width: 100%;
-    height: auto;
+    height: 100%;
+    border-radius: var(--thumbnail-img-border-radius);
+    object-fit: cover;
   }
 }