@salesforcedevs/dx-components 1.0.0 → 1.2.2-avatar-button-3

package/src/modules/dx/cardEvent/cardEvent.ts

@@ -36,7 +36,7 @@ export default class CardEvent extends LightningElement {
         this.isLinkHovered = false;
     }
 
-    private get brandType() {
+    private get typeBadgeColor() {
         return this.type === "Webinar" ? "green" : "red";
     }
 }

package/src/modules/dx/cardExpanded/cardExpanded.html

@@ -1,11 +1,6 @@
 <template>
     <div class={containerClass}>
-        <dx-type-badge
-            color={badgeColor}
-            type="content-type"
-            value={contentType}
-            size={badgeSize}
-        ></dx-type-badge>
+        <dx-type-badge variant={contentType} size={badgeSize}></dx-type-badge>
         <dx-card-title
             if:true={title}
             href={href}

package/src/modules/dx/cardExpanded/cardExpanded.ts

@@ -10,8 +10,8 @@ export default class ExpandedCard extends ArchiveCard {
     @api authorImgSrc?: string | null = null;
     @api length?: string;
 
-    private get isBlog() {
-        return this.contentType === "Blog";
+    private get isBlog(): boolean {
+        return this.contentType === "blog";
     }
 
     private get hasAuthor(): boolean {

package/src/modules/dx/cardMinimal/cardMinimal.html

@@ -3,11 +3,6 @@
         <a class="dx-text-truncate" href={href} target={target}>
             <h4>{title}</h4>
         </a>
-        <dx-type-badge
-            color={badgeColor}
-            size={badgeSize}
-            type="content-type"
-            value={contentType}
-        ></dx-type-badge>
+        <dx-type-badge variant={contentType} size={badgeSize}></dx-type-badge>
     </div>
 </template>

package/src/modules/dx/header/header.html

@@ -19,6 +19,9 @@
                         onstatechange={handleStateChange}
                     ></dx-header-search>
                 </div>
+                <div if:true={showTbidLogin} class="header-tbid-login">
+                    <dx-avatar-button></dx-avatar-button>
+                </div>
                 <div if:true={showSignup} class="header-login-signup">
                     <dx-button
                         aria-label="Sign Up For Salesforce Developer Edition"

package/src/modules/dx/header/header.ts

@@ -1,6 +1,10 @@
 import { HeaderBase } from "dxBaseElements/headerBase";
 
 export default class Header extends HeaderBase {
+    private get showTbidLogin(): boolean {
+        return this.showSignup;
+    }
+
     private get showSignup(): boolean {
         return this.signupLink
             ? (this.mobile && !this.isSearchOpen) || !this.mobile

package/src/modules/dx/logo/logo.ts

@@ -3,6 +3,6 @@ import { LightningElement, api } from "lwc";
 export default class Logo extends LightningElement {
     @api href: string = "/";
     @api imgSrc: string = "/assets/svg/salesforce-cloud.svg";
-    @api imgAlt: string = "Salesforce log";
+    @api imgAlt: string = "Salesforce logo";
     @api label!: string;
 }

package/src/modules/dx/metadataBadge/metadataBadge.css

@@ -0,0 +1,49 @@
+@import "dxHelpers/reset";
+
+.badge {
+    --background: var(--dx-g-cloud-blue-natural-90);
+    --border-radius: var(--dx-g-spacing-xs);
+    --color: var(--dx-g-blue-vibrant-20);
+    --height: var(--dx-g-spacing-lg);
+    --horizontal-spacing: var(--dx-g-spacing-sm);
+
+    color: var(--dx-c-metadata-badge-color, var(--color));
+    background: var(--dx-c-metadata-badge-background, var(--background));
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    height: var(--height);
+    width: min-content;
+    padding: 0 var(--horizontal-spacing);
+    border-radius: var(--border-radius);
+    font-family: var(--dx-g-font-display);
+    font-size: 10px;
+    text-align: center;
+    letter-spacing: 0.6px;
+    text-transform: uppercase;
+    white-space: nowrap;
+}
+
+.badge.size-small {
+    --height: var(--dx-g-spacing-md);
+    --horizontal-spacing: var(--dx-g-spacing-xs);
+
+    font-size: 8px;
+    letter-spacing: 0.5px;
+}
+
+.badge span {
+    transform: translateY(2px);
+}
+
+.badge.size-small span {
+    transform: translateY(1px);
+}
+
+@media screen and (max-width: 768px) {
+    .badge:not(.size-small) {
+        height: var(--dx-g-spacing-lg);
+        padding: 0 var(--dx-g-spacing-sm);
+        font-size: var(--dx-g-text-2xs);
+    }
+}

package/src/modules/dx/metadataBadge/metadataBadge.html

@@ -0,0 +1,5 @@
+<template>
+    <div class={className} style={style}>
+        <span>{value}</span>
+    </div>
+</template>

package/src/modules/dx/metadataBadge/metadataBadge.ts

@@ -0,0 +1,24 @@
+import { LightningElement, api } from "lwc";
+import cx from "classnames";
+import { Color, TypeBadgeSize } from "typings/custom";
+import { colorToDxColors, buildStyleColorVariables } from "dxUtils/css";
+
+export default class MetadataBadge extends LightningElement {
+    @api size: TypeBadgeSize = "default";
+    @api color?: Color;
+    @api value!: string;
+
+    private get className(): string {
+        return cx("badge", `size-${this.size}`);
+    }
+
+    private get style(): string {
+        if (this.color) {
+            const variables = colorToDxColors(this.color as Color);
+            if (variables) {
+                return buildStyleColorVariables(variables);
+            }
+        }
+        return "";
+    }
+}

package/src/modules/dx/treeItem/treeItem.html

@@ -9,6 +9,7 @@
             is-selected={isSelected}
             oniconclick={onIconClick}
             show-arrow={isParent}
+            target={target}
         ></dx-tree-tile>
     </a>
     <img

package/src/modules/dx/treeTile/treeTile.css

@@ -145,33 +145,33 @@
     --indentation: calc(20 * var(--base-indentation));
 }
 
-dx-type-badge {
-    --dx-c-type-badge-text-width: 21px;
+dx-metadata-badge {
+    --dx-c-metadata-badge-text-width: 21px;
 }
 
-dx-type-badge.get {
-    --dx-c-type-badge-color: var(--dx-g-blue-vibrant-50);
-    --dx-c-type-badge-background: var(--dx-g-blue-vibrant-90);
+dx-metadata-badge.get {
+    --dx-c-metadata-badge-color: var(--dx-g-blue-vibrant-50);
+    --dx-c-metadata-badge-background: var(--dx-g-blue-vibrant-90);
 }
 
-dx-type-badge.put {
-    --dx-c-type-badge-color: var(--dx-g-yellow-vibrant-40);
-    --dx-c-type-badge-background: var(--dx-g-yellow-vibrant-90);
+dx-metadata-badge.put {
+    --dx-c-metadata-badge-color: var(--dx-g-yellow-vibrant-40);
+    --dx-c-metadata-badge-background: var(--dx-g-yellow-vibrant-90);
 }
 
-dx-type-badge.post {
-    --dx-c-type-badge-color: var(--dx-g-green-vibrant-40);
-    --dx-c-type-badge-background: var(--dx-g-green-vibrant-90);
+dx-metadata-badge.post {
+    --dx-c-metadata-badge-color: var(--dx-g-green-vibrant-40);
+    --dx-c-metadata-badge-background: var(--dx-g-green-vibrant-90);
 }
 
-dx-type-badge.patch {
-    --dx-c-type-badge-color: var(--dx-g-teal-vibrant-40);
-    --dx-c-type-badge-background: var(--dx-g-teal-vibrant-90);
+dx-metadata-badge.patch {
+    --dx-c-metadata-badge-color: var(--dx-g-teal-vibrant-40);
+    --dx-c-metadata-badge-background: var(--dx-g-teal-vibrant-90);
 }
 
-dx-type-badge.delete {
-    --dx-c-type-badge-color: var(--dx-g-red-vibrant-40);
-    --dx-c-type-badge-background: var(--dx-g-hot-orange-vibrant-90);
+dx-metadata-badge.delete {
+    --dx-c-metadata-badge-color: var(--dx-g-red-vibrant-40);
+    --dx-c-metadata-badge-background: var(--dx-g-hot-orange-vibrant-90);
 }
 
 a {

package/src/modules/dx/treeTile/treeTile.html

@@ -1,5 +1,5 @@
 <template>
-    <a href={href} class={tileClass}>
+    <a href={href} class={tileClass} target={target}>
         <div class="flex indentation" aria-level={tileAriaLevel}>
             <span
                 class="tile-label sidebar-item-truncate-text"
@@ -16,12 +16,13 @@
                     onclick={onClickIcon}
                 ></dx-icon>
             </div>
-            <dx-type-badge
+            <dx-metadata-badge
                 if:true={showMethod}
-                class={badgeClass}
+                class="flex tile-icon"
                 size="small"
                 value={methodText}
-            ></dx-type-badge>
+                color={metadataBadgeColor}
+            ></dx-metadata-badge>
         </div>
     </a>
 </template>

package/src/modules/dx/treeTile/treeTile.ts

@@ -1,6 +1,6 @@
 import { LightningElement, api } from "lwc";
 import cx from "classnames";
-import { InternalTreeNode } from "typings/custom";
+import { Color, InternalTreeNode } from "typings/custom";
 
 const methodTextMap: {
     [key: string]: string;
@@ -12,6 +12,16 @@ const methodTextMap: {
     delete: "DELE"
 };
 
+const metadataBadgeColorMap: {
+    [key: string]: Color;
+} = {
+    get: "blue",
+    put: "yellow",
+    post: "green",
+    patch: "teal",
+    delete: "red"
+};
+
 export default class TreeTile extends LightningElement {
     @api isRoot = false;
     @api treeNode!: InternalTreeNode;
@@ -20,6 +30,7 @@ export default class TreeTile extends LightningElement {
     @api isSelected = false;
     @api href!: string;
     @api showArrow = false;
+    @api target!: string;
 
     get tileAriaLevel() {
         return this.treeNode.level + 2;
@@ -29,8 +40,11 @@ export default class TreeTile extends LightningElement {
         return this.isRoot ? "small" : "xsmall";
     }
 
-    private get badgeClass() {
-        return cx("flex", "tile-icon", this.treeNode.method);
+    private get metadataBadgeColor(): string | undefined {
+        if (this.treeNode.method) {
+            return metadataBadgeColorMap[this.treeNode.method];
+        }
+        return undefined;
     }
 
     private get showMethod() {

package/src/modules/dx/typeBadge/typeBadge.css

@@ -1,33 +1,6 @@
 @import "dxHelpers/reset";
 
-.typebadge {
-    align-items: center;
-    background: var(--dx-c-type-badge-background, var(--background));
-    border-radius: var(--dx-c-type-badge-border-radius, var(--border-radius));
-    color: var(--dx-c-type-badge-color, var(--color));
-    display: flex;
-    justify-content: center;
-    height: var(--dx-c-type-badge-height, var(--height));
-    text-align: center;
-    white-space: nowrap;
-    width: min-content;
-}
-
-.typebadge.typebadge_metadata {
-    --background: var(--dx-g-cloud-blue-natural-90);
-    --border-radius: var(--dx-g-spacing-xs);
-    --color: var(--dx-g-blue-vibrant-20);
-    --height: var(--dx-g-spacing-md);
-    --horizontal-spacing: var(--dx-g-spacing-sm);
-
-    font-family: var(--dx-g-font-display);
-    font-size: 10px;
-    letter-spacing: 0.6px;
-    text-transform: var(--dx-c-type-badge-text-transform, uppercase);
-    padding: 0 var(--horizontal-spacing);
-}
-
-.typebadge.typebadge_content-type {
+.badge {
     --background: var(--sds-g-gray-3);
     --border-radius: var(--dx-g-spacing-smd);
     --color: var(--sds-g-gray-10);
@@ -35,40 +8,26 @@
     --horizontal-spacing: var(--dx-g-spacing-smd);
     --vertical-spacing: var(--dx-g-spacing-xs);
 
+    color: var(--dx-c-type-badge-color, var(--color));
+    background: var(--dx-c-type-badge-background, var(--background));
+    border-radius: var(--border-radius);
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    height: var(--height);
+    width: min-content;
+    text-align: center;
+    white-space: nowrap;
     font-family: var(--dx-g-font-sans);
-    font-size: var(--dx-g-text-xs);
+    font-size: 10px;
     font-weight: var(--dx-g-font-bold);
     padding: var(--vertical-spacing) var(--horizontal-spacing);
 }
 
-.typebadge.typebadge_content-type.size-small {
+.badge.size-small {
     --height: var(--dx-g-spacing-mlg);
-    --horizontal-spacing: var(--dx-g-spacing-sm);
-
-    font-size: 10px;
-}
-
-.typebadge.typebadge_metadata.size-small {
-    --height: var(--dx-g-spacing-md);
-    --horizontal-spacing: var(--dx-g-spacing-xs);
-
-    font-size: 8px;
-    letter-spacing: 0.5px;
-}
-
-.typebadge.typebadge_metadata span {
-    transform: translateY(2px);
-    width: var(--dx-c-type-badge-text-width, unset);
-}
-
-.typebadge.typebadge_metadata.size-small span {
-    transform: translateY(1px);
 }
 
-@media screen and (max-width: 768px) {
-    .typebadge.typebadge_metadata:not(.size-small) {
-        height: var(--dx-g-spacing-lg);
-        padding: 0 var(--dx-g-spacing-sm);
-        font-size: var(--dx-g-text-2xs);
-    }
+dx-icon {
+    margin-right: var(--dx-g-spacing-sm);
 }

package/src/modules/dx/typeBadge/typeBadge.html

@@ -1,5 +1,11 @@
 <template>
     <div class={className} style={style}>
+        <dx-icon
+            if:true={iconSymbol}
+            symbol={iconSymbol}
+            sprite={iconSprite}
+            size="xsmall"
+        ></dx-icon>
         <span>{value}</span>
     </div>
 </template>

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

@@ -1,65 +1,161 @@
 import { LightningElement, api } from "lwc";
 import cx from "classnames";
 import {
-    TypeBadgeColor,
+    Brand,
     Color,
-    TypeBadgeSize,
-    BadgeType,
-    Brand
+    ContentType,
+    IconSprite,
+    IconSymbol,
+    TypeBadgeSize
 } from "typings/custom";
-import { colorToDxColors } from "dxUtils/css";
-
-const DEFAULT_TYPE = "typebadge_metadata";
-const VALID_BRANDS: Array<Brand> = [
-    "employees",
-    "marketing",
-    "partners",
-    "commerce",
-    "sales",
-    "success",
-    "integration",
-    "platform",
-    "industries",
-    "learning",
-    "service",
-    "analytics"
-];
+import { colorToDxColors, buildStyleColorVariables } from "dxUtils/css";
+import { BRANDS } from "dxConstants/brands";
+import { CONTENT_TYPES } from "dxConstants/contentTypes";
+
+const contentTypeLabels = {
+    documentation: "Documentation",
+    trailhead: "Trailhead",
+    blog: "Blog",
+    forum: "Forum",
+    api: "API",
+    event: "Event",
+    website: "Website",
+    podcast: "Podcast"
+};
+
+type IconData = {
+    iconSymbol: IconSymbol;
+    iconSprite: IconSprite;
+};
+
+const contentTypeIcons: {
+    [K in ContentType]: IconData;
+} = {
+    documentation: {
+        iconSprite: "utility",
+        iconSymbol: "knowledge_base"
+    },
+    trailhead: {
+        iconSprite: "salesforcebrand",
+        iconSymbol: "learning"
+    },
+    blog: {
+        iconSprite: "utility",
+        iconSymbol: "comments"
+    },
+    forum: {
+        iconSprite: "general",
+        iconSymbol: "question-circle"
+    },
+    api: {
+        iconSprite: "utility",
+        iconSymbol: "settings"
+    },
+    event: {
+        iconSprite: "utility",
+        iconSymbol: "event"
+    },
+    website: {
+        iconSprite: "utility",
+        iconSymbol: "home"
+    },
+    podcast: {
+        iconSprite: "utility",
+        iconSymbol: "unmuted"
+    }
+};
 
 export default class TypeBadge extends LightningElement {
     @api size: TypeBadgeSize = "default";
-    @api value: string = "";
-    @api color?: TypeBadgeColor = "default";
-    @api type?: BadgeType = "metadata";
+    @api variant?: Brand | ContentType = "default";
+    @api color?: Color;
+
+    @api
+    get iconSymbol(): IconSymbol | undefined {
+        return this.variantIconData
+            ? this.variantIconData.iconSymbol
+            : this._iconSymbol;
+    }
+    set iconSymbol(value: IconSymbol | undefined) {
+        if (value) {
+            this._iconSymbol = value;
+        }
+    }
+
+    @api
+    get iconSprite(): IconSprite | undefined {
+        return this.variantIconData
+            ? this.variantIconData.iconSprite
+            : this._iconSprite;
+    }
+    set iconSprite(value: IconSprite | undefined) {
+        if (value) {
+            this._iconSprite = value;
+        }
+    }
+
+    @api
+    get value(): string {
+        return this._value || this.variantLabel || "";
+    }
+
+    set value(value) {
+        if (value) {
+            this._value = value;
+        }
+    }
+
+    private _value?: string;
+    private _iconSprite?: IconSprite;
+    private _iconSymbol?: IconSymbol;
+
+    private get variantIconData(): IconData | null {
+        if (this.variant && this.variant in contentTypeIcons) {
+            return contentTypeIcons[this.variant as ContentType];
+        }
+        return null;
+    }
+
+    private get variantLabel(): string | null {
+        if (this.isContentType) {
+            return contentTypeLabels[this.variant as ContentType];
+        }
+        return null;
+    }
+
+    private get variantColorScope(): string | null {
+        if (this.isContentType) {
+            return "content-type";
+        }
+        if (this.isBrand) {
+            return "brand";
+        }
+        return null;
+    }
+
+    private get isContentType(): boolean {
+        return CONTENT_TYPES.includes(this.variant as ContentType);
+    }
+
+    private get isBrand(): boolean {
+        return BRANDS.includes(this.variant as ContentType);
+    }
 
     private get className(): string {
-        return cx(
-            "typebadge",
-            `size-${this.size}`,
-            (this.type && `typebadge_${this.type}`) || DEFAULT_TYPE
-        );
+        return cx("badge", `size-${this.size}`);
     }
 
     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`
+        if (this.variantColorScope) {
+            return buildStyleColorVariables({
+                background: `--dx-g-${this.variantColorScope}-${this.variant}-color-background`,
+                color: `--dx-g-${this.variantColorScope}-${this.variant}-color`
             });
         }
-        const variables = colorToDxColors(this.color as Color);
-        if (variables) {
-            return this.buildStyleString(variables);
+        if (this.color) {
+            const variables = colorToDxColors(this.color as Color);
+            return buildStyleColorVariables(variables);
         }
         return "";
     }
-
-    private buildStyleString({
-        background,
-        color
-    }: {
-        background: string;
-        color: string;
-    }): string {
-        return `--color: var(${color}); --background: var(${background})`;
-    }
 }

package/src/modules/dxBaseElements/archiveCard/archiveCard.ts

@@ -1,10 +1,10 @@
 import { LightningElement, api } from "lwc";
-import { LinkTarget, Color } from "typings/custom";
+import { LinkTarget, ContentType } from "typings/custom";
 
 const MOBILE_QUERY = "(max-width: 640px)";
 
 export abstract class ArchiveCard extends LightningElement {
-    @api contentType: "Blog" | "Podcast" = "Blog";
+    @api contentType!: ContentType;
     @api href!: string;
     @api title!: string;
     @api target: LinkTarget = "_self";
@@ -12,10 +12,6 @@ export abstract class ArchiveCard extends LightningElement {
     private matchMedia!: MediaQueryList;
     protected mobile = false;
 
-    protected get badgeColor(): Color {
-        return this.contentType === "Blog" ? "teal" : "blue";
-    }
-
     connectedCallback(): void {
         this.matchMedia = window.matchMedia(MOBILE_QUERY);
         this.onMediaChange(this.matchMedia);

package/src/modules/dxConstants/brands/brands.ts

@@ -0,0 +1,14 @@
+export const BRANDS = [
+    "employees",
+    "marketing",
+    "partners",
+    "commerce",
+    "sales",
+    "success",
+    "integration",
+    "platform",
+    "industries",
+    "learning",
+    "service",
+    "analytics"
+];

package/src/modules/dxConstants/colors/colors.ts

@@ -0,0 +1,14 @@
+export const COLORS = [
+    "hot-orange",
+    "orange",
+    "yellow",
+    "green",
+    "teal",
+    "cloud-blue",
+    "blue",
+    "indigo",
+    "purple",
+    "violet",
+    "pink",
+    "red"
+];

package/src/modules/dxConstants/contentTypes/contentTypes.ts

@@ -0,0 +1,10 @@
+export const CONTENT_TYPES = [
+    "documentation",
+    "trailhead",
+    "blog",
+    "forum",
+    "api",
+    "event",
+    "website",
+    "podcast"
+];