@salesforcedevs/dx-components 0.26.1-alpha0.4 → 0.26.2

package/src/modules/dx/typeBadge/typeBadge.stories.ts

@@ -0,0 +1,114 @@
+import { html } from "lit-html";
+import { TypeBadgeColor, TypeBadgeSize, BadgeType } from "typings/custom";
+
+const BADGE_COLOR_OPTIONS: Array<TypeBadgeColor> = [
+    "default",
+    "hot-orange",
+    "orange",
+    "yellow",
+    "green",
+    "teal",
+    "cloud-blue",
+    "blue",
+    "indigo",
+    "purple",
+    "violet",
+    "pink",
+    "red",
+    "analytics",
+    "employees",
+    "marketing",
+    "partners",
+    "commerce",
+    "sales",
+    "success",
+    "integration",
+    "platform",
+    "industries",
+    "learning",
+    "service"
+];
+const SIZE_OPTIONS: Array<TypeBadgeSize> = ["default", "small"];
+const BADGE_TYPE_OPTIONS: Array<BadgeType> = ["metadata", "content-type"];
+
+export default {
+    title: "dx/dx-type-badge",
+    component: "dx-type-badge",
+    argTypes: {
+        color: {
+            control: {
+                type: "select"
+            },
+            options: BADGE_COLOR_OPTIONS
+        },
+        type: {
+            control: {
+                type: "select"
+            },
+            options: BADGE_TYPE_OPTIONS
+        },
+        size: {
+            control: {
+                type: "select"
+            },
+            options: SIZE_OPTIONS
+        },
+        value: {
+            control: {
+                type: "text"
+            }
+        }
+    }
+};
+
+export const Base = (args: any) => html`
+    <dx-type-badge
+        value="${args.value}"
+        color="${args.color}"
+        size="${args.size}"
+        type="${args.type}"
+    ></dx-type-badge>
+`;
+Base.args = {
+    color: BADGE_COLOR_OPTIONS[0],
+    type: BADGE_TYPE_OPTIONS[0],
+    size: SIZE_OPTIONS[0],
+    value: "Developer Experience"
+};
+
+export const CSSHooked = () => html`
+    <style>
+        .hooks {
+            --dx-c-type-badge-color: var(--dx-g-green-vibrant-40);
+            --dx-c-type-badge-background: var(--dx-g-green-vibrant-90);
+            --dx-c-type-badge-border-radius: var(--dx-g-spacing-xl);
+            --dx-c-type-badge-height: var(--dx-g-spacing-xl);
+        }
+        .hookinfo {
+            color: gray;
+            font-size: 12px;
+        }
+    </style>
+
+    <p class="hookinfo">
+        <b>--dx-c-type-badge-color:</b> <i>var(--dx-g-green-vibrant-40);</i>
+    </p>
+    <p class="hookinfo">
+        <b>--dx-c-type-badge-background:</b>
+        <i>var(--dx-g-green-vibrant-90);</i>
+    </p>
+    <p class="hookinfo">
+        <b>--dx-c-type-badge-border-radius:</b>
+        <i>var(--dx-g-spacing-xl);</i>
+    </p>
+    <p class="hookinfo">
+        <b>--dx-c-type-badge-height:</b>
+        <i>var(--dx-g-spacing-xl);</i>
+    </p>
+    <br />
+
+    <dx-type-badge
+        class="hooks"
+        value="Hey I am a very loooong text"
+    ></dx-type-badge>
+`;

package/src/modules/dx/typeBadge/typeBadge.ts

@@ -0,0 +1,65 @@
+import { LightningElement, api } from "lwc";
+import cx from "classnames";
+import {
+    TypeBadgeColor,
+    Color,
+    TypeBadgeSize,
+    BadgeType,
+    Brand
+} from "typings/custom";
+import { colorToDxColors } from "utils-internal/css";
+
+const DEFAULT_TYPE = "typebadge_metadata";
+const VALID_BRANDS: Array<Brand> = [
+    "employees",
+    "marketing",
+    "partners",
+    "commerce",
+    "sales",
+    "success",
+    "integration",
+    "platform",
+    "industries",
+    "learning",
+    "service",
+    "analytics"
+];
+
+export default class TypeBadge extends LightningElement {
+    @api size: TypeBadgeSize = "default";
+    @api value: string = "";
+    @api color?: TypeBadgeColor = "default";
+    @api type?: BadgeType = "metadata";
+
+    private get className(): string {
+        return cx(
+            "typebadge",
+            `size-${this.size}`,
+            (this.type && `typebadge_${this.type}`) || DEFAULT_TYPE
+        );
+    }
+
+    private get style(): string {
+        if (VALID_BRANDS.includes(this.color as Brand)) {
+            return this.buildStyleString({
+                background: `--dx-g-brand-${this.color}-color-background`,
+                color: `--dx-g-brand-${this.color}-color`
+            });
+        }
+        const variables = colorToDxColors(this.color as Color);
+        if (variables) {
+            return this.buildStyleString(variables);
+        }
+        return "";
+    }
+
+    private buildStyleString({
+        background,
+        color
+    }: {
+        background: string;
+        color: string;
+    }): string {
+        return `--color: var(${color}); --background: var(${background})`;
+    }
+}

package/src/modules/dx/typeBadgeGroup/__tests__/mockProps.ts

@@ -0,0 +1,11 @@
+export const badges = [
+    "Developer Experience",
+    "Search Optimization",
+    "Analytics",
+    "Testing",
+    "Traffic Monitoring"
+];
+
+export default {
+    badges: JSON.stringify(badges)
+};

package/src/modules/dx/typeBadgeGroup/__tests__/typeBadgeGroup.test.ts

@@ -0,0 +1,72 @@
+import TypeBadge from "dx/typeBadge";
+import TypeBadgeGroup from "dx/typeBadgeGroup";
+import { TypeBadgeSize } from "typings/custom";
+import { createRenderComponent } from "utils-internal/tests";
+import mockProps, { badges } from "./mockProps";
+
+const TAG = "dx-type-badge-group";
+const render = createRenderComponent(TAG, TypeBadgeGroup);
+
+describe(TAG, () => {
+    it("renders correct number of badges", () => {
+        const expectedSize: TypeBadgeSize = "medium";
+        const element = render(mockProps);
+
+        const els: Array<TypeBadge> =
+            element.shadowRoot.querySelectorAll("dx-type-badge");
+        expect(els).toHaveLength(badges.length);
+        els.forEach((el, index) => {
+            expect(el.value).toBe(badges[index]);
+            expect(el.size).toBe(expectedSize);
+        });
+
+        return expect(element).toBeAccessible();
+    });
+
+    it("can render a comma delimited string", () => {
+        const expectedSize: TypeBadgeSize = "small";
+        const element = render({
+            badges: "test1,test2,test3",
+            size: expectedSize
+        });
+
+        const els: Array<TypeBadge> =
+            element.shadowRoot.querySelectorAll("dx-type-badge");
+        expect(els).toHaveLength(3);
+        els.forEach((el) => expect(el.size).toBe(expectedSize));
+        expect(els[0].value).toBe("test1");
+        expect(els[1].value).toBe("test2");
+        expect(els[2].value).toBe("test3");
+
+        return expect(element).toBeAccessible();
+    });
+
+    it("can render single string value", () => {
+        const expectedBadge = "testsinglebadge";
+        const element = render({ badges: expectedBadge });
+
+        const els: Array<TypeBadge> =
+            element.shadowRoot.querySelectorAll("dx-type-badge");
+        expect(els).toHaveLength(1);
+        expect(els[0].value).toBe(expectedBadge);
+
+        return expect(element).toBeAccessible();
+    });
+
+    it("can render a regular array of string", () => {
+        const element = render({ badges });
+
+        const els: Array<TypeBadge> =
+            element.shadowRoot.querySelectorAll("dx-type-badge");
+        expect(els).toHaveLength(badges.length);
+        els.forEach((el, index) => expect(el.value).toBe(badges[index]));
+
+        return expect(element).toBeAccessible();
+    });
+
+    it("throws an error if badges value is not compatible", () => {
+        expect(() => render({ badges: { test: "badges" } })).toThrow(
+            /Key must be a string or number/
+        );
+    });
+});

package/src/modules/dx/typeBadgeGroup/typeBadgeGroup.css

@@ -0,0 +1,12 @@
+.badges-group {
+    display: flex;
+    flex-wrap: wrap;
+}
+
+.badges-group > dx-type-badge {
+    margin-bottom: var(--dx-g-spacing-sm);
+}
+
+.badges-group > dx-type-badge:not(:last-child) {
+    margin-right: var(--dx-g-spacing-sm);
+}

package/src/modules/dx/typeBadgeGroup/typeBadgeGroup.html

@@ -0,0 +1,11 @@
+<template>
+    <div class="badges-group">
+        <template for:each={badges} for:item="badge">
+            <dx-type-badge
+                key={badge}
+                size={size}
+                value={badge}
+            ></dx-type-badge>
+        </template>
+    </div>
+</template>

package/src/modules/dx/typeBadgeGroup/typeBadgeGroup.stories.ts

@@ -0,0 +1,19 @@
+import { html } from "lit-html";
+
+export default {
+    title: "dx/dx-type-badge-group",
+    component: "dx-type-badge-group"
+};
+
+export const Base = () => html`
+    <dx-type-badge-group
+        badges="Developer Experience, Search Optimization, Analytics"
+    ></dx-type-badge-group>
+`;
+
+export const Small = () => html`
+    <dx-type-badge-group
+        badges='["Testing", "Traffic Monitoring"]'
+        size="small"
+    ></dx-type-badge-group>
+`;

package/src/modules/dx/typeBadgeGroup/typeBadgeGroup.ts

@@ -0,0 +1,18 @@
+import { LightningElement, api } from "lwc";
+import { normalizeToArray } from "utils/normalizers";
+import { TypeBadgeSize } from "typings/custom";
+
+export default class TypeBadgeGroup extends LightningElement {
+    @api size: TypeBadgeSize = "medium";
+
+    @api
+    get badges() {
+        return this._badges;
+    }
+    set badges(value: string[] | string | null) {
+        this._badges = normalizeToArray(value);
+    }
+
+    // can be an array of strings or a comma delimited string
+    private _badges!: string | string[] | null;
+}

package/src/modules/helpers/animations/animations.css

@@ -0,0 +1,15 @@
+@keyframes fadeIn {
+    0% {
+        opacity: 0;
+        transform: translateY(var(--dx-g-spacing-sm));
+    }
+
+    100% {
+        opacity: 1;
+        transform: translateY(0);
+    }
+}
+
+:host {
+    --dx-g-animation-fadein: fadein 0.2s linear forwards;
+}

package/src/modules/helpers/button/button.css

@@ -0,0 +1,4 @@
+:host {
+    --dx-g-button-heading-color-hover: var(--dx-g-blue-vibrant-40);
+    --dx-g-button-image-filter-hover: brightness(90%);
+}

package/src/modules/helpers/card/card.css

@@ -0,0 +1,258 @@
+@import "helpers/button";
+
+/* main card base */
+
+:host {
+    display: block;
+
+    --dx-g-card-border: 1px solid var(--dx-g-gray-90);
+    --dx-g-card-border-radius: 16px;
+    --dx-g-card-item-spacing: 12px;
+    --dx-g-card-img-spacing: 20px;
+    --dx-c-body-max-lines: 6;
+}
+
+.dx-card-base {
+    height: 100%;
+}
+
+.dx-card-base:not(.dx-card-base_borderless) {
+    --dx-g-card-padding: 20px;
+
+    background: white;
+    transition: var(--dx-g-transition-box-shadow-2x);
+    box-shadow: var(--dx-g-box-shadow-sm);
+    border-radius: var(--dx-g-card-border-radius);
+    overflow: hidden;
+}
+
+.dx-card-base:not(.dx-card-base_borderless):hover {
+    box-shadow: var(--dx-g-box-shadow-lg);
+}
+
+.dx-card-base_borderless {
+    --dx-g-card-padding: 0;
+}
+
+.dx-card-base_override-width {
+    width: 100% !important;
+}
+
+.dx-card-base:not(.dx-card-base_borderless):active {
+    box-shadow: var(--dx-g-box-shadow-md);
+}
+
+.dx-card-base_layout-horizontal {
+    flex-direction: row;
+}
+
+/* card sections with responsive padding */
+
+/* vertical sections */
+.dx-card-base_section-vertical {
+    padding: 0 var(--dx-g-card-padding) var(--dx-g-card-img-spacing)
+        var(--dx-g-card-padding);
+}
+
+.dx-card-base_section-vertical:first-of-type {
+    padding-top: var(--dx-g-card-padding);
+}
+
+.dx-card-base > .dx-card-base_section-vertical {
+    width: 100%;
+}
+
+.dx-card-base_section-vertical:last-of-type {
+    padding-bottom: var(--dx-g-card-padding);
+}
+
+/* horizontal sections */
+.dx-card-base_section-horizontal {
+    padding: var(--dx-g-card-padding) var(--dx-g-card-img-spacing)
+        var(--dx-g-card-padding) 0;
+}
+
+.dx-card-base_section-horizontal:first-of-type {
+    padding-left: var(--dx-g-card-padding);
+}
+
+.dx-card-base_section-horizontal:last-of-type {
+    padding-right: var(--dx-g-card-padding);
+}
+
+.dx-card-base > .dx-card-base_section-horizontal {
+    height: 100%;
+}
+
+/* flex containers with responsive spacing */
+
+.dx-card-base_column {
+    display: flex;
+    flex-direction: column;
+    align-items: flex-start;
+}
+
+.dx-card-base_column > *:not(:last-child) {
+    margin-bottom: var(--dx-g-card-item-spacing);
+}
+
+/* card ctas */
+
+.dx-card-base_ctas {
+    /* this is a hack since we can't target the ::slotted ctas */
+    display: grid;
+    grid-gap: var(--dx-g-spacing-xs) var(--dx-g-spacing-xl);
+    grid-template-columns: repeat(
+        auto-fill,
+        minmax(min-content, var(--dx-c-card-grid-max-width, 50px))
+    );
+}
+
+/* card image */
+
+.dx-card-base_image {
+    grid-area: image;
+    object-fit: cover;
+    transition: var(--dx-g-transition-filter-2x),
+        var(--dx-g-transition-box-shadow-2x);
+}
+
+.dx-card-base_borderless-image {
+    position: absolute;
+    top: 0;
+    right: 0;
+    width: 100%;
+    height: 100%;
+}
+
+.dx-card-base_borderless-image_link {
+    position: relative;
+    margin-bottom: var(--dx-g-card-img-spacing);
+    height: 0;
+    padding-top: 50%;
+    border-radius: var(--dx-g-card-border-radius);
+    box-shadow: var(--dx-g-box-shadow-sm);
+    transition: var(--dx-g-transition-box-shadow-2x);
+    overflow: hidden;
+}
+
+.dx-card-base_borderless-image_link img {
+    border-radius: inherit;
+}
+
+/* Card play button */
+
+.dx-play-button {
+    --dx-c-icon-badge-box-shadow: var(--dx-g-box-shadow-sm);
+    --dx-c-icon-badge-color: var(--dx-g-blue-vibrant-50);
+    --dx-c-icon-badge-icon-transform: translateX(2px);
+    --dx-c-icon-badge-transition: var(--dx-g-transition-box-shadow-2x),
+        var(--dx-g-transition-hue-1x);
+}
+
+/* card link hovering */
+.dx-card-base_link-hovered .dx-card-base_image,
+a.dx-card-base:hover .dx-card-base_image {
+    filter: var(--dx-g-button-image-filter-hover);
+}
+
+.dx-card-base_link-hovered a .dx-play-button,
+a.dx-card-base:hover a .dx-play-button {
+    --dx-c-icon-badge-color: var(--dx-g-blue-vibrant-40);
+    --dx-c-icon-badge-box-shadow: var(--dx-g-box-shadow-md);
+}
+
+.dx-card-base_link-hovered a.dx-card-base_borderless-image_link,
+a.dx-card-base:hover a.dx-card-base_borderless-image_link {
+    --dx-c-icon-badge-box-shadow: var(--dx-g-box-shadow-md);
+}
+
+dx-card-title:hover,
+.dx-card-base_link-hovered dx-card-title,
+a.dx-card-base:hover dx-card-title {
+    --dx-c-card-title-color: var(--dx-g-button-heading-color-hover);
+}
+
+/* Line Limits */
+.dx-text-body-2,
+.dx-text-body-3 {
+    display: -webkit-box;
+    -webkit-line-clamp: var(--dx-c-body-max-lines);
+    -webkit-box-orient: vertical;
+    overflow: hidden;
+}
+
+/* Desktop Only */
+@media screen and (min-width: 1024px) {
+    .dx-card-base_layout-horizontal .dx-card-base_borderless-image_link {
+        align-self: flex-start;
+        flex-shrink: 0;
+        width: 0;
+        height: unset;
+        margin-right: var(--dx-g-card-img-spacing);
+        margin-bottom: unset;
+        padding-top: unset;
+        padding-right: 45%;
+        padding-bottom: 22.5%;
+    }
+
+    .dx-card-base_featured dx-card-title {
+        --dx-c-card-title-letter-spacing: -0.6px;
+        --dx-c-card-title-font-size: 32px;
+        --dx-c-card-title-line-height: 40px;
+        --dx-c-card-title-icon-size: 28px;
+    }
+
+    .dx-card-base_featured .dx-text-body-2 {
+        font-size: 20px;
+        letter-spacing: 0;
+        line-height: 32px;
+    }
+
+    .dx-card-base_featured .dx-text-body-3 {
+        font-size: 16px;
+        letter-spacing: 0;
+        line-height: 24px;
+    }
+}
+
+/* Tablet */
+@media screen and (max-width: 1024px) {
+    :host {
+        --dx-g-card-item-spacing: 8px;
+        --dx-g-card-img-spacing: 16px;
+    }
+
+    .dx-card-base_borderless-image {
+        min-height: unset;
+    }
+
+    /* text resp */
+    .dx-text-body-2,
+    .dx-text-body-3 {
+        -webkit-line-clamp: 3;
+    }
+
+    .dx-text-body-2 {
+        font-size: var(--dx-g-text-sm);
+        line-height: 20px;
+    }
+
+    .dx-text-body-3 {
+        font-size: var(--dx-g-text-xs);
+        line-height: 16px;
+    }
+
+    .dx-text-heading-3 {
+        font-size: 24px;
+        line-height: 28px;
+    }
+
+    .dx-text-heading-5 {
+        font-size: 12px;
+    }
+
+    .dx-text-heading-6 {
+        font-size: var(--dx-g-text-sm);
+    }
+}