@salesforcedevs/dx-components 0.0.0

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

@@ -0,0 +1,205 @@
+import { LightningElement, api } from "lwc";
+import cx from "classnames";
+import { Brand, OptionWithLink, OptionWithNested } from "typings/custom";
+import { toJson } 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);
+    }
+
+    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;
+
+    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/dxHelpers/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/dxHelpers/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/dxHelpers/card/card.css

@@ -0,0 +1,263 @@
+@import "dxHelpers/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_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 + 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 {
+        --dx-g-card-item-spacing: 8px;
+        --dx-g-card-img-spacing: 16px;
+    }
+
+    /* text resp */
+    .dx-text-body-2,
+    .dx-text-body-3 {
+        -webkit-line-clamp: 3;
+    }
+
+    .dx-text-body-2:not(.static-font) {
+        font-size: var(--dx-g-text-sm);
+        line-height: 20px;
+    }
+
+    .dx-text-body-3:not(.static-font) {
+        font-size: var(--dx-g-text-xs);
+        line-height: 16px;
+    }
+
+    .dx-text-heading-3:not(.static-font) {
+        font-size: 24px;
+        line-height: 28px;
+    }
+
+    .dx-text-heading-5:not(.static-font) {
+        font-size: 12px;
+    }
+
+    .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;
+    }
+}