@salesforcedevs/docs-components 0.0.2 → 0.0.3-edit

package/src/modules/doc/editFile/editFile.ts

@@ -0,0 +1,213 @@
+import { LightningElement, api, track } from "lwc";
+import cx from "classnames";
+import { normalizeBoolean } from "dxUtils/normalizers";
+
+interface ApiResponse {
+    success: boolean;
+    data?: string;
+    message?: string;
+    error?: string;
+}
+
+export default class EditFile extends LightningElement {
+    @api fileName: string = "";
+    @api apiEndpoint: string = "/api/edit-file";
+    @api title: string = "Edit File";
+
+    @api
+    get disabled() {
+        return this._disabled;
+    }
+
+    set disabled(value) {
+        this._disabled = normalizeBoolean(value);
+    }
+
+    @track isPopoverOpen: boolean = false;
+    @track isLoading: boolean = false;
+    @track isSaving: boolean = false;
+    @track fileContent: string = "";
+    @track originalContent: string = "";
+    @track errorMessage: string = "";
+
+    private _disabled: boolean = false;
+
+    // API Configuration
+    private static readonly FETCH_ENDPOINT = "/api/file/fetch";
+    private static readonly SAVE_ENDPOINT = "/api/file/save";
+
+    get popoverClass() {
+        return cx(
+            "edit-file-popover",
+            this.isPopoverOpen && "edit-file-popover_open"
+        );
+    }
+
+    get overlayClass() {
+        return cx(
+            "edit-file-overlay",
+            this.isPopoverOpen && "edit-file-overlay_open"
+        );
+    }
+
+    get saveButtonClass() {
+        return cx(
+            "edit-file-button",
+            "edit-file-button_primary",
+            (this.isSaving || this.isContentUnchanged) && "edit-file-button_disabled"
+        );
+    }
+
+    get isContentUnchanged() {
+        return this.fileContent === this.originalContent;
+    }
+
+    // Open the edit file popover
+    async handleEditClick() {
+        if (this.disabled) return;
+
+        this.isPopoverOpen = true;
+        this.errorMessage = "";
+        await this.fetchFileContent();
+    }
+
+    // Fetch file content from API
+    private async fetchFileContent() {
+        if (!this.fileName) {
+            this.errorMessage = "No file specified to edit";
+            return;
+        }
+
+        this.isLoading = true;
+
+        try {
+            const response = await fetch(EditFile.FETCH_ENDPOINT, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: JSON.stringify({
+                    fileName: this.fileName,
+                    action: "fetch"
+                })
+            });
+
+            if (!response.ok) {
+                throw new Error(`Failed to fetch file: ${response.status}`);
+            }
+
+            const data: ApiResponse = await response.json();
+
+            if (data.success && data.data !== undefined) {
+                this.fileContent = data.data;
+                this.originalContent = data.data;
+                this.errorMessage = "";
+            } else {
+                this.errorMessage = data.error || data.message || "Failed to load file content";
+            }
+        } catch (error) {
+            console.error("Error fetching file content:", error);
+            this.errorMessage = error instanceof Error ? error.message : "Failed to connect to server";
+        } finally {
+            this.isLoading = false;
+        }
+    }
+
+    // Handle content change in textarea
+    handleContentChange(event: Event) {
+        const target = event.target as HTMLTextAreaElement;
+        this.fileContent = target.value;
+    }
+
+    // Handle cancel action
+    handleCancel() {
+        this.isPopoverOpen = false;
+        this.fileContent = "";
+        this.originalContent = "";
+        this.errorMessage = "";
+        this.isLoading = false;
+        this.isSaving = false;
+
+        // Dispatch cancel event
+        this.dispatchEvent(
+            new CustomEvent("editcancel", {
+                detail: { fileName: this.fileName }
+            })
+        );
+    }
+
+    // Handle save action
+    async handleSave() {
+        if (this.isSaving || this.isContentUnchanged || this.disabled) return;
+
+        this.isSaving = true;
+        this.errorMessage = "";
+
+        try {
+            const response = await fetch(EditFile.SAVE_ENDPOINT, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: JSON.stringify({
+                    fileName: this.fileName,
+                    content: this.fileContent,
+                    action: "save"
+                })
+            });
+
+            if (!response.ok) {
+                throw new Error(`Failed to save file: ${response.status}`);
+            }
+
+            const data: ApiResponse = await response.json();
+
+            if (data.success) {
+                this.originalContent = this.fileContent;
+                this.isPopoverOpen = false;
+                
+                // Dispatch success event
+                this.dispatchEvent(
+                    new CustomEvent("editsuccess", {
+                        detail: { 
+                            fileName: this.fileName,
+                            content: this.fileContent,
+                            message: data.message || "File saved successfully"
+                        }
+                    })
+                );
+            } else {
+                this.errorMessage = data.error || data.message || "Failed to save file";
+            }
+        } catch (error) {
+            console.error("Error saving file:", error);
+            this.errorMessage = error instanceof Error ? error.message : "Failed to connect to server";
+        } finally {
+            this.isSaving = false;
+        }
+    }
+
+    // Handle overlay click to close popover
+    handleOverlayClick(event: Event) {
+        if (event.target === event.currentTarget) {
+            this.handleCancel();
+        }
+    }
+
+    // Handle escape key to close popover
+    handleKeyDown(event: KeyboardEvent) {
+        if (event.key === "Escape" && this.isPopoverOpen) {
+            this.handleCancel();
+        }
+    }
+
+    connectedCallback() {
+        // Add escape key listener
+        document.addEventListener("keydown", this.handleKeyDown.bind(this));
+    }
+
+    disconnectedCallback() {
+        // Remove escape key listener
+        document.removeEventListener("keydown", this.handleKeyDown.bind(this));
+    }
+} 

package/src/modules/doc/header/header.css

@@ -0,0 +1,132 @@
+@import "dxHelpers/commonHeader";
+
+dx-logo {
+    min-width: fit-content;
+}
+
+.dev-center-link {
+    display: inline-block;
+    padding: var(--dx-g-spacing-smd) var(--dx-g-spacing-lg) 0
+        var(--dx-g-global-header-padding-horizontal);
+    height: var(--dx-g-spacing-xl);
+}
+
+.dev-center-content {
+    display: flex;
+    align-items: center;
+    text-decoration: none;
+    color: inherit;
+    font-weight: var(--dx-g-font-bold);
+}
+
+dx-icon {
+    --dx-c-icon-size: var(--dx-g-icon-size-xs);
+    --dx-c-icon-color: var(--dx-g-blue-vibrant-20);
+}
+
+.dev-center-content > * + * {
+    margin-left: 8px; /* Adjust this value to your desired spacing */
+}
+
+.header_l2 {
+    justify-content: space-between;
+    height: var(--dx-g-doc-header-main-nav-height);
+}
+
+.has-brand .header_l2 {
+    height: var(--dx-g-spacing-3xl);
+}
+
+.nav_menu-button {
+    --dx-c-button-primary-color: var(--dx-g-blue-vibrant-20);
+    --dx-c-button-secondary-color-hover: var(
+        --dx-g-brand-default-button-color-background-inactive
+    );
+}
+
+.has-brand.has-scoped-nav-items {
+    border-bottom: 1px solid var(--dx-g-gray-90);
+    border-top: 1px solid var(--dx-g-gray-90);
+}
+
+.nav_menu-ctas {
+    margin-right: var(--dx-g-spacing-sm);
+}
+
+header:not(.has-brand) > .header_l1 {
+    background: white;
+    border-bottom: 1px solid var(--dx-g-gray-90);
+}
+
+header:not(.has-brand) > .header_l2 {
+    border-bottom: 1px solid var(--dx-g-gray-90);
+    border-top: 1px solid var(--dx-g-gray-90);
+}
+
+.header_l2_group.header_l2_group-right-ctas {
+    align-items: baseline;
+}
+
+.has-brand .header_l2_group-title {
+    padding: var(--dx-g-spacing-sm) var(--dx-g-spacing-xl)
+        calc(var(--dx-g-spacing-smd) - 1px) 0;
+    min-width: 320px;
+}
+
+.no-header-content {
+    border-top: 1px solid var(--dx-g-gray-90);
+}
+
+@media (max-width: 768px) {
+    .header_l2 {
+        padding: 0;
+        flex-wrap: wrap;
+        height: 100%;
+    }
+
+    .has-nav-items .header_l2 {
+        height: initial;
+    }
+
+    .header_l2_group {
+        width: 100%;
+    }
+
+    .header_l2_group-title {
+        margin-right: 0;
+        padding: var(--dx-g-spacing-sm) 0 2px
+            var(--dx-g-global-header-padding-horizontal);
+        min-height: var(--dx-g-doc-header-main-nav-height);
+    }
+
+    .header_l2_group-nav {
+        height: var(--dx-g-spacing-3xl);
+        padding: 0;
+        margin-top: calc(var(--dx-g-spacing-2xs) + 1px);
+    }
+
+    .header_l2_group-nav_overflow {
+        height: var(--dx-g-spacing-3xl);
+        margin-right: var(--dx-g-spacing-sm);
+    }
+
+    .subtitle {
+        font-weight: var(--dx-g-font-demi);
+        letter-spacing: -0.08px;
+    }
+
+    .has-brand .header_l2_group-title {
+        margin-right: 0;
+        padding: var(--dx-g-spacing-sm) 0 var(--dx-g-spacing-2xs)
+            var(--dx-g-global-header-padding-horizontal);
+    }
+
+    .has-scoped-nav-items > .header_l2 {
+        height: unset;
+    }
+
+    header:not(.has-brand) > .header_l2 {
+        padding-bottom: 0;
+        border: 0;
+    }
+}

package/src/modules/doc/header/header.html

@@ -0,0 +1,55 @@
+<template>
+    <template lwc:if={shouldRender}>
+        <dx-brand-theme-provider brand={brand}>
+            <header class={className}>
+                <dx-banner
+                    lwc:if={showBanner}
+                    banner-markup={bannerMarkup}
+                ></dx-banner>
+                <!-- To-Do: Move the devCenter as a new component and use it here, as devCenter is also used in Sidebar now -->
+                <div lwc:if={devCenter} class="dev-center-link">
+                    <a href={devCenter.link} class="dev-center-content">
+                        <dx-icon symbol="back"></dx-icon>
+                        <dx-icon
+                            class="brand-icon"
+                            lwc:if={devCenter.icon}
+                            sprite="salesforcebrand"
+                            symbol={brand}
+                            size="large"
+                        ></dx-icon>
+                        <span class="subtitle dx-text-body-4">
+                            {devCenter.title}
+                        </span>
+                    </a>
+                </div>
+                <div class="header_l2">
+                    <div class="header_l2_group header_l2_group-title">
+                        <a href={headerHref} class="home-link">
+                            <span class="subtitle dx-text-display-7">
+                                {subtitle}
+                            </span>
+                        </a>
+                    </div>
+                    <div
+                        lwc:if={showScopedNavItems}
+                        class="header_l2_group header_l2_group-nav"
+                    >
+                        <div
+                            class="header_l2_group-nav_overflow"
+                            onscroll={onNavScroll}
+                        >
+                            <dx-header-nav
+                                aria-label="Scoped Navigation Bar"
+                                nav-items={scopedNavItems}
+                                pathname={pathname}
+                            ></dx-header-nav>
+                        </div>
+                    </div>
+                </div>
+            </header>
+        </dx-brand-theme-provider>
+    </template>
+    <template lwc:if={shouldHideHeader}>
+        <div class="no-header-content"></div>
+    </template>
+</template>

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

@@ -0,0 +1,120 @@
+import { api } from "lwc";
+import cx from "classnames";
+import type { OptionWithNested, DevCenterConfig } from "typings/custom";
+import { HeaderBase } from "dxBaseElements/headerBase";
+import { toJson, normalizeBoolean } from "dxUtils/normalizers";
+
+const TABLET_MATCH = "980px";
+const MOBILE_MATCH = "768px";
+
+const isStorybook = () => {
+    const { host } = window.location;
+    return (
+        host === "localhost:6006" || /^dsc-comp.*\.herokuapp\.com$/.test(host)
+    );
+};
+
+export default class Header extends HeaderBase {
+    @api langValuePath: string = "id"; // allows to override how language property is interpreted, follows valuePath dropdown api.
+    @api headerHref: string = "/";
+
+    @api
+    get hideDocHeader() {
+        return this._hideDocHeader;
+    }
+
+    set hideDocHeader(value) {
+        this._hideDocHeader = normalizeBoolean(value);
+    }
+
+    @api
+    get scopedNavItems() {
+        return this._scopedNavItems;
+    }
+
+    set scopedNavItems(value) {
+        this._scopedNavItems = toJson(value);
+    }
+
+    @api
+    get devCenter(): DevCenterConfig {
+        return this._devCenter;
+    }
+
+    set devCenter(value) {
+        this._devCenter = toJson(value);
+    }
+
+    private _scopedNavItems!: OptionWithNested[];
+    private tablet = false;
+    private tabletMatchMedia!: MediaQueryList;
+    private shouldRender: boolean = false;
+    private showDocDivider: boolean = false;
+    private _devCenter!: DevCenterConfig;
+    private _hideDocHeader: boolean = false;
+
+    protected mobileBreakpoint(): string {
+        return MOBILE_MATCH;
+    }
+
+    private get showScopedNavItems(): boolean {
+        return (
+            this.scopedNavItems &&
+            this.scopedNavItems.length > 0 &&
+            !this.hideDocHeader
+        );
+    }
+
+    /**
+     * This function returns true if the hideDocHeader is true and the view is not mobile.
+     * Also we need to show the header border in case the doc is hidden or if the brand information doesn't exists.
+     */
+    private get shouldHideHeader(): boolean {
+        return (this.hideDocHeader && !this.mobile) || this.showDocDivider;
+    }
+
+    connectedCallback(): void {
+        super.connectedCallback();
+        this.tabletMatchMedia = window.matchMedia(
+            `(max-width: ${TABLET_MATCH})`
+        );
+        this.onTabletChange(this.tabletMatchMedia);
+        this.tabletMatchMedia.addEventListener("change", this.onTabletChange);
+
+        if (
+            (!this.shouldHideHeader &&
+                window.location.pathname.includes("/docs/") &&
+                window.location.pathname !== "/docs/apis") ||
+            window.location.pathname ===
+                "/tableau/embedding-playground/overview" ||
+            isStorybook()
+        ) {
+            this.shouldRender = true;
+        }
+
+        if (this.shouldRender && window.location.pathname.includes("/docs/")) {
+            if (!this.brand && !this.mobile) {
+                this.shouldRender = false;
+                this.showDocDivider = true;
+            }
+        }
+    }
+
+    disconnectedCallback(): void {
+        super.disconnectedCallback();
+        this.tabletMatchMedia.removeEventListener(
+            "change",
+            this.onTabletChange
+        );
+    }
+
+    private onTabletChange = (e: MediaQueryListEvent | MediaQueryList) =>
+        (this.tablet = e.matches);
+
+    protected additionalClasses(): string {
+        return cx(
+            this.brand && "has-brand",
+            this.showScopedNavItems && "has-scoped-nav-items"
+        );
+    }
+}

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

@@ -0,0 +1,33 @@
+@import "dxHelpers/text";
+
+h1 {
+    margin: var(--dx-g-spacing-2xl) 0 var(--dx-g-spacing-md) 0;
+}
+
+h1 doc-heading-content {
+    --doc-c-heading-anchor-button-bottom: 9.5px;
+}
+
+h2 {
+    margin: var(--dx-g-spacing-2xl) 0 var(--dx-g-spacing-md) 0;
+}
+
+h2 doc-heading-content {
+    --doc-c-heading-anchor-button-bottom: 3px;
+}
+
+h3 {
+    margin: var(--dx-g-spacing-xl) 0 var(--dx-g-spacing-md) 0;
+}
+
+h3 doc-heading-content {
+    --doc-c-heading-anchor-button-bottom: -0.5px;
+}
+
+h4 {
+    margin: var(--dx-g-spacing-lg) 0 var(--dx-g-spacing-sm) 0;
+}
+
+h4 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 header={header} hash={hash}></doc-heading-content>
+    </h1>
+    <h2 class={className} if:true={isAriaLevelTwo}>
+        <doc-heading-content header={header} hash={hash}></doc-heading-content>
+    </h2>
+    <h3 class={className} if:true={isAriaLevelThree}>
+        <doc-heading-content header={header} hash={hash}></doc-heading-content>
+    </h3>
+    <h4 class={className} if:true={isAriaLevelFour}>
+        <doc-heading-content header={header} hash={hash}></doc-heading-content>
+    </h4>
+</template>

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

@@ -0,0 +1,67 @@
+import { LightningElement, api } from "lwc";
+
+export const ariaDisplayLevels: { [key: string]: string } = {
+    "1": "4",
+    "2": "5",
+    "3": "6",
+    "4": "8"
+};
+
+export const ariaLevels = Object.keys(ariaDisplayLevels);
+
+export const displayLevels = Object.values(ariaDisplayLevels);
+
+// @ts-ignore: Really Dark Magic (TM) to do with ariaLevel needing explicit getter/setters
+export default class Heading extends LightningElement {
+    @api header: string = "";
+    @api hash: string | null = null;
+
+    @api
+    private get ariaLevel(): string {
+        // Really Dark Magic (TM)
+        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 `dx-text-display-${this.displayLevel}`;
+    }
+}

package/src/modules/doc/headingAnchor/headingAnchor.css

@@ -0,0 +1,33 @@
+@import "dxHelpers/reset";
+
+button {
+    opacity: 0;
+    color: rgb(11 92 171);
+}
+
+button:hover {
+    opacity: 1;
+    outline: none;
+}
+
+button:focus {
+    opacity: 1;
+    outline: none;
+}
+
+button:focus-visible {
+    border-radius: 4px;
+    border: 2px solid rgb(11 92 171);
+}
+
+.icon-wrapper {
+    height: 32px;
+    width: 32px;
+    display: flex;
+    justify-content: center;
+    align-items: center;
+}
+
+.icon-container {
+    --dx-c-icon-size: 18px;
+}

package/src/modules/doc/headingAnchor/headingAnchor.html

@@ -0,0 +1,19 @@
+<template>
+    <dx-tooltip placement="top" label={label}>
+        <button
+            onclick={onIconClick}
+            aria-label={ariaLabel}
+            onkeydown={onKeyDown}
+            part="headingAnchorIcon"
+        >
+            <div class="icon-wrapper">
+                <dx-icon
+                    sprite={iconSprite}
+                    size={iconSize}
+                    symbol={iconSymbol}
+                    class="icon-container"
+                ></dx-icon>
+            </div>
+        </button>
+    </dx-tooltip>
+</template>