@salesforcedevs/dx-components 0.26.1-alpha0.6 → 0.27.0

package/src/modules/dx/headerMobileNavMenu/headerMobileNavMenu.html

@@ -0,0 +1,73 @@
+<template>
+    <nav
+        aria-label="Navigation Menu"
+        class={className}
+        role="navigation"
+        onscroll={onScroll}
+    >
+        <ul>
+            <template for:each={navItems} for:item="navItem">
+                <li
+                    class={navItem.liClassName}
+                    key={navItem.id}
+                    aria-expanded={navItem.open}
+                    data-id={navItem.id}
+                >
+                    <!-- NAV ITEM [WITHOUT OPTIONS] -->
+                    <a
+                        class={navItem.className}
+                        href={navItem.link.href}
+                        if:false={navItem.options}
+                        onclick={onClickLink}
+                    >
+                        <span>{navItem.label}</span>
+                    </a>
+
+                    <!-- NAV ITEM [WITH OPTIONS] -->
+                    <button
+                        aria-label="Toggle accordian open"
+                        class="nav-menu_item_cta nav-menu_item_cta-main"
+                        data-id={navItem.id}
+                        if:true={navItem.options}
+                        onclick={onChange}
+                    >
+                        <span>{navItem.label}</span>
+                        <dx-icon
+                            class="chevrondown"
+                            symbol="chevrondown"
+                            size="medium"
+                        ></dx-icon>
+                    </button>
+                    <template if:true={navItem.options}>
+                        <template for:each={navItem.options} for:item="options">
+                            <div
+                                class="nav-menu_item_cta-options"
+                                key={options.id}
+                            >
+                                <template if:true={options.options}>
+                                    <template
+                                        for:each={options.options}
+                                        for:item="navSubItem"
+                                    >
+                                        <dx-header-mobile-nav-menu-option
+                                            key={navSubItem.id}
+                                            href={navSubItem.link.href}
+                                            class-name={navSubItem.className}
+                                            icon-symbol={navSubItem.iconSymbol}
+                                            menu-label={navItem.label}
+                                            item-label={navSubItem.label}
+                                            onclick={onClickLink}
+                                            target={navSubItem.link.target}
+                                        ></dx-header-mobile-nav-menu-option>
+                                    </template>
+                                </template>
+                            </div>
+                        </template>
+                    </template>
+                </li>
+            </template>
+        </ul>
+        <slot></slot>
+    </nav>
+    <div class="backdrop" if:true={open} onclick={onClickBackground}></div>
+</template>

package/src/modules/dx/headerMobileNavMenu/headerMobileNavMenu.ts

@@ -0,0 +1,102 @@
+import { LightningElement, api } from "lwc";
+import cx from "classnames";
+import { Option } from "typings/custom";
+import { deepmapOptions } from "utils/options";
+
+export default class HeaderMobileNavMenu extends LightningElement {
+    @api open: boolean = false;
+    @api value: string | null = null;
+    @api pathname: string | null = null;
+
+    @api
+    set navItems(_navItems: Option[]) {
+        this._navItems = _navItems;
+    }
+    get navItems() {
+        // first we assign container classnames to the topmost layer of options groupings
+        // (deepmapper only affects actual root options, not groups of options made for the purposes of labeling)
+        const navItems = this._navItems?.map((app) => {
+            const open = app.options ? app.id === this.value : null;
+            const liClassName = cx("nav-menu_item", open && "state-open");
+            return { ...app, open, liClassName };
+        });
+
+        // then we use deepmapper to affect the actual root options (actual links)
+        return deepmapOptions(
+            navItems,
+            (app: Option, index: number, level: number) => {
+                const active = app.link
+                    ? app.link.href === this.pathname
+                    : false;
+                const className = cx(
+                    "nav-menu_item_cta",
+                    active && "state-active",
+                    level > 1
+                        ? "nav-menu_item_cta-sub"
+                        : "nav-menu_item_cta-main"
+                );
+                const iconSymbol =
+                    app.link && app.link.target ? "new_window" : null;
+
+                return {
+                    ...app,
+                    className,
+                    iconSymbol
+                };
+            }
+        );
+    }
+
+    private _navItems: Option[] = [];
+    private navElement: HTMLElement | null = null;
+    private wasOpen: boolean = false;
+    private showScrollShadow: boolean = false;
+
+    private get className() {
+        return cx(
+            "nav-menu",
+            !this.open && "state-closed",
+            this.showScrollShadow && "has-scrollshadow"
+        );
+    }
+
+    renderedCallback() {
+        if (!this.navElement) {
+            this.navElement = this.template.querySelector("nav");
+        }
+        if (this.open && !this.wasOpen && this.value) {
+            this.scrollToAccordianSection();
+        }
+        if (this.open !== this.wasOpen) {
+            this.wasOpen = this.open;
+        }
+    }
+
+    private scrollToAccordianSection() {
+        const element = this.template.querySelector(
+            `li[data-id="${this.value}"]`
+        );
+        const container = this.template.querySelector(".nav-menu");
+        if (element && container) {
+            container.scrollTop = element.offsetTop - 8;
+        }
+    }
+
+    private onScroll(e: Event) {
+        this.showScrollShadow = (<HTMLElement>e.currentTarget).scrollTop > 4;
+    }
+
+    private onChange(e: PointerEvent) {
+        const id = (<HTMLButtonElement>e.currentTarget).getAttribute("data-id");
+        const detail = id === this.value ? null : id; // toggles accordian open/closed
+        this.dispatchEvent(new CustomEvent("change", { detail }));
+    }
+
+    private onClickLink() {
+        this.dispatchEvent(new CustomEvent("requestclose"));
+    }
+
+    private onClickBackground() {
+        this.dispatchEvent(new CustomEvent("requestclose"));
+    }
+}

package/src/modules/dx/headerMobileNavMenuOption/headerMobileNavMenuOption.css

@@ -0,0 +1,5 @@
+dx-button {
+    --dx-c-button-justify-content: flex-start;
+
+    width: 100%;
+}

package/src/modules/dx/headerMobileNavMenuOption/headerMobileNavMenuOption.html

@@ -0,0 +1,14 @@
+<template>
+    <dx-button
+        class={className}
+        href={href}
+        icon-symbol={iconSymbol}
+        target={target}
+        size="large"
+        font="sans"
+        variant="tertiary"
+        onclick={sendGtm}
+    >
+        {itemLabel}
+    </dx-button>
+</template>

package/src/modules/dx/headerMobileNavMenuOption/headerMobileNavMenuOption.ts

@@ -0,0 +1,20 @@
+import { LightningElement, api } from "lwc";
+import { track } from "dx/instrumentation";
+
+export default class HeaderMobileNavMenuOption extends LightningElement {
+    @api href: string | null = null;
+    @api className: string | null = null;
+    @api iconSymbol: string | null = null;
+    @api target: string | null = null;
+    @api menuLabel: string | null = null;
+    @api itemLabel: string | null = null;
+
+    private sendGtm(e: PointerEvent) {
+        track(e.currentTarget, "custEv_topNavLinkClick", {
+            navHeading: this.menuLabel || undefined,
+            navSubHeading: this.itemLabel || undefined,
+            clickText: this.href || undefined,
+            pageLocation: window.location.pathname || undefined
+        });
+    }
+}

package/src/modules/dx/headerNav/headerNav.css

@@ -0,0 +1,31 @@
+@import "helpers/reset";
+
+a {
+    text-decoration: none;
+}
+
+nav {
+    padding: 0;
+}
+
+.nav-list {
+    display: flex;
+}
+
+.nav-list li {
+    position: relative;
+}
+
+.nav-list-item-nav-menu {
+    display: none;
+}
+
+@media (max-width: 768px) {
+    .nav-list-item-nav-menu {
+        display: flex;
+    }
+
+    dx-dropdown {
+        display: none;
+    }
+}

package/src/modules/dx/headerNav/headerNav.html

@@ -0,0 +1,48 @@
+<template>
+    <nav role="navigation" aria-label={ariaLabel}>
+        <ul class="nav-list">
+            <template for:each={navItems} for:item="navItem">
+                <li key={navItem.id}>
+                    <dx-tab
+                        if:false={navItem.options}
+                        is-active={navItem.isActive}
+                        label={navItem.label}
+                        href={navItem.link.href}
+                        variant={variant}
+                    ></dx-tab>
+
+                    <!-- DESKTOP "MORE CONTENT" NAV ITEM -->
+                    <dx-dropdown
+                        analytics-event="custEv_topNavLinkClick"
+                        if:true={navItem.options}
+                        nav-item-label={navItem.label}
+                        open-on-hover
+                        offset="medium"
+                        options={navItem.options}
+                        placement="bottom"
+                        stay-open-after-change
+                        value={pathname}
+                        value-path="link.href"
+                    >
+                        <dx-tab
+                            label={navItem.label}
+                            variant={variant}
+                            use-icon
+                        ></dx-tab>
+                    </dx-dropdown>
+
+                    <!-- MOBILE "MORE CONTENT" NAV ITEM -->
+                    <dx-tab
+                        if:true={navItem.options}
+                        class="nav-list-item-nav-menu"
+                        data-id={navItem.id}
+                        label={navItem.label}
+                        use-icon
+                        variant={variant}
+                        onclick={requestOpenNavMenu}
+                    ></dx-tab>
+                </li>
+            </template>
+        </ul>
+    </nav>
+</template>

package/src/modules/dx/headerNav/headerNav.ts

@@ -0,0 +1,56 @@
+import { LightningElement, api } from "lwc";
+import { TabVariant, Option } from "typings/custom";
+export default class HeaderNav extends LightningElement {
+    @api pathname: string | null = null;
+    @api variant: TabVariant = "default";
+    @api ariaLabel: string = "Navigation Bar";
+
+    @api
+    set navItems(_navItems: Option[]) {
+        this._navItems = _navItems;
+    }
+
+    get navItems() {
+        const activeItem = this._navItems
+            .filter((navItem: Option) => {
+                if (!navItem.link || navItem.link.href === "/") {
+                    return false;
+                }
+
+                const fileExtension = navItem.link.href.match(/\.[0-9a-z]+$/i);
+                const baseLink = fileExtension
+                    ? navItem.link.href.substring(
+                          0,
+                          navItem.link.href.lastIndexOf("/")
+                      )
+                    : navItem.link.href;
+                return this.pathname?.includes(baseLink);
+            })
+            .sort(
+                (a, b) =>
+                    (b.link?.href.length || 0) - (a.link?.href.length || 0)
+            )[0];
+
+        const items = this._navItems.map((navItem: Option) =>
+            navItem.link
+                ? {
+                      ...navItem,
+                      isActive:
+                          navItem.link.href === this.pathname ||
+                          navItem.id === activeItem?.id
+                  }
+                : navItem
+        );
+
+        return items;
+    }
+
+    private _navItems: Option[] = [];
+
+    private requestOpenNavMenu(e: PointerEvent) {
+        const detail = (<HTMLButtonElement>e.currentTarget).getAttribute(
+            "data-id"
+        );
+        this.dispatchEvent(new CustomEvent("requestopennavmenu", { detail }));
+    }
+}

package/src/modules/dx/headerSearch/headerSearch.css

@@ -0,0 +1,62 @@
+@import "helpers/reset";
+
+/* DESKTOP */
+
+:host {
+    --toggle-width: var(--dx-g-spacing-5xl);
+}
+
+.desktop_search-container {
+    position: relative;
+    display: flex;
+    height: var(--dx-g-spacing-xl);
+    font-size: var(--dx-g-text-sm);
+    font-family: var(--dx-g-font-sans);
+    color: var(--dx-g-gray-50);
+}
+
+.desktop_search-container dx-input {
+    --dx-c-input-width: calc(
+        var(--dx-c-header-search-width) - var(--toggle-width)
+    );
+}
+
+/* MOBILE */
+
+.mobile_search-button {
+    position: relative;
+    z-index: 3;
+}
+
+.mobile_search-dropdown {
+    --dx-c-popover-border-radius: 0;
+    --dx-c-popover-border: none;
+}
+
+.mobile_search-input {
+    position: absolute;
+    top: 0;
+    left: 0;
+    height: 100%;
+    width: 100%;
+    transition: var(--dx-g-transition-hue-1x);
+    opacity: 0;
+    pointer-events: none;
+
+    --dx-c-input-border: none;
+    --dx-c-input-border-radius: 0;
+    --dx-c-input-border-active: none;
+    --dx-c-input-icon-color: var(--dx-g-blue-vibrant-20);
+    --dx-c-input-padding: 0 var(--dx-g-spacing-4xl) 0 var(--dx-g-spacing-md);
+    --dx-c-input-background: var(--dx-g-brand-current-color-background-2);
+    --dx-c-input-background-active: var(
+        --dx-g-brand-current-color-background-2
+    );
+    --dx-c-input-height: 100% !important;
+    --dx-c-input-width: 100%;
+}
+
+.mobile_search-input.state-open {
+    opacity: 1;
+    pointer-events: auto;
+}

package/src/modules/dx/headerSearch/headerSearch.html

@@ -0,0 +1,64 @@
+<template>
+    <div class={className} role="search" aria-label="Records Search">
+        <!-- MOBILE -->
+        <template if:true={mobile}>
+            <dx-dropdown
+                aria-label="Record Type"
+                class="mobile_search-dropdown"
+                open={isDropdownOpen}
+                options={suggestions}
+                onrequestclose={onDropdownRequestClose}
+                full-width
+                page-padding="0"
+            >
+                <dx-input
+                    aria-label="Record Search Term"
+                    class={mobileSearchInputClassName}
+                    icon-size="large"
+                    icon-symbol="search"
+                    onchange={onInputChange}
+                    onclear={onInputEscape}
+                    onsubmit={onInputSubmit}
+                    onfocus={openDropdown}
+                    placeholder="Search"
+                    size="override"
+                    type="search"
+                ></dx-input>
+            </dx-dropdown>
+            <dx-button
+                class="mobile_search-button"
+                aria-label={mobileSearchButtonAriaLabel}
+                icon-size="large"
+                icon-symbol={mobileSearchButtonIcon}
+                onclick={onMobileSearchButtonClick}
+                variant="tertiary"
+            ></dx-button>
+        </template>
+
+        <!-- DESKTOP -->
+        <template if:false={mobile}>
+            <dx-dropdown
+                options={suggestions}
+                open={isDropdownOpen}
+                placement="bottom-end"
+                onrequestclose={onDropdownRequestClose}
+                offset="small"
+                full-width
+            >
+                <dx-input
+                    aria-label="Record Search Term"
+                    icon-symbol="search"
+                    onchange={onInputChange}
+                    onclear={onInputEscape}
+                    onsubmit={onInputSubmit}
+                    onfocus={openDropdown}
+                    placeholder="Search"
+                    shortcut-key="k"
+                    size="small"
+                    type="search"
+                    value={searchBox.value}
+                ></dx-input>
+            </dx-dropdown>
+        </template>
+    </div>
+</template>

package/src/modules/dx/headerSearch/headerSearch.ts

@@ -0,0 +1,159 @@
+import { LightningElement, api } from "lwc";
+import cx from "classnames";
+import { PopoverRequestCloseType, Option } from "typings/custom";
+import { buildSearchEngine } from "utils/coveo";
+import {
+    StandaloneSearchBox as StandaloneSearchBoxType,
+    StandaloneSearchBoxState,
+    buildStandaloneSearchBox,
+    StandaloneSearchBoxOptions
+} from "@coveo/headless";
+
+const baseSearchHref = `/search`;
+
+export default class HeaderSearch extends LightningElement {
+    @api mobile!: boolean;
+    @api coveoOrganizationId!: string;
+    @api coveoPublicAccessToken!: string;
+    @api coveoSearchPipeline!: string;
+    @api coveoSearchHub!: string;
+
+    private input: HTMLElement | null = null;
+    private isDropdownOpen: boolean = false;
+    private isMobileSearchOpen: boolean = false;
+    private searchBox: StandaloneSearchBoxType | null = null;
+    private searchState: StandaloneSearchBoxState | null = null;
+
+    private get className() {
+        return this.mobile ? null : "desktop_search-container";
+    }
+
+    private get suggestions(): Option[] {
+        if (this.searchState) {
+            return this.searchState.suggestions.map(
+                ({ highlightedValue }: { highlightedValue: string }) => ({
+                    id: highlightedValue,
+                    label: highlightedValue,
+                    link: {
+                        href: this.createSearchHref(highlightedValue),
+                        target: null
+                    }
+                })
+            );
+        }
+        return [];
+    }
+
+    private get mobileSearchInputClassName() {
+        return cx(
+            "mobile_search-input",
+            this.isMobileSearchOpen && "state-open"
+        );
+    }
+
+    private get mobileSearchButtonIcon() {
+        return this.isMobileSearchOpen ? "close" : "search";
+    }
+
+    private get mobileSearchButtonAriaLabel() {
+        return this.isMobileSearchOpen
+            ? "Hide mobile search"
+            : "Show mobile search";
+    }
+
+    connectedCallback() {
+        this.instantiateSearchbox();
+    }
+
+    private onDropdownRequestClose(e: CustomEvent) {
+        switch (e.detail as PopoverRequestCloseType) {
+            case "interact-outside":
+            case "keypress-escape":
+                this.closeDropdown();
+                break;
+            default:
+                break;
+        }
+    }
+
+    private instantiateSearchbox() {
+        try {
+            const options: StandaloneSearchBoxOptions = {
+                numberOfSuggestions: 3,
+                redirectionUrl: "https://developer.salesforce.com"
+            };
+
+            const engine = buildSearchEngine({
+                organizationId: this.coveoOrganizationId,
+                publicAccessToken: this.coveoPublicAccessToken,
+                searchPipeline: this.coveoSearchPipeline,
+                searchHub: this.coveoSearchHub
+            });
+
+            this.searchBox = buildStandaloneSearchBox(engine, { options });
+
+            this.searchBox?.subscribe(() => {
+                if (this.searchBox) {
+                    this.searchState = this.searchBox.state;
+                }
+            });
+        } catch (e) {
+            console.error(`Coveo searchbox failed to initialize (${e})`);
+        }
+    }
+
+    private createSearchHref = (value: string | null = "") => {
+        return `${baseSearchHref}#q=${value}`;
+    };
+
+    private onInputChange(e: CustomEvent) {
+        if (this.searchBox) {
+            this.searchBox.updateText(e.detail);
+        }
+    }
+
+    private onInputSubmit(e: CustomEvent) {
+        const href = this.createSearchHref(e.detail || "");
+        window.location.assign(href);
+    }
+
+    private onMobileSearchButtonClick() {
+        this.isMobileSearchOpen = !this.isMobileSearchOpen;
+        const input = this.template.querySelector("dx-input");
+        if (this.isMobileSearchOpen && input) {
+            input.focus();
+            this.openDropdown();
+        } else {
+            this.closeDropdown();
+        }
+        if (!this.isMobileSearchOpen && this.searchBox) {
+            this.searchBox.updateText("");
+        }
+    }
+
+    private openDropdown() {
+        this.isDropdownOpen = true;
+        this.isMobileSearchOpen = true;
+        this.reportState<boolean>(true);
+    }
+
+    private closeDropdown() {
+        this.isDropdownOpen = false;
+        this.isMobileSearchOpen = false;
+        this.reportState<boolean>(false);
+    }
+
+    private onInputEscape() {
+        this.closeDropdown();
+    }
+
+    private reportState<T>(state: T) {
+        this.dispatchEvent(
+            new CustomEvent("statechange", {
+                detail: state,
+                bubbles: true,
+                composed: true
+            })
+        );
+    }
+}