@salesforcedevs/dx-components 0.8.5-alpha1 → 0.10.1

package/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2020, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/dx-components",
-    "version": "0.8.5-alpha1",
+    "version": "0.10.1",
     "description": "DX Lightning web components",
     "license": "MIT",
     "engines": {
@@ -28,5 +28,6 @@
         "@types/classnames": "^2.2.10",
         "@types/debounce": "^1.2.0",
         "@types/lodash.get": "^4.4.6"
-    }
+    },
+    "gitHead": "84ec3fe64f80f136723f84c0222afe7f34c7b2a2"
 }

package/src/modules/dx/codeBlock/codeBlock.ts

@@ -20,8 +20,6 @@ export default class CodeBlock extends LightningElement {
     @api title: string = "title";
     @api sourceLink: string = "";
     @api language: string = "";
-    // if it is true, it renders code as is coming instead of wrapping it into html/xml comments tags.
-    @api isEncoded = false;
 
     private markupLangs = ["visualforce", "html", "xml"];
     private _codeBlockRendered: boolean = false;
@@ -91,10 +89,7 @@ export default class CodeBlock extends LightningElement {
     formatCodeBlock() {
         const divEl = this.template.querySelector("div.code-block-content");
         const templateEl = document.createElement("template");
-        if (
-            !this.isEncoded &&
-            this.markupLangs.includes(this.selectedLanguage.id || "")
-        ) {
+        if (this.markupLangs.includes(this.selectedLanguage.id || "")) {
             // eslint-disable-next-line
             templateEl.innerHTML = `<pre class='codeblock'><!-- ${this.codeBlock.replace(
                 /<!--(.*?)-->/gs,

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

@@ -8,7 +8,6 @@
                 open={isDropdownOpen}
                 options={suggestions}
                 onrequestclose={onDropdownRequestClose}
-                onrequestopen={openPopover}
                 full-width
                 page-padding="0"
             >
@@ -18,8 +17,9 @@
                     icon-size="large"
                     icon-symbol="search"
                     onchange={onInputChange}
-                    onescape={onInputEscape}
+                    onclear={onInputEscape}
                     onsubmit={onInputSubmit}
+                    onfocus={openDropdown}
                     placeholder="Search"
                     size="override"
                     type="search"
@@ -43,18 +43,16 @@
                 open={isDropdownOpen}
                 placement="bottom-end"
                 onrequestclose={onDropdownRequestClose}
-                onrequestopen={openPopover}
                 offset="small"
                 full-width
-                temp-id="banana"
             >
                 <dx-input
                     aria-label="Record Search Term"
                     icon-symbol="search"
                     onchange={onInputChange}
-                    onescape={onInputEscape}
+                    onclear={onInputEscape}
                     onsubmit={onInputSubmit}
-                    onfocus={openPopover}
+                    onfocus={openDropdown}
                     placeholder="Search"
                     shortcut-key="k"
                     size="small"

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

@@ -70,7 +70,7 @@ export default class HeaderSearch extends LightningElement {
         switch (e.detail as PopoverRequestCloseType) {
             case "interact-outside":
             case "keypress-escape":
-                this.closePopover();
+                this.closeDropdown();
                 break;
             default:
                 break;
@@ -124,29 +124,29 @@ export default class HeaderSearch extends LightningElement {
         const input = this.template.querySelector("dx-input");
         if (this.isMobileSearchOpen && input) {
             input.focus();
-            this.openPopover();
+            this.openDropdown();
         } else {
-            this.closePopover();
+            this.closeDropdown();
         }
         if (!this.isMobileSearchOpen && this.searchBox) {
             this.searchBox.updateText("");
         }
     }
 
-    private openPopover() {
+    private openDropdown() {
         this.isDropdownOpen = true;
         this.isMobileSearchOpen = true;
         this.reportState<boolean>(true);
     }
 
-    private closePopover() {
+    private closeDropdown() {
         this.isDropdownOpen = false;
         this.isMobileSearchOpen = false;
         this.reportState<boolean>(false);
     }
 
     private onInputEscape() {
-        this.closePopover();
+        this.closeDropdown();
     }
 
     private reportState<T>(state: T) {

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

@@ -320,4 +320,49 @@ describe(TAG, () => {
 
         return Promise.resolve().then(() => assertErrorMissing(element));
     });
+
+    it("shows clear button if value is nonempty and clearable is true", () => {
+        const element = render({
+            value: "test",
+            clearable: true
+        });
+
+        const clearButton: HTMLButtonElement = element.shadowRoot.querySelector(
+            ".clear-button"
+        );
+        expect(clearButton).not.toBeNull();
+    });
+
+    it("doesn't show clear button if no value", () => {
+        const element = render({
+            value: "",
+            clearable: true
+        });
+
+        const clearButton: HTMLButtonElement = element.shadowRoot.querySelector(
+            ".clear-button"
+        );
+        expect(clearButton).toBeNull();
+    });
+
+    it("clears input value on click of clear button", async () => {
+        const element = render({
+            value: "test",
+            clearable: true
+        });
+
+        const input: HTMLInputElement = element.shadowRoot.querySelector(
+            "input"
+        );
+        expect(input.value).toEqual("test");
+
+        const clearButton: HTMLButtonElement = element.shadowRoot.querySelector(
+            ".clear-button"
+        );
+        clearButton.dispatchEvent(new MouseEvent("click"));
+
+        await Promise.resolve();
+
+        expect(input.value).toEqual("");
+    });
 });

package/src/modules/dx/input/input.css

@@ -51,7 +51,7 @@
     flex-grow: 1;
 }
 
-.input-container.has-shortcut {
+.input-container.has-floating-item {
     padding-right: var(--dx-g-spacing-sm);
 }
 
@@ -150,3 +150,15 @@ input::placeholder {
     margin-top: var(--dx-g-spacing-2xs);
     display: block;
 }
+
+.clear-button > dx-icon {
+    --dx-c-icon-color: var(--sds-g-gray-9);
+}
+
+.clear-button > dx-icon::part(svg) {
+    transition: var(--dx-g-transition-hue-1x);
+}
+
+.clear-button:hover > dx-icon {
+    --dx-c-icon-color: var(--dx-g-blue-vibrant-30);
+}

package/src/modules/dx/input/input.html

@@ -25,7 +25,15 @@
                 type={type}
                 value={value}
             />
-            <div class="shortcut" if:true={shortcutKey}>
+            <button
+                class="clear-button"
+                aria-label="Clear"
+                if:true={showClearButton}
+                onclick={clear}
+            >
+                <dx-icon symbol="clear" size="medium"></dx-icon>
+            </button>
+            <div class="shortcut" if:true={showShortcutKey}>
                 <img src={shortcutImgSrc} alt={shortcutImgAlt} />
                 <span>{shortcutKey}</span>
             </div>

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

@@ -19,8 +19,11 @@ export const Base = () => html`
         margin-bottom: 25px;
         margin-top: 25px;
     `)}
+
     <dx-input placeholder="Example"></dx-input>
 
+    <dx-input placeholder="Example Clearable" clearable="true"></dx-input>
+
     <dx-input placeholder="Example Large" size="large"></dx-input>
 
     <dx-input placeholder="Example with Icon" icon-symbol="search"></dx-input>

package/src/modules/dx/input/input.ts

@@ -20,6 +20,7 @@ const typeValidatorMap: ValidatorMap = {
 export default class Input extends LightningElement {
     @api ariaLabel!: string;
     @api autocomplete: string | null = null;
+    @api clearable: boolean = false;
     @api disabled: boolean = false;
     @api iconSize: IconSize = "medium";
     @api iconSymbol: IconSymbol | null = null;
@@ -84,6 +85,14 @@ export default class Input extends LightningElement {
     private _value: string | null = null;
     private _loading: boolean = false;
 
+    private get showClearButton(): boolean {
+        return this.clearable && !!this.value;
+    }
+
+    private get showShortcutKey(): boolean {
+        return !this.showClearButton && !!this.shortcutKey;
+    }
+
     private get ariaKeyShortcuts() {
         return this.shortcutKey ? `meta+${this.shortcutKey}` : null;
     }
@@ -113,7 +122,8 @@ export default class Input extends LightningElement {
         return cx(
             "input-container",
             this.focused && "state-focused",
-            this.shortcutKey && "has-shortcut",
+            (this.showClearButton || this.showShortcutKey) &&
+                "has-floating-item",
             !!this.errorMessage && "has-error"
         );
     }
@@ -174,45 +184,46 @@ export default class Input extends LightningElement {
         if (!e || !e.target) {
             return;
         }
-        this._value = (<HTMLInputElement>e.target).value || "";
-        this.dispatchChange();
+        this.dispatchChange((<HTMLInputElement>e.target).value || "");
     }
 
     onButtonClick(e: Event) {
         if (!this.buttonDisabled) {
             e.stopPropagation();
         }
-        this.onSubmit();
+        this.submit();
     }
 
-    dispatchChange() {
+    dispatchChange(value: string) {
+        this._value = value;
         this.dispatchEvent(new CustomEvent("change", { detail: this.value }));
     }
 
-    dispatchSubmit() {
-        this.dispatchEvent(new CustomEvent("submit", { detail: this.value }));
+    clear(e?: Event) {
+        if (e) {
+            e.stopPropagation();
+        }
+        this.dispatchChange("");
+        this.dispatchEvent(new CustomEvent("clear"));
+        if (this.input) {
+            this.input.blur();
+        }
     }
 
-    onSubmit = async () => {
+    submit = async () => {
         if (this.inputInvalid) {
             return;
         }
-        this.dispatchSubmit();
+        this.dispatchEvent(new CustomEvent("submit", { detail: this.value }));
     };
 
     private onKeyDown(e: KeyboardEvent) {
         switch (e.key) {
             case "Escape":
-                this.dispatchEvent(new CustomEvent("escape"));
-                if (this.input) {
-                    this.input.blur();
-                    this._value = "";
-                    this.dispatchChange();
-                }
+                this.clear();
                 break;
             case "Enter":
-                this.onSubmit();
-                this.dispatchEvent(new CustomEvent("enter"));
+                this.submit();
                 break;
             default:
         }

package/src/modules/dx/popover/popover.ts

@@ -212,23 +212,27 @@ export default class Popover extends LightningElement {
     };
 
     private onControlClick = () => {
-        if (this.controlled) {
+        if (this.controlled && this.open) {
             this.dispatchRequestCloseEvent("click-control");
             return;
         }
 
+        if (this.controlled && !this.open) {
+            this.dispatchEvent(
+                new CustomEvent("requestopen", {
+                    bubbles: true,
+                    composed: true
+                })
+            );
+            return;
+        }
+
         if (this.open) {
             this.closePopover();
             return;
         }
 
         this.openPopover();
-        this.dispatchEvent(
-            new CustomEvent("requestopen", {
-                bubbles: true,
-                composed: true
-            })
-        );
     };
 
     private onSlotChange(e: LightningSlotElement) {

package/src/modules/dx/sectionSignup/sectionSignup.html

@@ -15,7 +15,6 @@
                     placeholder={inputPlaceholder}
                     submit-label={inputSubmitLabel}
                     onsubmit={onSubmit}
-                    onenter={onSubmit}
                     size={size}
                 ></dx-input>
             </div>

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

@@ -29,18 +29,10 @@ describe(TAG, () => {
             });
 
             const link = component.shadowRoot.querySelector("a");
-            expect(link).toBeNull();
-
-            const button: HTMLElement = component.shadowRoot.querySelector(
-                "button"
-            );
-            expect(button).not.toBeNull();
-            expect(button.getAttribute("aria-label")).toBe(
-                NODE_WITH_CHILDREN.label
-            );
+            expect(link).not.toBeNull();
 
             const tile: TreeTile = component.shadowRoot.querySelector(
-                "button > dx-tree-tile"
+                "a > dx-tree-tile"
             );
             expect(tile).not.toBeNull();
             assertTile(tile, {
@@ -66,7 +58,7 @@ describe(TAG, () => {
             });
 
             const tile: TreeTile = component.shadowRoot.querySelector(
-                "button > dx-tree-tile"
+                "a > dx-tree-tile"
             );
             expect(tile).not.toBeNull();
             assertTile(tile, {
@@ -280,14 +272,12 @@ describe(TAG, () => {
             component.addEventListener("tileselected", mockTileSelected);
             component.addEventListener("expandcollapse", mockExpandCollapse);
 
-            const button: HTMLElement = component.shadowRoot.querySelector(
-                "button"
-            );
-            expect(button).not.toBeNull();
-            button.click();
+            const link: HTMLElement = component.shadowRoot.querySelector("a");
+            expect(link).not.toBeNull();
+            link.click();
 
             expect(track).toBeCalledTimes(1);
-            expect(track).toBeCalledWith(button, GTM_EVENT_NAME, {
+            expect(track).toBeCalledWith(link, GTM_EVENT_NAME, {
                 clickText: NODE_WITH_CHILDREN.label,
                 sideNavAction: "click"
             });
@@ -328,11 +318,9 @@ describe(TAG, () => {
             );
             expect(tile).toHaveProperty("isSelected", true);
 
-            const button: HTMLElement = component.shadowRoot.querySelector(
-                "button"
-            );
-            expect(button).not.toBeNull();
-            button.click();
+            const link: HTMLElement = component.shadowRoot.querySelector("a");
+            expect(link).not.toBeNull();
+            link.click();
 
             return Promise.resolve().then(() => {
                 expect(tile).toHaveProperty("isSelected", true);

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

@@ -1,16 +1,7 @@
 <template>
-    <button if:false={href} onclick={onButtonClick} aria-label={treeNode.label}>
-        <dx-tree-tile
-            is-root={isRoot}
-            tree-node={treeNode}
-            is-expanded={isExpanded}
-            has-children={hasChildren}
-            is-selected={isSelected}
-            oniconclick={onIconClick}
-        ></dx-tree-tile>
-    </button>
-    <a if:true={href} href={href} target={target} onclick={onLinkClick}>
+    <a href={href} target={target} onclick={onLinkClick}>
         <dx-tree-tile
+            href={href}
             is-root={isRoot}
             tree-node={treeNode}
             is-expanded={isExpanded}

package/src/modules/dx/treeItem/treeItem.ts

@@ -39,7 +39,11 @@ export default class TreeItem extends LightningElement {
     }
 
     private get href(): string | undefined {
-        return this._treeNode.link && this._treeNode.link.href;
+        return (
+            (this._treeNode.link && this._treeNode.link.href) ||
+            this._treeNode.name ||
+            ""
+        );
     }
 
     private get target(): string {
@@ -62,7 +66,11 @@ export default class TreeItem extends LightningElement {
         this.sendGtm(event, this.isExpanded ? "expand" : "collapse");
     }
 
-    private onButtonClick(event: Event): void {
+    private onLinkClick(event: Event): void {
+        if (!(this._treeNode.link && this._treeNode.link.href)) {
+            event.preventDefault();
+        }
+
         if (this.hasChildren) {
             this.doExpand();
         }
@@ -71,10 +79,6 @@ export default class TreeItem extends LightningElement {
         this.fireEvent("tileselected", { name: this._treeNode.name });
     }
 
-    private onLinkClick(event: Event): void {
-        this.sendGtm(event, "click");
-    }
-
     private doExpand(): void {
         this.isExpanded = !this.isExpanded;
         this.fireEvent("expandcollapse");

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

@@ -23,14 +23,15 @@ const assertLevelAndLabel = (container: HTMLElement) => {
 describe(TAG, () => {
     describe("render", () => {
         it("should render as a leaf tile", () => {
-            const component = render({ treeNode: SINGLE_NODE });
-            const tileDiv: HTMLElement = component.shadowRoot.querySelector(
-                "div.tile"
+            const component = render({ treeNode: SINGLE_NODE, href: "/test" });
+            const tileAnchor: HTMLElement = component.shadowRoot.querySelector(
+                "a.tile"
             );
 
-            expect(tileDiv.classList).toHaveLength(1);
-            expect(tileDiv).not.toBeNull();
-            assertLevelAndLabel(tileDiv);
+            expect(tileAnchor.getAttribute("href")).toBe("/test");
+            expect(tileAnchor.classList).toHaveLength(1);
+            expect(tileAnchor).not.toBeNull();
+            assertLevelAndLabel(tileAnchor);
 
             const arrowIcon: Icon = component.shadowRoot.querySelector(
                 "dx-icon"
@@ -51,12 +52,12 @@ describe(TAG, () => {
                 isRoot: true,
                 hasChildren: true
             });
-            const tileDiv: HTMLElement = component.shadowRoot.querySelector(
-                "div.tile.tile-root"
+            const tileAnchor: HTMLElement = component.shadowRoot.querySelector(
+                "a.tile.tile-root"
             );
-            expect(tileDiv).not.toBeNull();
-            expect(tileDiv.classList).toHaveLength(2);
-            assertLevelAndLabel(tileDiv);
+            expect(tileAnchor).not.toBeNull();
+            expect(tileAnchor.classList).toHaveLength(2);
+            assertLevelAndLabel(tileAnchor);
 
             const arrowIcon: Icon = component.shadowRoot.querySelector(
                 "dx-icon"
@@ -79,13 +80,13 @@ describe(TAG, () => {
                 hasChildren: true,
                 isExpanded: true
             });
-            const tileDiv: HTMLElement = component.shadowRoot.querySelector(
-                "div.tile.tile-with-children"
+            const tileAnchor: HTMLElement = component.shadowRoot.querySelector(
+                "a.tile.tile-with-children"
             );
 
-            expect(tileDiv).not.toBeNull();
-            expect(tileDiv.classList).toHaveLength(2);
-            assertLevelAndLabel(tileDiv);
+            expect(tileAnchor).not.toBeNull();
+            expect(tileAnchor.classList).toHaveLength(2);
+            assertLevelAndLabel(tileAnchor);
 
             const arrowIcon: Icon = component.shadowRoot.querySelector(
                 "dx-icon"
@@ -107,11 +108,11 @@ describe(TAG, () => {
                 treeNode: SINGLE_NODE,
                 isSelected: true
             });
-            const tileDiv: HTMLElement = component.shadowRoot.querySelector(
-                "div.tile.tile-selected"
+            const tileAnchor: HTMLElement = component.shadowRoot.querySelector(
+                "a.tile.tile-selected"
             );
-            expect(tileDiv).not.toBeNull();
-            expect(tileDiv.classList).toHaveLength(2);
+            expect(tileAnchor).not.toBeNull();
+            expect(tileAnchor.classList).toHaveLength(2);
 
             return expect(component).toBeAccessible();
         });

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

@@ -34,6 +34,7 @@
     font-size: var(--dx-g-text-sm);
     font-weight: var(--dx-g-font-demi);
     color: var(--dx-g-blue-vibrant-30);
+    display: block;
 }
 
 .tile-selected {
@@ -188,3 +189,18 @@ 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);
 }
+
+a {
+    display: block;
+    text-decoration: none;
+}
+
+a:link,
+a:visited {
+    color: var(--dx-g-gray-10);
+}
+
+a:visited.tile-root,
+a:link.tile-root {
+    color: var(--dx-g-blue-vibrant-30);
+}

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

@@ -1,5 +1,5 @@
 <template>
-    <div class={tileClass}>
+    <a href={href} class={tileClass}>
         <div class="flex indentation" aria-level={tileAriaLevel}>
             <span class="tile-label truncate" title={treeNode.label}>
                 {treeNode.label}
@@ -20,5 +20,5 @@
                 value={methodText}
             ></dx-type-badge>
         </div>
-    </div>
+    </a>
 </template>

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

@@ -18,6 +18,7 @@ export default class TreeTile extends LightningElement {
     @api isExpanded = false;
     @api hasChildren = false;
     @api isSelected = false;
+    @api href!: string;
 
     get tileAriaLevel() {
         return this.treeNode.level + 2;