@justeattakeaway/pie-thumbnail 0.3.0 → 0.4.0

package/custom-elements.json

@@ -36,13 +36,18 @@
           },
           "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": "sizes",
+          "default": "Object.freeze(Array.from(\n    { length: (SIZE_MAX - SIZE_MIN) / SIZE_INCREMENT_BY + 1 },\n    (_, i) => SIZE_MIN + i * SIZE_INCREMENT_BY,\n))"
+        },
         {
           "kind": "variable",
           "name": "defaultProps",
           "type": {
             "text": "DefaultProps"
           },
-          "default": "{\n    variant: 'default',\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    placeholder: {\n        src: '',\n        alt: '',\n    },\n}"
         }
       ],
       "exports": [
@@ -70,6 +75,14 @@
             "module": "src/defs.js"
           }
         },
+        {
+          "kind": "js",
+          "name": "sizes",
+          "declaration": {
+            "name": "sizes",
+            "module": "src/defs.js"
+          }
+        },
         {
           "kind": "js",
           "name": "defaultProps",
@@ -95,6 +108,12 @@
               "privacy": "public",
               "attribute": "variant"
             },
+            {
+              "kind": "field",
+              "name": "size",
+              "privacy": "public",
+              "attribute": "size"
+            },
             {
               "kind": "field",
               "name": "src",
@@ -142,6 +161,16 @@
               },
               "privacy": "private"
             },
+            {
+              "kind": "method",
+              "name": "_generateSizeStyles",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              }
+            },
             {
               "kind": "method",
               "name": "_handleImageError",
@@ -160,6 +189,10 @@
               "name": "variant",
               "fieldName": "variant"
             },
+            {
+              "name": "size",
+              "fieldName": "size"
+            },
             {
               "name": "src",
               "fieldName": "src"

package/dist/index.d.ts

@@ -7,7 +7,7 @@ export declare const backgroundColorClassNames: Record<typeof backgroundColors[n
 
 export declare const backgroundColors: readonly ["default", "subtle", "strong", "dark", "inverse", "inverse-alternative"];
 
-export declare type DefaultProps = ComponentDefaultProps<ThumbnailProps, 'variant' | 'src' | 'alt' | 'disabled' | 'hasPadding' | 'backgroundColor' | 'placeholder'>;
+export declare type DefaultProps = ComponentDefaultProps<ThumbnailProps>;
 
 export declare const defaultProps: DefaultProps;
 
@@ -16,6 +16,7 @@ export declare const defaultProps: DefaultProps;
  */
 export declare class PieThumbnail extends LitElement implements ThumbnailProps {
     variant: "default" | "outline";
+    size: number;
     src: string;
     alt: string;
     disabled: boolean;
@@ -23,6 +24,7 @@ export declare class PieThumbnail extends LitElement implements ThumbnailProps {
     backgroundColor: "default" | "subtle" | "strong" | "dark" | "inverse" | "inverse-alternative";
     placeholder: ThumbnailProps['placeholder'];
     private img;
+    private _generateSizeStyles;
     /**
      * Handles image load errors by replacing the src and alt props
      * with the placeholder props.
@@ -43,13 +45,40 @@ declare type PlaceholderProps = {
     alt?: string;
 };
 
+export declare const sizes: readonly number[];
+
 export declare interface ThumbnailProps {
+    /**
+     * What style variant the thumbnail should be such as default or outline.
+     */
     variant?: typeof variants[number];
+    /**
+     * Specify the size as a number between 24 and 128 (inclusive) and a multiple of 8.
+     */
+    size?: typeof sizes[number];
+    /**
+     * The src attribute for the underlying image tag.
+     */
     src?: string;
+    /**
+     * The alt attribute for the underlying image tag.
+     */
     alt?: string;
+    /**
+     * When true, the disabled styles are applied.
+     */
     disabled?: boolean;
+    /**
+     * When true, an extra spacing around the thumbnail container is applied.
+     */
     hasPadding?: boolean;
+    /**
+     * What background color the thumbnail should be.
+     */
     backgroundColor?: typeof backgroundColors[number];
+    /**
+     * What placeholder should be used when the image fails to load.
+     */
     placeholder?: PlaceholderProps;
 }
 

package/dist/index.js

@@ -1,8 +1,8 @@
-import { LitElement as p, html as v, unsafeCSS as f } from "lit";
-import { validPropertyValues as h, defineCustomElement as k } from "@justeattakeaway/pie-webc-core";
-import { classMap as y } from "lit/directives/class-map.js";
-import { property as n, query as C } from "lit/decorators.js";
-const S = [
+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 = [
   "default",
   "outline"
 ], E = [
@@ -19,8 +19,12 @@ const S = [
   dark: "c-thumbnail--backgroundDark",
   inverse: "c-thumbnail--backgroundInverse",
   "inverse-alternative": "c-thumbnail--backgroundInverseAlternative"
-}, e = {
+}, m = 8, g = 24, x = 128, $ = Object.freeze(Array.from(
+  { length: (x - g) / m + 1 },
+  (c, t) => g + t * m
+)), e = {
   variant: "default",
+  size: 48,
   src: "",
   alt: "",
   disabled: !1,
@@ -30,23 +34,31 @@ const S = [
     src: "",
     alt: ""
   }
-}, _ = ".c-thumbnail{--thumbnail-size: var(--dt-spacing-g);--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);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:100%;object-fit:contain;display:block}";
-var P = Object.defineProperty, i = (b, r, a, d) => {
-  for (var o = void 0, l = b.length - 1, c; l >= 0; l--)
-    (c = b[l]) && (o = c(r, a, o) || o);
-  return o && P(r, a, o), o;
+}, 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;
 };
-const s = "pie-thumbnail", u = class u extends p {
+const d = "pie-thumbnail", h = class h extends f {
   constructor() {
-    super(...arguments), this.variant = e.variant, 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 = 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;
+  }
+  _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"), `
+            --thumbnail-size: ${t}px;
+            --thumbnail-border-radius: var(${r});
+        `;
   }
   /**
    * Handles image load errors by replacing the src and alt props
    * with the placeholder props.
    */
   _handleImageError() {
-    var r, a;
-    (r = this.placeholder) != null && r.src && this.setAttribute("src", this.placeholder.src), (a = this.placeholder) != null && a.alt && this.setAttribute("alt", this.placeholder.alt);
+    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);
   }
   /**
    * Detects image load status and applies the placeholder on failure.
@@ -54,8 +66,8 @@ const s = "pie-thumbnail", u = class u extends p {
    */
   _checkImageError() {
     if (this.img) {
-      const { complete: r, naturalHeight: a } = this.img;
-      r && a === 0 && this._handleImageError.call(this);
+      const { complete: t, naturalHeight: r } = this.img;
+      t && r === 0 && this._handleImageError.call(this);
     }
   }
   firstUpdated() {
@@ -63,66 +75,72 @@ const s = "pie-thumbnail", u = class u extends p {
   }
   render() {
     const {
-      variant: r,
-      src: a,
-      alt: d,
-      disabled: o,
+      variant: t,
+      src: r,
+      alt: u,
+      disabled: n,
       hasPadding: l,
-      backgroundColor: c,
-      _handleImageError: m
-    } = this, g = {
+      backgroundColor: s
+    } = this, p = {
       "c-thumbnail": !0,
-      [`c-thumbnail--${r}`]: !0,
-      [I[c]]: !0,
-      "c-thumbnail--disabled": o,
+      [`c-thumbnail--${t}`]: !0,
+      [I[s]]: !0,
+      "c-thumbnail--disabled": n,
       "c-thumbnail--padding": l
-    };
-    return v`
-            <div data-test-id="pie-thumbnail" class="${y(g)}">
+    }, v = this._generateSizeStyles();
+    return y`
+            <div data-test-id="pie-thumbnail"
+             class="${z(p)}"
+             style="${v}">
                 <img
                     data-test-id="pie-thumbnail-img"
-                    src="${a}"
+                    src="${r}"
                     class="c-thumbnail-img"
-                    alt="${d}"
-                    @error="${m}"
+                    alt="${u}"
+                    @error="${this._handleImageError}"
                 />
             </div>
         `;
   }
 };
-u.styles = f(_);
-let t = u;
+h.styles = k(P);
+let a = h;
+i([
+  o({ type: String }),
+  b(d, C, e.variant)
+], a.prototype, "variant");
 i([
-  n({ type: String }),
-  h(s, S, e.variant)
-], t.prototype, "variant");
+  o({ type: Number }),
+  b(d, $, e.size)
+], a.prototype, "size");
 i([
-  n({ type: String })
-], t.prototype, "src");
+  o({ type: String })
+], a.prototype, "src");
 i([
-  n({ type: String })
-], t.prototype, "alt");
+  o({ type: String })
+], a.prototype, "alt");
 i([
-  n({ type: Boolean })
-], t.prototype, "disabled");
+  o({ type: Boolean })
+], a.prototype, "disabled");
 i([
-  n({ type: Boolean })
-], t.prototype, "hasPadding");
+  o({ type: Boolean })
+], a.prototype, "hasPadding");
 i([
-  n({ type: String }),
-  h(s, E, e.backgroundColor)
-], t.prototype, "backgroundColor");
+  o({ type: String }),
+  b(d, E, e.backgroundColor)
+], a.prototype, "backgroundColor");
 i([
-  n({ type: Object })
-], t.prototype, "placeholder");
+  o({ type: Object })
+], a.prototype, "placeholder");
 i([
-  C("img")
-], t.prototype, "img");
-k(s, t);
+  _("img")
+], a.prototype, "img");
+S(d, a);
 export {
-  t as PieThumbnail,
+  a as PieThumbnail,
   I as backgroundColorClassNames,
   E as backgroundColors,
   e as defaultProps,
-  S as variants
+  $ as sizes,
+  C as variants
 };

package/dist/react.d.ts

@@ -8,7 +8,7 @@ export declare const backgroundColorClassNames: Record<typeof backgroundColors[n
 
 export declare const backgroundColors: readonly ["default", "subtle", "strong", "dark", "inverse", "inverse-alternative"];
 
-export declare type DefaultProps = ComponentDefaultProps<ThumbnailProps, 'variant' | 'src' | 'alt' | 'disabled' | 'hasPadding' | 'backgroundColor' | 'placeholder'>;
+export declare type DefaultProps = ComponentDefaultProps<ThumbnailProps>;
 
 export declare const defaultProps: DefaultProps;
 
@@ -19,6 +19,7 @@ export declare const PieThumbnail: React_2.ForwardRefExoticComponent<ThumbnailPr
  */
 declare class PieThumbnail_2 extends LitElement implements ThumbnailProps {
     variant: "default" | "outline";
+    size: number;
     src: string;
     alt: string;
     disabled: boolean;
@@ -26,6 +27,7 @@ declare class PieThumbnail_2 extends LitElement implements ThumbnailProps {
     backgroundColor: "default" | "subtle" | "strong" | "dark" | "inverse" | "inverse-alternative";
     placeholder: ThumbnailProps['placeholder'];
     private img;
+    private _generateSizeStyles;
     /**
      * Handles image load errors by replacing the src and alt props
      * with the placeholder props.
@@ -48,13 +50,40 @@ declare type PlaceholderProps = {
 
 declare type ReactBaseType = React_2.HTMLAttributes<HTMLElement>;
 
+export declare const sizes: readonly number[];
+
 export declare interface ThumbnailProps {
+    /**
+     * What style variant the thumbnail should be such as default or outline.
+     */
     variant?: typeof variants[number];
+    /**
+     * Specify the size as a number between 24 and 128 (inclusive) and a multiple of 8.
+     */
+    size?: typeof sizes[number];
+    /**
+     * The src attribute for the underlying image tag.
+     */
     src?: string;
+    /**
+     * The alt attribute for the underlying image tag.
+     */
     alt?: string;
+    /**
+     * When true, the disabled styles are applied.
+     */
     disabled?: boolean;
+    /**
+     * When true, an extra spacing around the thumbnail container is applied.
+     */
     hasPadding?: boolean;
+    /**
+     * What background color the thumbnail should be.
+     */
     backgroundColor?: typeof backgroundColors[number];
+    /**
+     * What placeholder should be used when the image fails to load.
+     */
     placeholder?: PlaceholderProps;
 }
 

package/dist/react.js

@@ -1,18 +1,19 @@
 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, variants as b } from "./index.js";
-const m = e({
+import { backgroundColorClassNames as l, backgroundColors as p, defaultProps as u, sizes as b, variants as c } from "./index.js";
+const i = e({
   displayName: "PieThumbnail",
   elementClass: o,
   react: a,
   tagName: "pie-thumbnail",
   events: {}
-}), r = m;
+}), r = i;
 export {
   r as PieThumbnail,
   l as backgroundColorClassNames,
   p as backgroundColors,
   u as defaultProps,
-  b as variants
+  b as sizes,
+  c as variants
 };

package/package.json

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

package/src/defs.ts

@@ -17,25 +17,60 @@ export const backgroundColorClassNames: Record<typeof backgroundColors[number],
     'inverse-alternative': 'c-thumbnail--backgroundInverseAlternative',
 };
 
+const SIZE_INCREMENT_BY = 8;
+const SIZE_MIN = 24;
+const SIZE_MAX = 128;
+
+export const sizes = Object.freeze(Array.from(
+    { length: (SIZE_MAX - SIZE_MIN) / SIZE_INCREMENT_BY + 1 },
+    (_, i) => SIZE_MIN + i * SIZE_INCREMENT_BY,
+)) as readonly number[];
+
 type PlaceholderProps = {
     src?: string;
     alt?: string;
 }
 
 export interface ThumbnailProps {
+    /**
+     * What style variant the thumbnail should be such as default or outline.
+     */
     variant?: typeof variants[number];
+    /**
+     * Specify the size as a number between 24 and 128 (inclusive) and a multiple of 8.
+     */
+    size?: typeof sizes[number];
+    /**
+     * The src attribute for the underlying image tag.
+     */
     src?: string;
+    /**
+     * The alt attribute for the underlying image tag.
+     */
     alt?: string;
+    /**
+     * When true, the disabled styles are applied.
+     */
     disabled?: boolean;
+    /**
+     * When true, an extra spacing around the thumbnail container is applied.
+     */
     hasPadding?: boolean;
+    /**
+     * What background color the thumbnail should be.
+     */
     backgroundColor?: typeof backgroundColors[number];
+    /**
+     * What placeholder should be used when the image fails to load.
+     */
     placeholder?: PlaceholderProps;
 }
 
-export type DefaultProps = ComponentDefaultProps<ThumbnailProps, 'variant' | 'src' | 'alt' | 'disabled' | 'hasPadding' | 'backgroundColor' | 'placeholder'>;
+export type DefaultProps = ComponentDefaultProps<ThumbnailProps>;
 
 export const defaultProps: DefaultProps = {
     variant: 'default',
+    size: 48,
     src: '',
     alt: '',
     disabled: false,

package/src/index.ts

@@ -12,6 +12,7 @@ import {
     variants,
     backgroundColors,
     backgroundColorClassNames,
+    sizes,
 } from './defs';
 import styles from './thumbnail.scss?inline';
 
@@ -28,6 +29,10 @@ export class PieThumbnail extends LitElement implements ThumbnailProps {
     @validPropertyValues(componentSelector, variants, defaultProps.variant)
     public variant = defaultProps.variant;
 
+    @property({ type: Number })
+    @validPropertyValues(componentSelector, sizes, defaultProps.size)
+    public size = defaultProps.size;
+
     @property({ type: String })
     public src = defaultProps.src;
 
@@ -50,6 +55,21 @@ export class PieThumbnail extends LitElement implements ThumbnailProps {
     @query('img')
     private img!: HTMLImageElement;
 
+    private _generateSizeStyles (): string {
+        const { size } = this;
+        let borderRadius = '--dt-radius-rounded-c';
+        if (size <= 40) {
+            borderRadius = '--dt-radius-rounded-a';
+        } else if (size <= 56) {
+            borderRadius = '--dt-radius-rounded-b';
+        }
+
+        return `
+            --thumbnail-size: ${size}px;
+            --thumbnail-border-radius: var(${borderRadius});
+        `;
+    }
+
     /**
      * Handles image load errors by replacing the src and alt props
      * with the placeholder props.
@@ -83,7 +103,6 @@ export class PieThumbnail extends LitElement implements ThumbnailProps {
             disabled,
             hasPadding,
             backgroundColor,
-            _handleImageError,
         } = this;
 
         const wrapperClasses = {
@@ -94,14 +113,18 @@ export class PieThumbnail extends LitElement implements ThumbnailProps {
             'c-thumbnail--padding': hasPadding,
         };
 
+        const sizeStyles = this._generateSizeStyles();
+
         return html`
-            <div data-test-id="pie-thumbnail" class="${classMap(wrapperClasses)}">
+            <div data-test-id="pie-thumbnail"
+             class="${classMap(wrapperClasses)}"
+             style="${sizeStyles}">
                 <img
                     data-test-id="pie-thumbnail-img"
                     src="${src}"
                     class="c-thumbnail-img"
                     alt="${alt}"
-                    @error="${_handleImageError}"
+                    @error="${this._handleImageError}"
                 />
             </div>
         `;

package/src/thumbnail.scss

@@ -1,10 +1,13 @@
 .c-thumbnail {
-  --thumbnail-size: var(--dt-spacing-g);
+  --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);
@@ -47,8 +50,6 @@
 
   .c-thumbnail-img {
     width: 100%;
-    height: 100%;
-    object-fit: contain;
-    display: block;
+    height: auto;
   }
 }