@justeattakeaway/pie-divider 0.13.8 → 0.14.0

package/custom-elements.json

@@ -34,7 +34,7 @@
           "type": {
             "text": "DefaultProps"
           },
-          "default": "{\n    variant: 'default',\n    orientation: 'horizontal',\n}"
+          "default": "{\n    variant: 'default',\n    orientation: 'horizontal',\n    label: '',\n}"
         }
       ],
       "exports": [
@@ -76,36 +76,34 @@
             {
               "kind": "field",
               "name": "variant",
-              "type": {
-                "text": "DividerProps['variant']"
-              },
               "privacy": "public",
               "attribute": "variant"
             },
             {
               "kind": "field",
               "name": "orientation",
-              "type": {
-                "text": "DividerProps['orientation']"
-              },
               "privacy": "public",
               "attribute": "orientation"
+            },
+            {
+              "kind": "field",
+              "name": "label",
+              "privacy": "public",
+              "attribute": "label"
             }
           ],
           "attributes": [
             {
               "name": "variant",
-              "type": {
-                "text": "DividerProps['variant']"
-              },
               "fieldName": "variant"
             },
             {
               "name": "orientation",
-              "type": {
-                "text": "DividerProps['orientation']"
-              },
               "fieldName": "orientation"
+            },
+            {
+              "name": "label",
+              "fieldName": "label"
             }
           ],
           "superclass": {

package/dist/index.d.ts

@@ -16,6 +16,10 @@ export declare interface DividerProps {
      * What orientation the divider should be such as horizontal or vertical.
      */
     orientation?: typeof orientations[number];
+    /**
+     * The label text for the divider.
+     */
+    label?: string;
 }
 
 export declare const orientations: readonly ["horizontal", "vertical"];
@@ -24,8 +28,9 @@ export declare const orientations: readonly ["horizontal", "vertical"];
  * @tagname pie-divider
  */
 export declare class PieDivider extends LitElement implements DividerProps {
-    variant: DividerProps['variant'];
-    orientation: DividerProps['orientation'];
+    variant: "default" | "inverse";
+    orientation: "horizontal" | "vertical";
+    label: string;
     render(): TemplateResult<1>;
     static styles: CSSResult;
 }

package/dist/index.js

@@ -1,46 +1,64 @@
-import { unsafeCSS as h, LitElement as f, html as u } from "lit";
-import { property as c } from "lit/decorators.js";
-import { validPropertyValues as l, defineCustomElement as g } from "@justeattakeaway/pie-webc-core";
-const m = `*,*:after,*:before{box-sizing:inherit}.c-divider{--divider-bg-color: var(--dt-color-divider-default);--divider-width: 100%;--divider-height: 1px;margin:0;border:0;width:var(--divider-width);height:var(--divider-height);background-color:var(--divider-bg-color)}.c-divider[variant=inverse]{--divider-bg-color: var(--dt-color-divider-inverse)}.c-divider[orientation=vertical]{--divider-width: 1px;--divider-height: 100%}
-`, b = ["default", "inverse"], y = ["horizontal", "vertical"], o = {
+import { unsafeCSS as g, LitElement as m, html as c } from "lit";
+import { property as s } from "lit/decorators.js";
+import { classMap as p } from "lit/directives/class-map.js";
+import { validPropertyValues as b, defineCustomElement as f } from "@justeattakeaway/pie-webc-core";
+const u = `*,*:after,*:before{box-sizing:inherit}.c-divider{--divider-bg-color: var(--dt-color-divider-default);--divider-width: 100%;--divider-min-width: 16px;--divider-height: 1px;--divider-label-max-width: 90%;width:var(--divider-width)}.c-divider,.c-divider hr{margin:0;border:0;background-color:var(--divider-bg-color)}.c-divider:not(.c-divider--labelled){height:var(--divider-height)}.c-divider.c-divider--labelled{display:flex;align-items:center;text-align:center;gap:var(--dt-spacing-b);background-color:transparent}.c-divider.c-divider--labelled .c-divider-label{max-width:var(--divider-label-max-width);word-wrap:break-word}.c-divider.c-divider--labelled hr{flex-grow:1;height:var(--divider-height);min-width:var(--divider-min-width)}.c-divider.c-divider--labelled.c-divider--inverse{color:var(--dt-color-content-inverse)}.c-divider.c-divider--inverse{--divider-bg-color: var(--dt-color-divider-inverse)}.c-divider.c-divider--vertical{--divider-width: 1px;--divider-height: 100%}
+`, w = ["default", "inverse"], x = ["horizontal", "vertical"], l = {
   variant: "default",
-  orientation: "horizontal"
+  orientation: "horizontal",
+  label: ""
 };
-var P = Object.defineProperty, w = Object.getOwnPropertyDescriptor, p = (a, r, t, e) => {
-  for (var i = e > 1 ? void 0 : e ? w(r, t) : r, d = a.length - 1, v; d >= 0; d--)
-    (v = a[d]) && (i = (e ? v(r, t, i) : v(i)) || i);
-  return e && i && P(r, t, i), i;
+var y = Object.defineProperty, $ = Object.getOwnPropertyDescriptor, h = (n, d, t, r) => {
+  for (var i = r > 1 ? void 0 : r ? $(d, t) : d, a = n.length - 1, v; a >= 0; a--)
+    (v = n[a]) && (i = (r ? v(d, t, i) : v(i)) || i);
+  return r && i && y(d, t, i), i;
 };
-const s = "pie-divider";
-class n extends f {
+const e = "pie-divider";
+class o extends m {
   constructor() {
-    super(...arguments), this.variant = o.variant, this.orientation = o.orientation;
+    super(...arguments), this.variant = l.variant, this.orientation = l.orientation, this.label = l.label;
   }
   render() {
-    const { variant: r, orientation: t } = this;
-    return u`
-            <hr
-                data-test-id="pie-divider"
-                aria-hidden="true"
-                class="c-divider"
-                variant=${r}
-                orientation=${t}
-            />`;
+    const { variant: d, orientation: t, label: r } = this, i = r.length > 0 && t === "horizontal", a = {
+      "c-divider": !0,
+      "c-divider--inverse": d === "inverse",
+      "c-divider--vertical": t === "vertical",
+      "c-divider--labelled": i
+    };
+    return c`
+            ${i ? c`
+                <div
+                    id="${e}"
+                    data-test-id="${e}"
+                    class="${p(a)}"
+                    aria-labelledby="${e}-label">
+                        <hr aria-hidden="true"/>
+                        <span id="${e}-label" class="c-divider-label">${r}</span>
+                        <hr aria-hidden="true"/>
+                </div>` : c`
+                <hr id="${e}"
+                    data-test-id="${e}"
+                    class="${p(a)}"
+                    aria-hidden="true"
+                />`}`;
   }
 }
-n.styles = h(m);
-p([
-  c({ type: String }),
-  l(s, b, o.variant)
-], n.prototype, "variant", 2);
-p([
-  c({ type: String }),
-  l(s, y, o.orientation)
-], n.prototype, "orientation", 2);
-g(s, n);
+o.styles = g(u);
+h([
+  s({ type: String }),
+  b(e, w, l.variant)
+], o.prototype, "variant", 2);
+h([
+  s({ type: String }),
+  b(e, x, l.orientation)
+], o.prototype, "orientation", 2);
+h([
+  s({ type: String })
+], o.prototype, "label", 2);
+f(e, o);
 export {
-  n as PieDivider,
-  o as defaultProps,
-  y as orientations,
-  b as variants
+  o as PieDivider,
+  l as defaultProps,
+  x as orientations,
+  w as variants
 };

package/dist/react.d.ts

@@ -17,6 +17,10 @@ export declare interface DividerProps {
      * What orientation the divider should be such as horizontal or vertical.
      */
     orientation?: typeof orientations[number];
+    /**
+     * The label text for the divider.
+     */
+    label?: string;
 }
 
 export declare const orientations: readonly ["horizontal", "vertical"];
@@ -27,8 +31,9 @@ export declare const PieDivider: React_2.ForwardRefExoticComponent<DividerProps
  * @tagname pie-divider
  */
 declare class PieDivider_2 extends LitElement implements DividerProps {
-    variant: DividerProps['variant'];
-    orientation: DividerProps['orientation'];
+    variant: "default" | "inverse";
+    orientation: "horizontal" | "vertical";
+    label: string;
     render(): TemplateResult<1>;
     static styles: CSSResult;
 }

package/dist/react.js

@@ -1,9 +1,10 @@
 import * as e from "react";
 import { createComponent as i } from "@lit/react";
 import { PieDivider as r } from "./index.js";
-import { defaultProps as c, orientations as P, variants as f } from "./index.js";
+import { defaultProps as P, orientations as f, variants as D } from "./index.js";
 import "lit";
 import "lit/decorators.js";
+import "lit/directives/class-map.js";
 import "@justeattakeaway/pie-webc-core";
 const t = i({
   displayName: "PieDivider",
@@ -11,10 +12,10 @@ const t = i({
   react: e,
   tagName: "pie-divider",
   events: {}
-}), d = t;
+}), n = t;
 export {
-  d as PieDivider,
-  c as defaultProps,
-  P as orientations,
-  f as variants
+  n as PieDivider,
+  P as defaultProps,
+  f as orientations,
+  D as variants
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@justeattakeaway/pie-divider",
   "description": "PIE Design System Divider built using Web Components",
-  "version": "0.13.8",
+  "version": "0.14.0",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -36,7 +36,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@custom-elements-manifest/analyzer": "0.9.0",
-    "@justeattakeaway/pie-components-config": "0.17.0",
+    "@justeattakeaway/pie-components-config": "0.18.0",
     "@justeattakeaway/pie-css": "0.12.1",
     "@justeattakeaway/pie-wrapper-react": "0.14.1",
     "cem-plugin-module-file-extensions": "0.0.5"

package/src/defs-react.ts

@@ -1,3 +1,3 @@
-import React from 'react';
+import type React from 'react';
 
 export type ReactBaseType = React.HTMLAttributes<HTMLHRElement>

package/src/defs.ts

@@ -12,6 +12,10 @@ export interface DividerProps {
      * What orientation the divider should be such as horizontal or vertical.
      */
    orientation?: typeof orientations[number];
+    /**
+     * The label text for the divider.
+     */
+    label?: string;
 }
 
 export type DefaultProps = ComponentDefaultProps<DividerProps>;
@@ -19,4 +23,5 @@ export type DefaultProps = ComponentDefaultProps<DividerProps>;
 export const defaultProps: DefaultProps = {
     variant: 'default',
     orientation: 'horizontal',
+    label: '',
 };

package/src/divider.scss

@@ -1,30 +1,54 @@
 @use '@justeattakeaway/pie-css/scss' as p;
 
 .c-divider {
-    --divider-bg-color: var(--dt-color-divider-default);
-    --divider-width: 100%;
-    --divider-height: 1px;
+  --divider-bg-color: var(--dt-color-divider-default);
+  --divider-width: 100%;
+  --divider-min-width: 16px;
+  --divider-height: 1px;
+  --divider-label-max-width: 90%;
 
+  width: var(--divider-width);
+
+  &,
+  hr {
     margin: 0;
     border: 0;
-    width: var(--divider-width);
-    height: var(--divider-height);
     background-color: var(--divider-bg-color);
+  }
 
-    &[variant='default'] {
-        /* Same as default styles */
-    }
+  &:not(.c-divider--labelled) {
+    height: var(--divider-height);
+  }
 
-    &[variant='inverse'] {
-        --divider-bg-color: var(--dt-color-divider-inverse);
+  &.c-divider--labelled {
+    display: flex;
+    align-items: center;
+    text-align: center;
+    gap: var(--dt-spacing-b);
+    background-color: transparent;
+
+    .c-divider-label {
+      max-width: var(--divider-label-max-width);
+      word-wrap: break-word;
     }
 
-    &[orientation='horizontal'] {
-        /* Same as default styles */
+    hr {
+      flex-grow: 1;
+      height: var(--divider-height);
+      min-width: var(--divider-min-width);
     }
 
-    &[orientation='vertical'] {
-        --divider-width: 1px;
-        --divider-height: 100%;
+    &.c-divider--inverse {
+      color: var(--dt-color-content-inverse);
     }
+  }
+
+  &.c-divider--inverse {
+    --divider-bg-color: var(--dt-color-divider-inverse);
+  }
+
+  &.c-divider--vertical {
+    --divider-width: 1px;
+    --divider-height: 100%;
+  }
 }

package/src/index.ts

@@ -1,9 +1,12 @@
-import { LitElement, html, unsafeCSS } from 'lit';
+import {
+    html, LitElement, unsafeCSS,
+} from 'lit';
 import { property } from 'lit/decorators.js';
-import { validPropertyValues, defineCustomElement } from '@justeattakeaway/pie-webc-core';
+import { classMap } from 'lit/directives/class-map.js';
+import { defineCustomElement, validPropertyValues } from '@justeattakeaway/pie-webc-core';
 import styles from './divider.scss?inline';
 import {
-    DividerProps, variants, orientations, defaultProps,
+    type DividerProps, defaultProps, orientations, variants,
 } from './defs';
 
 // Valid values available to consumers
@@ -17,23 +20,44 @@ const componentSelector = 'pie-divider';
 export class PieDivider extends LitElement implements DividerProps {
     @property({ type: String })
     @validPropertyValues(componentSelector, variants, defaultProps.variant)
-    public variant: DividerProps['variant'] = defaultProps.variant;
+    public variant = defaultProps.variant;
 
     @property({ type: String })
     @validPropertyValues(componentSelector, orientations, defaultProps.orientation)
-    public orientation : DividerProps['orientation'] = defaultProps.orientation;
+    public orientation = defaultProps.orientation;
+
+    @property({ type: String })
+    public label = defaultProps.label;
 
     render () {
-        const { variant, orientation } = this;
+        const { variant, orientation, label } = this;
+
+        const showLabel = label.length > 0 && orientation === 'horizontal';
+        const classes = {
+            'c-divider': true,
+            'c-divider--inverse': variant === 'inverse',
+            'c-divider--vertical': orientation === 'vertical',
+            'c-divider--labelled': showLabel,
+        };
 
         return html`
-            <hr
-                data-test-id="pie-divider"
-                aria-hidden="true"
-                class="c-divider"
-                variant=${variant}
-                orientation=${orientation}
-            />`;
+            ${showLabel ? html`
+                <div
+                    id="${componentSelector}"
+                    data-test-id="${componentSelector}"
+                    class="${classMap(classes)}"
+                    aria-labelledby="${componentSelector}-label">
+                        <hr aria-hidden="true"/>
+                        <span id="${componentSelector}-label" class="c-divider-label">${label}</span>
+                        <hr aria-hidden="true"/>
+                </div>`
+            : html`
+                <hr id="${componentSelector}"
+                    data-test-id="${componentSelector}"
+                    class="${classMap(classes)}"
+                    aria-hidden="true"
+                />`
+            }`;
     }
 
     // Renders a `CSSResult` generated from SCSS by Vite