@salesforcedevs/dx-components 0.3.12 → 0.3.14-banner-alpha1

package/src/modules/dxBaseElements/headerBase/headerBase.ts

@@ -0,0 +1,215 @@
+import { LightningElement, api } from "lwc";
+import cx from "classnames";
+import { Brand, OptionWithLink, OptionWithNested } from "typings/custom";
+import { toJson, normalizeBoolean } from "dxUtils/normalizers";
+import { track } from "dxUtils/analytics";
+
+const VALID_BRANDS = [
+    "analytics",
+    "commerce",
+    "employees",
+    "industries",
+    "integration",
+    "learning",
+    "marketing",
+    "partners",
+    "platform",
+    "revenue",
+    "sales",
+    "service",
+    "success"
+];
+
+export const ANALYTICS_INFO = {
+    clickText: "Sign Up",
+    itemTitle: "Sign Up Header Button",
+    elementType: "button",
+    destinationType: "internal",
+    ctaClick: true
+};
+
+export abstract class HeaderBase extends LightningElement {
+    @api bailHref?: string | null = null;
+    @api bailLabel?: string | null = null;
+    @api brand: Brand | null = null;
+    @api coveoOrganizationId: string | null = null;
+    @api coveoPublicAccessToken: string | null = null;
+    @api coveoSearchHub: string | null = null;
+    @api coveoSearchPipeline: string | null = null;
+    @api signupLink?: string | null = null;
+    @api href = null;
+    @api subtitle!: string;
+    @api title: string = "Salesforce";
+    @api version?: string | null = null;
+    @api bannerMarkup =
+        '<span><a href="https://forms.gle/oWYTbH9RvGyt9uxx7" target="blank">Share your feedback</a>about our new site.</span>';
+
+    @api
+    get navItems() {
+        return this._navItems;
+    }
+
+    set navItems(value) {
+        this._navItems = toJson(value);
+    }
+
+    @api
+    get versions() {
+        return this._versions;
+    }
+    set versions(value) {
+        this._versions = toJson(value);
+    }
+
+    @api
+    get showBanner() {
+        return this._showBanner && this.bannerMarkup;
+    }
+
+    set showBanner(value) {
+        this._showBanner = normalizeBoolean(value);
+    }
+
+    private _navItems!: OptionWithNested[];
+    private _versions!: OptionWithLink[];
+    private matchMedia!: MediaQueryList;
+    protected mobile: boolean = false;
+    private mobileNavMenuValue: string | null = null;
+    private showMobileNavMenu: boolean = false;
+    private showNavScrollShadow: boolean = false;
+    protected isSearchOpen: boolean = false;
+    private _showBanner?: boolean = false;
+
+    get url() {
+        return this.href ? new URL(this.href!) : window.location;
+    }
+
+    get hasBailLink(): boolean {
+        return !!(this.bailHref && this.bailLabel);
+    }
+
+    get hasSearch() {
+        return (
+            this.coveoOrganizationId &&
+            this.coveoPublicAccessToken &&
+            this.coveoSearchHub &&
+            this.coveoSearchPipeline
+        );
+    }
+
+    get pathname() {
+        return this.url.pathname;
+    }
+
+    get className() {
+        return cx(
+            this.hasNavItems && "has-nav-items",
+            this.showMobileNavMenu && "state-show-mobile-nav",
+            this.showNavScrollShadow &&
+                !this.showMobileNavMenu &&
+                "has-navscrollshadow",
+            this.additionalClasses()
+        );
+    }
+
+    get versionLabel() {
+        const selectedVersion = (this.versions || []).find(
+            (v) => v.id === this.version
+        );
+        return selectedVersion ? selectedVersion.label : "";
+    }
+
+    get mobileMenuIconSymbol() {
+        return this.showMobileNavMenu ? "close" : "rows";
+    }
+
+    get isValidBrand() {
+        return this.brand && VALID_BRANDS.includes(this.brand);
+    }
+
+    get hasNavItems(): boolean {
+        return this.navItems && this.navItems.length > 0;
+    }
+
+    connectedCallback() {
+        this.matchMedia = window.matchMedia(
+            `(max-width: ${this.mobileBreakpoint()})`
+        );
+        this.onMediaChange(this.matchMedia);
+        this.matchMedia.addEventListener("change", this.onMediaChange);
+        this.hashLinkScroll();
+    }
+
+    disconnectedCallback() {
+        this.matchMedia.removeEventListener("change", this.onMediaChange);
+    }
+
+    // Temporary solution to restore native anchor scrolling
+    private hashLinkScroll() {
+        const hash = window.location.hash;
+
+        if (hash !== "") {
+            // Push onto callback queue so it runs after the DOM is updated
+            setTimeout(() => {
+                const id = hash.replace("#", "");
+                const element = document.getElementById(id);
+                if (element && element.scrollIntoView) {
+                    element.scrollIntoView();
+                }
+            }, 0);
+        }
+    }
+
+    private handleStateChange(event: CustomEvent<boolean>) {
+        event.stopPropagation();
+        this.isSearchOpen = event.detail;
+    }
+
+    onVersionChange(e: CustomEvent) {
+        this.dispatchEvent(
+            new CustomEvent("versionchange", {
+                detail: e.detail
+            })
+        );
+    }
+
+    onRequestOpenNavMenu(e: { detail: string }) {
+        this.mobileNavMenuValue = e.detail;
+        this.showMobileNavMenu = true;
+    }
+    private onMobileNavMenuChange(e: { detail: string }) {
+        this.mobileNavMenuValue = e.detail;
+    }
+    private toggleMobileNavMenu() {
+        this.showMobileNavMenu = !this.showMobileNavMenu;
+    }
+    private closeMobileNavMenu() {
+        this.showMobileNavMenu = false;
+    }
+
+    private onNavScroll(e: Event) {
+        this.showNavScrollShadow =
+            (<HTMLElement>e.currentTarget).scrollLeft > 4;
+    }
+    private onMediaChange = (e: MediaQueryListEvent | MediaQueryList) => {
+        if (!e.matches) {
+            this.mobile = false;
+            this.closeMobileNavMenu();
+        } else {
+            this.mobile = true;
+        }
+    };
+
+    private handleSignUpClick(e: PointerEvent) {
+        track(e.currentTarget!, "custEv_signupStart", {
+            ...ANALYTICS_INFO,
+            clickUrl: this.signupLink
+        });
+    }
+
+    protected additionalClasses(): string {
+        return "";
+    }
+
+    protected abstract mobileBreakpoint(): string;
+}

package/src/modules/dxBaseElements/matchMediaElement/matchMediaElement.ts

@@ -0,0 +1,59 @@
+import { LightningElement } from "lwc";
+import {
+    BREAKPOINT_MOBILE,
+    BREAKPOINT_TABLET,
+    DEVICE_DESKTOP,
+    DEVICE_TABLET,
+    DEVICE_MOBILE
+} from "dxUtils/constants";
+
+const boilerplate = "screen and ";
+const BREAKPOINT_QUERY_MOBILE = `${boilerplate}(max-width: ${BREAKPOINT_MOBILE})`;
+const BREAKPOINT_QUERY_TABLET = `${boilerplate}(min-width: ${BREAKPOINT_MOBILE}) and (max-width: ${BREAKPOINT_TABLET})`;
+const BREAKPOINT_QUERY_DESKTOP = `${boilerplate}(min-width: ${BREAKPOINT_TABLET})`;
+
+const breakpointConfigs = [
+    { name: DEVICE_MOBILE, query: BREAKPOINT_QUERY_MOBILE },
+    { name: DEVICE_TABLET, query: BREAKPOINT_QUERY_TABLET },
+    { name: DEVICE_DESKTOP, query: BREAKPOINT_QUERY_DESKTOP }
+];
+
+export abstract class MatchMediaElement extends LightningElement {
+    private deviceType: DEVICE_MOBILE | DEVICE_TABLET | DEVICE_DESKTOP =
+        DEVICE_DESKTOP;
+    private matches: {
+        match: MediaQueryList;
+        callback: (e: MediaQueryListEvent | MediaQueryList) => void;
+    }[] = [];
+
+    private get isMobile(): boolean {
+        return this.deviceType === DEVICE_MOBILE;
+    }
+    private get isTablet(): boolean {
+        return this.deviceType === DEVICE_TABLET;
+    }
+    private get isDesktop(): boolean {
+        return this.deviceType === DEVICE_DESKTOP;
+    }
+
+    connectedCallback() {
+        this.matches = breakpointConfigs.map(
+            ({ name, query }: { name: string; query: string }) => {
+                const match = window.matchMedia(query);
+                const callback = (e: MediaQueryListEvent | MediaQueryList) => {
+                    if (e.matches) {
+                        this.deviceType = name;
+                    }
+                };
+                match.addEventListener("change", callback);
+                return { match, callback };
+            }
+        );
+    }
+
+    disconnectedCallback() {
+        this.matches.forEach(({ match, callback }) =>
+            match.removeEventListener("change", callback)
+        );
+    }
+}

package/src/modules/dxBaseElements/sidebarBase/sidebarBase.ts

@@ -0,0 +1,65 @@
+import { LightningElement } from "lwc";
+
+export const HEIGHT_OF_SIDEBAR_ITEM = 32;
+export const WAIT_TIME_BEFORE_SCROLL_IN_MS = 500;
+
+export class SidebarBase extends LightningElement {
+    _sidebarContent: HTMLElement | null = null;
+
+    selectedElement: HTMLElement | null = null;
+    timerId: ReturnType<typeof setTimeout> | null = null;
+
+    get sidebarContent() {
+        if (!this._sidebarContent) {
+            this._sidebarContent = this.template.querySelector(
+                ".sidebar-content-tree"
+            );
+        }
+        return this._sidebarContent;
+    }
+
+    renderedCallback(): void {
+        /**
+         * Implementing debouncing kind of logic here to scroll to selected element once tree rendering is done
+         */
+
+        if (this.timerId) {
+            clearTimeout(this.timerId);
+        }
+        this.timerId = setTimeout(
+            this.renderedCallbackWithTimeout,
+            WAIT_TIME_BEFORE_SCROLL_IN_MS
+        );
+    }
+
+    disconnectedCallback(): void {
+        if (this.timerId) {
+            clearTimeout(this.timerId);
+        }
+    }
+
+    renderedCallbackWithTimeout = () => {
+        this.scrollToSelectedItem();
+    };
+
+    private onSelectedItemRendered = (event: CustomEvent) => {
+        event.stopPropagation();
+        this.selectedElement = event.detail.element;
+    };
+
+    /*Scroll to selected tree item */
+    private scrollToSelectedItem() {
+        if (this.selectedElement && this.sidebarContent) {
+            const scrollHeight: number =
+                this.selectedElement.getBoundingClientRect().bottom -
+                this.sidebarContent.getBoundingClientRect().bottom + // We need to remove parent bottom
+                HEIGHT_OF_SIDEBAR_ITEM * 3 + // add height of 3 more items so that user can see at least three more items after selected item
+                this.sidebarContent.offsetTop; // We need to add sidebar offsetTop value as scrollTo will consider it
+            this.sidebarContent.scrollTo({
+                top: scrollHeight,
+                behavior: "smooth"
+            });
+            this.selectedElement = null;
+        }
+    }
+}

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"
+];

package/src/modules/{helpers → dxHelpers}/card/card.css

@@ -1,4 +1,4 @@
-@import "helpers/button";
+@import "dxHelpers/button";
 
 /* main card base */
 
@@ -42,6 +42,10 @@
     box-shadow: var(--dx-g-box-shadow-md);
 }
 
+.dx-card-base_layout-horizontal {
+    flex-direction: row;
+}
+
 /* card sections with responsive padding */
 
 /* vertical sections */
@@ -98,8 +102,10 @@
     /* 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, 50px));
-    justify-items: center;
+    grid-template-columns: repeat(
+        auto-fill,
+        minmax(min-content, var(--dx-c-card-grid-max-width, 50px))
+    );
 }
 
 /* card image */
@@ -164,7 +170,7 @@ a.dx-card-base:hover a.dx-card-base_borderless-image_link {
 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);
+    --dx-c-card-title-color: var(--dx-g-blue-vibrant-50);
 }
 
 /* Line Limits */
@@ -198,6 +204,21 @@ a.dx-card-base:hover dx-card-title {
     }
 }
 
+/* Tablet + Desktop Only */
+@media screen and (min-width: 764px) {
+    .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%;
+    }
+}
+
 /* Tablet */
 @media screen and (max-width: 1024px) {
     :host {
@@ -205,36 +226,38 @@ a.dx-card-base:hover dx-card-title {
         --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 {
+    .dx-text-body-2:not(.static-font) {
         font-size: var(--dx-g-text-sm);
         line-height: 20px;
     }
 
-    .dx-text-body-3 {
+    .dx-text-body-3:not(.static-font) {
         font-size: var(--dx-g-text-xs);
         line-height: 16px;
     }
 
-    .dx-text-heading-3 {
+    .dx-text-heading-3:not(.static-font) {
         font-size: 24px;
         line-height: 28px;
     }
 
-    .dx-text-heading-5 {
+    .dx-text-heading-5:not(.static-font) {
         font-size: 12px;
     }
 
-    .dx-text-heading-6 {
+    .dx-text-heading-6:not(.static-font) {
         font-size: var(--dx-g-text-sm);
     }
 }
+
+@media screen and (max-width: 764px) {
+    .dx-card-base_borderless-image {
+        min-height: unset;
+    }
+}

package/src/modules/dxHelpers/commonHeader/commonHeader.css

@@ -0,0 +1,131 @@
+@import "dxHelpers/reset";
+@import "dxHelpers/text";
+
+:host {
+    z-index: var(--dx-g-z-index-500);
+}
+
+.header_l2_group-nav_overflow {
+    position: relative;
+    display: flex;
+    align-items: center;
+    height: 100%;
+    width: 100%;
+    transition: var(--dx-g-transition-hue-1x);
+}
+
+header {
+    display: flex;
+    flex-direction: column;
+    width: 100%;
+    position: relative;
+}
+
+header > *:not(dx-skip-nav-link) {
+    width: 100%;
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+}
+
+header.state-show-mobile-nav .header_l2_group-nav_overflow {
+    opacity: 0;
+    pointer-events: none;
+    overflow: hidden;
+}
+
+.subtitle {
+    color: var(--dx-g-blue-vibrant-20);
+}
+
+/* First row */
+
+.header_l1 {
+    height: var(--dx-g-spacing-3xl);
+    background: var(--dx-g-brand-current-color-background-2);
+    padding: 0 var(--dx-g-page-padding-horizontal);
+    position: relative;
+}
+
+.header-cta-container {
+    flex-grow: 1;
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: flex-end;
+}
+
+/* Second row */
+
+.header_l2 {
+    height: var(--dx-g-spacing-4xl);
+    background: var(--dx-g-brand-current-color-background);
+    padding: var(--dx-g-spacing-lg) var(--dx-g-page-padding-horizontal);
+}
+
+.header_l2_group {
+    display: flex;
+    align-items: center;
+    justify-content: flex-start;
+}
+
+.header_l2_group-title {
+    flex-shrink: 0;
+}
+
+.header_l2_group-title
+    .header_version-selector[aria-expanded="true"]::part(icon) {
+    transform: rotateX(180deg);
+}
+
+.header_l2_group-title .header_version-selector::part(container) {
+    padding: 0 var(--dx-g-spacing-xs);
+}
+
+.header_l2_group-title .subtitle {
+    margin-right: var(--dx-g-spacing-md);
+}
+
+.header_l2_group-title > dx-icon {
+    margin-right: var(--dx-g-spacing-sm);
+    color: var(--dx-g-brand-current-color-background);
+    border-radius: var(--dx-g-spacing-xs);
+}
+
+.header_l2_group-nav {
+    flex-grow: 1;
+}
+
+.header_l2_group-nav_overflow > dx-button {
+    margin-left: auto;
+}
+
+.home-link {
+    display: contents;
+}
+
+.home-link .subtitle:not(:first-child) {
+    margin-left: var(--dx-g-spacing-sm);
+}
+
+.header-login-signup,
+.header-tbid-login {
+    display: flex;
+    align-items: center;
+}
+
+.header-login-signup dx-button,
+.header-tbid-login dw-tbid-login-menu {
+    margin-left: var(--dx-g-spacing-smd);
+}
+
+@media (max-width: 768px) {
+    .header_l2_group-nav {
+        padding-left: calc(var(--dx-g-page-padding-horizontal) - 4px);
+    }
+
+    .header_l2_group-nav_overflow {
+        overflow-x: auto;
+        overflow-y: hidden;
+    }
+}