@salesforcedevs/docs-components 0.26.0 → 0.26.3-alpha.1

package/lwc.config.json

@@ -8,6 +8,7 @@
         "doc/contentMedia",
         "doc/content",
         "doc/header",
+        "doc/heading",
         "doc/headingAnchor",
         "doc/phase"
     ]

package/package.json

@@ -1,18 +1,14 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.26.0",
+    "version": "0.26.3-alpha.1",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
     "engines": {
         "node": ">= 14.x"
     },
-    "files": [
-        "src/modules",
-        "lwc.config.json"
-    ],
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "e3cf39d3be484acbf9bae459659f6e65f1f932cf"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

package/src/modules/doc/content/content.ts

@@ -5,23 +5,6 @@ import ContentCallout from "doc/contentCallout";
 import CodeBlock from "dx/codeBlock";
 import ContentMedia from "doc/contentMedia";
 import Button from "dx/button";
-import { highlightTerms } from "utils/highlight";
-
-const HIGHLIGHTABLE_SELECTOR = [
-    "p",
-    ".p",
-    ".shortdesc",
-    "h1",
-    "h2",
-    "h3",
-    "h4",
-    "h5",
-    "h6",
-    "li",
-    "dl",
-    "th",
-    "td"
-].join(",");
 
 const LANGUAGE_MAP: { [key: string]: string } = {
     js: "javascript"
@@ -62,18 +45,6 @@ export default class Content extends LightningElement {
             "themechange",
             this.updateTheme.bind(this) // eslint-disableline no-use-before-define
         );
-
-        window.addEventListener(
-            "highlightedtermchange",
-            this.updateHighlighted
-        );
-    }
-
-    disconnectedCallback(): void {
-        window.removeEventListener(
-            "highlightedtermchange",
-            this.updateHighlighted
-        );
     }
 
     updateTheme() {
@@ -339,12 +310,6 @@ export default class Content extends LightningElement {
         }
     }
 
-    updateHighlighted = (event: any) =>
-        highlightTerms(
-            this.template.querySelectorAll(HIGHLIGHTABLE_SELECTOR),
-            event.detail
-        );
-
     @api
     public navigateToHash(hash: String) {
         const splitHash = hash.split("#");

package/src/modules/doc/header/header.ts

@@ -1,7 +1,7 @@
 import { api } from "lwc";
 import cx from "classnames";
 import type { Option } from "typings/custom";
-import { HeaderBase } from "utils-internal/headerBase";
+import { HeaderBase } from "base-elements/headerBase";
 import { toJson } from "utils/normalizers";
 import get from "lodash.get";
 

package/src/modules/doc/heading/heading.css

@@ -0,0 +1,54 @@
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+    color: var(--dx-g-blue-vibrant-20);
+    font-family: var(--dx-g-font-display);
+    font-weight: var(--dx-g-font-demi);
+}
+
+.display-3 {
+    margin: 0 0 24px 0;
+    font-size: var(--dx-g-text-3xl);
+    letter-spacing: -0.85px;
+    line-height: var(--dx-g-text-4xl);
+}
+
+.display-3 doc-heading-content {
+    --doc-c-heading-anchor-button-bottom: 8px;
+}
+
+.display-4 {
+    margin: var(--dx-g-spacing-xl) 0 var(--dx-g-spacing-md) 0;
+    font-size: var(--dx-g-text-xl);
+    letter-spacing: -0.1px;
+    line-height: var(--dx-g-spacing-lg);
+}
+
+.display-4 doc-heading-content {
+    --doc-c-heading-anchor-button-bottom: -3px;
+}
+
+.display-5 {
+    margin: var(--dx-g-spacing-lg) 0 var(--dx-g-spacing-md) 0;
+    font-size: var(--dx-g-text-lg);
+    letter-spacing: -0.1px;
+    line-height: var(--dx-g-spacing-lg);
+}
+
+.display-5 doc-heading-content {
+    --doc-c-heading-anchor-button-bottom: -4px;
+}
+
+.display-6 {
+    margin: var(--dx-g-spacing-md) 0 var(--dx-g-spacing-sm) 0;
+    font-size: var(--dx-g-text-base);
+    letter-spacing: 0;
+    line-height: var(--dx-g-spacing-mlg);
+}
+
+.display-6 doc-heading-content {
+    --doc-c-heading-anchor-button-bottom: -6px;
+}

package/src/modules/doc/heading/heading.html

@@ -0,0 +1,14 @@
+<template>
+    <h1 class={className} if:true={isAriaLevelOne}>
+        <doc-heading-content title={title} hash={hash}></doc-heading-content>
+    </h1>
+    <h2 class={className} if:true={isAriaLevelTwo}>
+        <doc-heading-content title={title} hash={hash}></doc-heading-content>
+    </h2>
+    <h3 class={className} if:true={isAriaLevelThree}>
+        <doc-heading-content title={title} hash={hash}></doc-heading-content>
+    </h3>
+    <h4 class={className} if:true={isAriaLevelFour}>
+        <doc-heading-content title={title} hash={hash}></doc-heading-content>
+    </h4>
+</template>

package/src/modules/doc/heading/heading.ts

@@ -0,0 +1,65 @@
+import { LightningElement, api } from "lwc";
+
+export const displayLevels = ["3", "4", "5", "6"];
+
+export const ariaLevels = ["1", "2", "3", "4"];
+
+export const ariaDisplayLevels: { [key: string]: string } = {
+    "1": "3",
+    "2": "4",
+    "3": "5",
+    "4": "6"
+};
+
+export default class Heading extends LightningElement {
+    @api title: string = "";
+    @api hash: string | null = null;
+
+    @api
+    private get ariaLevel(): string {
+        return this._ariaLevel || "2";
+    }
+    private set ariaLevel(value: string | null) {
+        if (value && !ariaLevels.includes(value)) {
+            console.error(`Invalid aria-level: "${value}"`);
+            return;
+        }
+        if (value) {
+            this._ariaLevel = value;
+        }
+    }
+
+    @api
+    private get displayLevel(): string {
+        return this._displayLevel || ariaDisplayLevels[this.ariaLevel];
+    }
+    private set displayLevel(value: string | null) {
+        if (value && !displayLevels.includes(value)) {
+            console.error(`Invalid display-level: "${value}"`);
+            value = null;
+        }
+        if (value) {
+            this._displayLevel = value;
+        }
+    }
+
+    private _ariaLevel: string | null = null;
+    private _displayLevel: string | null = null;
+
+    private get isAriaLevelOne(): boolean {
+        return this.ariaLevel === "1";
+    }
+    private get isAriaLevelTwo(): boolean {
+        return this.ariaLevel === "2";
+    }
+    private get isAriaLevelThree(): boolean {
+        return this.ariaLevel === "3";
+    }
+    private get isAriaLevelFour(): boolean {
+        return this.ariaLevel === "4";
+    }
+
+    private get className(): string {
+        return `display-${this.displayLevel}`;
+    }
+}

package/src/modules/doc/headingContent/headingContent.css

@@ -0,0 +1,55 @@
+@import "helpers/reset";
+
+:host {
+    --doc-c-heading-anchor-button-bottom: 0;
+    --doc-c-heading-anchor-icon-size: 18px;
+    --button-size: var(--dx-g-spacing-xl);
+}
+
+dx-tooltip {
+    line-height: var(--button-size);
+}
+
+.button-container {
+    height: 100%;
+    margin-right: calc(var(--dx-g-spacing-xl) - 4px);
+    position: relative;
+}
+
+button {
+    position: absolute;
+    bottom: var(--doc-c-heading-anchor-button-bottom);
+    left: 0;
+    opacity: 0;
+    color: rgb(11, 92, 171);
+    display: flex;
+    justify-content: center;
+    align-items: center;
+    height: var(--button-size);
+    width: var(--button-size);
+    border-radius: 4px;
+}
+
+dx-icon {
+    --dx-c-icon-size: var(--doc-c-heading-anchor-icon-size);
+}
+
+span:last-of-type {
+    padding-right: var(--dx-g-spacing-xs);
+}
+
+.nowrap {
+    white-space: nowrap;
+}
+
+button:focus {
+    box-shadow: 0 0 0 2px rgb(11 92 171);
+}
+
+button:focus,
+button:hover,
+span:hover dx-tooltip button,
+span:hover ~ span dx-tooltip button {
+    opacity: 1;
+    outline: none;
+}

package/src/modules/doc/headingContent/headingContent.html

@@ -0,0 +1,19 @@
+<template>
+    <template if:false={hash}>{title}</template>
+    <template if:true={hash}>
+        <template if:true={needsSpace}>
+            <span>{titleToWrap}</span>
+            <span>&#32;</span>
+        </template>
+        <span class="nowrap">
+            {titleNoWrap}&nbsp;
+            <dx-tooltip placement="top" label={label}>
+                <span class="button-container">
+                    <button onclick={copy} aria-label="copy">
+                        <dx-icon size="override" symbol="link"></dx-icon>
+                    </button>
+                </span>
+            </dx-tooltip>
+        </span>
+    </template>
+</template>

package/src/modules/doc/headingContent/headingContent.ts

@@ -0,0 +1,42 @@
+import { LightningElement, api } from "lwc";
+
+export default class HeadingContent extends LightningElement {
+    @api title: string = "";
+    @api hash: string | null = null;
+
+    label: string = "Copy link to clipboard";
+    timeout: number | null = null;
+
+    private get titleToWrap(): string {
+        return this.title.substring(0, this.title.lastIndexOf(" "));
+    }
+
+    private get needsSpace(): boolean {
+        return this.titleToWrap.length > 0;
+    }
+
+    private get titleNoWrap(): string {
+        return this.title.substring(this.title.lastIndexOf(" ") + 1);
+    }
+
+    private async copy() {
+        if (this.timeout) {
+            window.clearTimeout(this.timeout);
+        }
+
+        this.label = "Copied";
+        this.timeout = window.setTimeout(() => {
+            this.label = "Copy link to clipboard";
+        }, 2000);
+
+        try {
+            if (this.title && this.hash) {
+                const [hostUrl] = window.location.href.split("#");
+                const url = `${hostUrl}#${this.hash}`;
+                await navigator.clipboard.writeText(url);
+            }
+        } catch (error) {
+            console.error(error);
+        }
+    }
+}

package/LICENSE

@@ -1,12 +0,0 @@
-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/src/modules/doc/content/__tests__/content.test.ts

@@ -1,312 +0,0 @@
-import CodeBlock from "dx/codeBlock";
-import { createRenderComponent } from "utils-internal/tests";
-import Content from "../content";
-import * as mockContent from "./mockDocContent";
-import mockPageReference from "./mockPageReference";
-
-const TAG = "doc-content";
-const render = createRenderComponent(TAG, Content);
-
-describe("doc-content", () => {
-    it("renders the content", () => {
-        const component = render({
-            docsData: mockContent.content,
-            pageReference: mockPageReference,
-            _isStorybook: false
-        });
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-        expect(contentEl).not.toBeNull();
-    });
-
-    it("renders both with and wothout pagination buttons", () => {
-        const c_buttons = render({
-            docsData: mockContent.withButtons,
-            pageReference: mockPageReference,
-            showPaginationButtons: true,
-            _isStorybook: false
-        });
-        const dx_buttons = c_buttons.shadowRoot.querySelectorAll("dx-button");
-        expect(dx_buttons.length).toEqual(2);
-
-        const c_no_buttons = render({
-            docsData: mockContent.withButtons,
-            pageReference: mockPageReference,
-            _isStorybook: false
-        });
-        const empty_dx_buttons =
-            c_no_buttons.shadowRoot.querySelectorAll("dx-button");
-        expect(empty_dx_buttons.length).toEqual(0);
-    });
-
-    it("swaps out images", () => {
-        const component = render({
-            docsData: mockContent.withImages,
-            pageReference: mockPageReference,
-            _isStorybook: false
-        });
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-        expect(contentEl).not.toBeNull();
-        const images = component.shadowRoot.querySelectorAll("img");
-        expect(images.length).toEqual(3);
-        const contentMediaEls =
-            component.shadowRoot.querySelectorAll("doc-content-media");
-        expect(contentMediaEls.length).toEqual(0);
-    });
-
-    it("swaps out iframes", () => {
-        const component = render({
-            docsData: mockContent.withVideos,
-            pageReference: mockPageReference,
-            _isStorybook: false
-        });
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-        expect(contentEl).not.toBeNull();
-        const images = component.shadowRoot.querySelectorAll("iframe");
-        expect(images.length).toEqual(0);
-        const contentMediaEls =
-            component.shadowRoot.querySelectorAll("doc-content-media");
-        expect(contentMediaEls.length).toEqual(2);
-        contentMediaEls.forEach((contentMedia) => {
-            expect(contentMedia.contentType).toEqual("iframe");
-            expect(contentMedia.mediaTitle).not.toBeUndefined();
-            expect(contentMedia.contentSrc).toMatch(
-                "https://play.vidyard.com/"
-            );
-        });
-    });
-
-    it("swaps out notes", () => {
-        const component = render({
-            docsData: mockContent.withNotes,
-            pageReference: mockPageReference,
-            _isStorybook: false
-        });
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-        expect(contentEl).not.toBeNull();
-        const notes = component.shadowRoot.querySelectorAll(".message");
-        expect(notes).toHaveLength(4);
-        notes.forEach((note) => {
-            const noteHeader = note.querySelector("doc-content-callout");
-            expect(noteHeader).not.toBeNull();
-        });
-    });
-
-    it("includes tables, lists, and code blocks in notes", () => {
-        const component = render({
-            docsData: mockContent.withNotes,
-            pageReference: mockPageReference,
-            _isStorybook: false
-        });
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-        expect(contentEl).not.toBeNull();
-        const notes = component.shadowRoot.querySelectorAll(".message");
-        expect(notes[0].querySelector("table")).not.toBeNull();
-        expect(notes[1].querySelector("ul")).not.toBeNull();
-        expect(notes[2].querySelector("ol")).not.toBeNull();
-        expect(notes[3].querySelector("dx-code-block")).not.toBeNull();
-    });
-
-    it("highlights text that matches search criteria", () => {
-        const component = render({
-            docsData: mockContent.content,
-            pageReference: mockPageReference,
-            isStorybook: true
-        });
-
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-
-        expect(contentEl.querySelectorAll("mark")).toHaveLength(0);
-
-        contentEl.dispatchEvent(
-            new CustomEvent("highlightedtermchange", {
-                detail: "apex",
-                composed: true,
-                bubbles: true
-            })
-        );
-
-        expect(contentEl.querySelectorAll("mark")).toHaveLength(14);
-    });
-
-    it("doesn't highlight elements that contains dx/docs components", () => {
-        const searchTerm = "customreport";
-
-        const component = render({
-            docsData: mockContent.sampleCodeBlockAndNote,
-            pageReference: mockPageReference,
-            isStorybook: true
-        });
-
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-
-        expect(contentEl.querySelectorAll("mark")).toHaveLength(0);
-
-        contentEl.dispatchEvent(
-            new CustomEvent("highlightedtermchange", {
-                detail: searchTerm,
-                composed: true,
-                bubbles: true
-            })
-        );
-
-        const marks: Array<HTMLElement> = contentEl.querySelectorAll("mark");
-
-        expect(marks).toHaveLength(0);
-
-        const code: CodeBlock = contentEl.querySelector("dx-code-block");
-        expect(code).not.toBeNull();
-        expect(code.codeBlock).toBeTruthy();
-        expect(contentEl.querySelector("doc-content-callout")).not.toBeNull();
-    });
-
-    it("doesn't highlight terms separated by html tags", () => {
-        const searchTerm = "loadData within";
-
-        const component = render({
-            docsData: mockContent.sampleCodeBlockAndNote,
-            pageReference: mockPageReference,
-            isStorybook: true
-        });
-
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-
-        contentEl.dispatchEvent(
-            new CustomEvent("highlightedtermchange", {
-                detail: searchTerm,
-                composed: true,
-                bubbles: true
-            })
-        );
-
-        const marks: Array<HTMLElement> =
-            component.shadowRoot.querySelectorAll("mark");
-        expect(marks).toHaveLength(0);
-    });
-
-    it("escapes regex especial characters", () => {
-        const searchTerm = "used.+";
-
-        const component = render({
-            docsData: mockContent.sampleCodeBlockAndNote,
-            pageReference: mockPageReference,
-            isStorybook: true
-        });
-
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-
-        contentEl.dispatchEvent(
-            new CustomEvent("highlightedtermchange", {
-                detail: searchTerm,
-                composed: true,
-                bubbles: true
-            })
-        );
-
-        const marks: Array<HTMLElement> =
-            component.shadowRoot.querySelectorAll("mark");
-        expect(marks).toHaveLength(0);
-    });
-
-    it("cleans previous search result before searching for a new term", () => {
-        const firstSearch = "verify";
-        const secondSearch = "sObject";
-
-        const component = render({
-            docsData: mockContent.sampleCodeBlockAndNote,
-            pageReference: mockPageReference,
-            isStorybook: true
-        });
-
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-
-        contentEl.dispatchEvent(
-            new CustomEvent("highlightedtermchange", {
-                detail: firstSearch,
-                composed: true,
-                bubbles: true
-            })
-        );
-
-        const firstMarks: Array<HTMLElement> =
-            component.shadowRoot.querySelectorAll("mark");
-        expect(firstMarks).toHaveLength(2);
-        firstMarks.forEach(({ textContent }) =>
-            expect(textContent).toBe(firstSearch)
-        );
-
-        contentEl.dispatchEvent(
-            new CustomEvent("highlightedtermchange", {
-                detail: secondSearch,
-                composed: true,
-                bubbles: true
-            })
-        );
-
-        const secondMarks: Array<HTMLElement> =
-            component.shadowRoot.querySelectorAll("mark");
-        expect(secondMarks).toHaveLength(1);
-        secondMarks.forEach(({ textContent }) =>
-            expect(textContent).toBe(secondSearch)
-        );
-    });
-
-    it("cleans all marks if the search term is empty string", () => {
-        const firstSearch = "verify";
-        const secondSearch = "";
-
-        const component = render({
-            docsData: mockContent.sampleCodeBlockAndNote,
-            pageReference: mockPageReference,
-            isStorybook: true
-        });
-
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-
-        contentEl.dispatchEvent(
-            new CustomEvent("highlightedtermchange", {
-                detail: firstSearch,
-                composed: true,
-                bubbles: true
-            })
-        );
-
-        const firstMarks: Array<HTMLElement> =
-            component.shadowRoot.querySelectorAll("mark");
-        expect(firstMarks).toHaveLength(2);
-        firstMarks.forEach(({ textContent }) =>
-            expect(textContent).toBe(firstSearch)
-        );
-
-        contentEl.dispatchEvent(
-            new CustomEvent("highlightedtermchange", {
-                detail: secondSearch,
-                composed: true,
-                bubbles: true
-            })
-        );
-
-        expect(component.shadowRoot.querySelectorAll("mark")).toHaveLength(0);
-    });
-});