anki/ts/editor/NoteEditor.svelte

<!--
Copyright: Ankitects Pty Ltd and contributors
License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
-->
<script context="module" lang="ts">
    import type { Writable } from "svelte/store";

    import Collapsible from "../components/Collapsible.svelte";
    import type { EditingInputAPI } from "./EditingArea.svelte";
    import type { EditorToolbarAPI } from "./editor-toolbar";
    import type { EditorFieldAPI } from "./EditorField.svelte";
    import FieldState from "./FieldState.svelte";
    import LabelContainer from "./LabelContainer.svelte";
    import LabelName from "./LabelName.svelte";

    export interface NoteEditorAPI {
        fields: EditorFieldAPI[];
        hoveredField: Writable<EditorFieldAPI | null>;
        focusedField: Writable<EditorFieldAPI | null>;
        focusedInput: Writable<EditingInputAPI | null>;
        toolbar: EditorToolbarAPI;
    }

    import { registerPackage } from "../lib/runtime-require";
    import contextProperty from "../sveltelib/context-property";
    import lifecycleHooks from "../sveltelib/lifecycle-hooks";

    const key = Symbol("noteEditor");
    const [context, setContextProperty] = contextProperty<NoteEditorAPI>(key);
    const [lifecycle, instances, setupLifecycleHooks] = lifecycleHooks<NoteEditorAPI>();

    export { context };

    registerPackage("anki/NoteEditor", {
        context,
        lifecycle,
        instances,
    });
</script>

<script lang="ts">
    import { onMount, tick } from "svelte";
    import { get, writable } from "svelte/store";

    import Absolute from "../components/Absolute.svelte";
    import Badge from "../components/Badge.svelte";
    import HorizontalResizer from "../components/HorizontalResizer.svelte";
    import Pane from "../components/Pane.svelte";
    import PaneContent from "../components/PaneContent.svelte";
    import { ResizablePane } from "../components/types";
    import { bridgeCommand } from "../lib/bridgecommand";
    import { TagEditor } from "../tag-editor";
    import TagAddButton from "../tag-editor/tag-options-button/TagAddButton.svelte";
    import { ChangeTimer } from "./change-timer";
    import { clearableArray } from "./destroyable";
    import DuplicateLink from "./DuplicateLink.svelte";
    import EditorToolbar from "./editor-toolbar";
    import type { FieldData } from "./EditorField.svelte";
    import EditorField from "./EditorField.svelte";
    import FieldDescription from "./FieldDescription.svelte";
    import Fields from "./Fields.svelte";
    import { alertIcon } from "./icons";
    import ImageOverlay from "./image-overlay";
    import { shrinkImagesByDefault } from "./image-overlay/ImageOverlay.svelte";
    import MathjaxOverlay from "./mathjax-overlay";
    import Notification from "./Notification.svelte";
    import PlainTextInput from "./plain-text-input";
    import { closeHTMLTags } from "./plain-text-input/PlainTextInput.svelte";
    import PlainTextBadge from "./PlainTextBadge.svelte";
    import RichTextInput, { editingInputIsRichText } from "./rich-text-input";
    import RichTextBadge from "./RichTextBadge.svelte";
    import SymbolsOverlay from "./symbols-overlay";

    function quoteFontFamily(fontFamily: string): string {
        // generic families (e.g. sans-serif) must not be quoted
        if (!/^[-a-z]+$/.test(fontFamily)) {
            fontFamily = `"${fontFamily}"`;
        }
        return fontFamily;
    }

    const size = 1.5;
    const wrap = true;

    const fieldStores: Writable<string>[] = [];
    let fieldNames: string[] = [];
    export function setFields(fs: [string, string][]): void {
        // this is a bit of a mess -- when moving to Rust calls, we should make
        // sure to have two backend endpoints for:
        // * the note, which can be set through this view
        // * the fieldname, font, etc., which cannot be set

        const newFieldNames: string[] = [];

        for (const [index, [fieldName]] of fs.entries()) {
            newFieldNames[index] = fieldName;
        }

        for (let i = fieldStores.length; i < newFieldNames.length; i++) {
            const newStore = writable("");
            fieldStores[i] = newStore;
            newStore.subscribe((value) => updateField(i, value));
        }

        for (
            let i = fieldStores.length;
            i > newFieldNames.length;
            i = fieldStores.length
        ) {
            fieldStores.pop();
        }

        for (const [index, [, fieldContent]] of fs.entries()) {
            fieldStores[index].set(fieldContent);
        }

        fieldNames = newFieldNames;
    }

    let fieldsCollapsed: boolean[] = [];
    export function setCollapsed(fs: boolean[]): void {
        fieldsCollapsed = fs;
    }

    let richTextsHidden: boolean[] = [];
    let plainTextsHidden: boolean[] = [];
    let plainTextDefaults: boolean[] = [];

    export function setPlainTexts(fs: boolean[]): void {
        richTextsHidden = fs;
        plainTextsHidden = Array.from(fs, (v) => !v);
        plainTextDefaults = [...richTextsHidden];
    }

    function setMathjaxEnabled(enabled: boolean): void {
        mathjaxConfig.enabled = enabled;
    }

    let fieldDescriptions: string[] = [];
    export function setDescriptions(fs: string[]): void {
        fieldDescriptions = fs;
    }

    let fonts: [string, number, boolean][] = [];

    const fields = clearableArray<EditorFieldAPI>();

    export function setFonts(fs: [string, number, boolean][]): void {
        fonts = fs;
    }

    export function focusField(index: number | null): void {
        tick().then(() => {
            if (typeof index === "number") {
                if (!(index in fields)) {
                    return;
                }

                fields[index].editingArea?.refocus();
            } else {
                $focusedInput?.refocus();
            }
        });
    }

    const tags = writable<string[]>([]);
    export function setTags(ts: string[]): void {
        $tags = ts;
    }

    const tagsCollapsed = writable<boolean>();
    export function setTagsCollapsed(collapsed: boolean): void {
        $tagsCollapsed = collapsed;
        if (collapsed) {
            lowerResizer.move([tagsPane, fieldsPane], tagsPane.minHeight);
        }
    }

    let noteId: number | null = null;
    export function setNoteId(ntid: number): void {
        // TODO this is a hack, because it requires the NoteEditor to know implementation details of the PlainTextInput.
        // It should be refactored once we work on our own Undo stack
        for (const pi of plainTextInputs) {
            pi.api.codeMirror.editor.then((editor) => editor.clearHistory());
        }
        noteId = ntid;
    }

    let insertSymbols = false;

    function setInsertSymbolsEnabled() {
        insertSymbols = true;
    }

    function getNoteId(): number | null {
        return noteId;
    }

    let cols: ("dupe" | "")[] = [];
    export function setBackgrounds(cls: ("dupe" | "")[]): void {
        cols = cls;
    }

    let hint: string = "";
    export function setClozeHint(hnt: string): void {
        hint = hnt;
    }

    $: fieldsData = fieldNames.map((name, index) => ({
        name,
        plainText: plainTextDefaults[index],
        description: fieldDescriptions[index],
        fontFamily: quoteFontFamily(fonts[index][0]),
        fontSize: fonts[index][1],
        direction: fonts[index][2] ? "rtl" : "ltr",
        collapsed: fieldsCollapsed[index],
    })) as FieldData[];

    function saveTags({ detail }: CustomEvent): void {
        tagAmount = detail.tags.filter((tag: string) => tag != "").length;
        bridgeCommand(`saveTags:${JSON.stringify(detail.tags)}`);
    }

    const fieldSave = new ChangeTimer();

    function transformContentBeforeSave(content: string): string {
        return content.replace(/ data-editor-shrink="(true|false)"/g, "");
    }

    function updateField(index: number, content: string): void {
        fieldSave.schedule(
            () =>
                bridgeCommand(
                    `key:${index}:${getNoteId()}:${transformContentBeforeSave(
                        content,
                    )}`,
                ),
            600,
        );
    }

    export function saveFieldNow(): void {
        /* this will always be a key save */
        fieldSave.fireImmediately();
    }

    export function saveOnPageHide() {
        if (document.visibilityState === "hidden") {
            // will fire on session close and minimize
            saveFieldNow();
        }
    }

    export function focusIfField(x: number, y: number): boolean {
        const elements = document.elementsFromPoint(x, y);
        const first = elements[0];

        if (first.shadowRoot) {
            const richTextInput = first.shadowRoot.lastElementChild! as HTMLElement;
            richTextInput.focus();
            return true;
        }

        return false;
    }

    let richTextInputs: RichTextInput[] = [];
    $: richTextInputs = richTextInputs.filter(Boolean);

    let plainTextInputs: PlainTextInput[] = [];
    $: plainTextInputs = plainTextInputs.filter(Boolean);

    const toolbar: Partial<EditorToolbarAPI> = {};

    function setShrinkImages(shrinkByDefault: boolean) {
        $shrinkImagesByDefault = shrinkByDefault;
    }

    function setCloseHTMLTags(closeTags: boolean) {
        $closeHTMLTags = closeTags;
    }

    import { mathjaxConfig } from "../editable/mathjax-element";
    import { wrapInternal } from "../lib/wrap";
    import { refocusInput } from "./helpers";
    import * as oldEditorAdapter from "./old-editor-adapter";

    onMount(() => {
        function wrap(before: string, after: string): void {
            if (!$focusedInput || !editingInputIsRichText($focusedInput)) {
                return;
            }

            $focusedInput.element.then((element) => {
                wrapInternal(element, before, after, false);
            });
        }

        Object.assign(globalThis, {
            setFields,
            setCollapsed,
            setPlainTexts,
            setDescriptions,
            setFonts,
            focusField,
            setTags,
            setTagsCollapsed,
            setBackgrounds,
            setClozeHint,
            saveNow: saveFieldNow,
            focusIfField,
            getNoteId,
            setNoteId,
            wrap,
            setMathjaxEnabled,
            setInsertSymbolsEnabled,
            setShrinkImages,
            setCloseHTMLTags,
            ...oldEditorAdapter,
        });

        document.addEventListener("visibilitychange", saveOnPageHide);
        return () => document.removeEventListener("visibilitychange", saveOnPageHide);
    });

    let apiPartial: Partial<NoteEditorAPI> = {};
    export { apiPartial as api };

    const hoveredField: NoteEditorAPI["hoveredField"] = writable(null);
    const focusedField: NoteEditorAPI["focusedField"] = writable(null);
    const focusedInput: NoteEditorAPI["focusedInput"] = writable(null);

    const api: NoteEditorAPI = {
        ...apiPartial,
        hoveredField,
        focusedField,
        focusedInput,
        toolbar: toolbar as EditorToolbarAPI,
        fields,
    };

    setContextProperty(api);
    setupLifecycleHooks(api);

    let clientHeight: number;

    const fieldsPane = new ResizablePane();
    const tagsPane = new ResizablePane();

    let lowerResizer: HorizontalResizer;
    let tagEditor: TagEditor;

    $: tagAmount = $tags.length;

    let snapTags = $tagsCollapsed;

    function collapseTags(): void {
        lowerResizer.move([tagsPane, fieldsPane], tagsPane.minHeight);
        $tagsCollapsed = snapTags = true;
    }

    function expandTags(): void {
        lowerResizer.move([tagsPane, fieldsPane], tagsPane.maxHeight);
        $tagsCollapsed = snapTags = false;
    }

    window.addEventListener("resize", () => snapResizer(snapTags));

    function snapResizer(collapse: boolean): void {
        if (collapse) {
            collapseTags();
            bridgeCommand("collapseTags");
        } else {
            expandTags();
            bridgeCommand("expandTags");
        }
    }
</script>

<!--
@component
Serves as a pre-slotted convenience component which combines all the common
components and functionality for general note editing.

Functionality exclusive to specifc note-editing views (e.g. in the browser or
the AddCards dialog) should be implemented in the user of this component.
-->
<div class="note-editor" bind:clientHeight>
    <EditorToolbar {size} {wrap} api={toolbar}>
        <slot slot="notetypeButtons" name="notetypeButtons" />
    </EditorToolbar>

    {#if hint}
        <Absolute bottom right --margin="10px">
            <Notification>
                <Badge --badge-color="tomato" --icon-align="top"
                    >{@html alertIcon}</Badge
                >
                <span>{@html hint}</span>
            </Notification>
        </Absolute>
    {/if}

    <Pane
        bind:this={fieldsPane.resizable}
        on:resize={(e) => {
            fieldsPane.height = e.detail.height;
        }}
    >
        <PaneContent>
            <Fields>
                {#each fieldsData as field, index}
                    {@const content = fieldStores[index]}

                    <EditorField
                        {field}
                        {content}
                        flipInputs={plainTextDefaults[index]}
                        api={fields[index]}
                        on:focusin={() => {
                            $focusedField = fields[index];
                            bridgeCommand(`focus:${index}`);
                        }}
                        on:focusout={() => {
                            $focusedField = null;
                            bridgeCommand(
                                `blur:${index}:${getNoteId()}:${transformContentBeforeSave(
                                    get(content),
                                )}`,
                            );
                        }}
                        on:mouseenter={() => {
                            $hoveredField = fields[index];
                        }}
                        on:mouseleave={() => {
                            $hoveredField = null;
                        }}
                        collapsed={fieldsCollapsed[index]}
                        dupe={cols[index] === "dupe"}
                    >
                        <svelte:fragment slot="field-label">
                            <LabelContainer
                                collapsed={fieldsCollapsed[index]}
                                on:toggle={async () => {
                                    fieldsCollapsed[index] = !fieldsCollapsed[index];

                                    const defaultInput = !plainTextDefaults[index]
                                        ? richTextInputs[index]
                                        : plainTextInputs[index];

                                    if (!fieldsCollapsed[index]) {
                                        refocusInput(defaultInput.api);
                                    } else if (!plainTextDefaults[index]) {
                                        plainTextsHidden[index] = true;
                                    } else {
                                        richTextsHidden[index] = true;
                                    }
                                }}
                            >
                                <svelte:fragment slot="field-name">
                                    <LabelName>
                                        {field.name}
                                    </LabelName>
                                </svelte:fragment>
                                <FieldState>
                                    {#if cols[index] === "dupe"}
                                        <DuplicateLink />
                                    {/if}
                                    {#if plainTextDefaults[index]}
                                        <RichTextBadge
                                            show={!fieldsCollapsed[index] &&
                                                (fields[index] === $hoveredField ||
                                                    fields[index] === $focusedField)}
                                            bind:off={richTextsHidden[index]}
                                            on:toggle={async () => {
                                                richTextsHidden[index] =
                                                    !richTextsHidden[index];

                                                if (!richTextsHidden[index]) {
                                                    refocusInput(
                                                        richTextInputs[index].api,
                                                    );
                                                }
                                            }}
                                        />
                                    {:else}
                                        <PlainTextBadge
                                            show={!fieldsCollapsed[index] &&
                                                (fields[index] === $hoveredField ||
                                                    fields[index] === $focusedField)}
                                            bind:off={plainTextsHidden[index]}
                                            on:toggle={async () => {
                                                plainTextsHidden[index] =
                                                    !plainTextsHidden[index];

                                                if (!plainTextsHidden[index]) {
                                                    refocusInput(
                                                        plainTextInputs[index].api,
                                                    );
                                                }
                                            }}
                                        />
                                    {/if}
                                    <slot
                                        name="field-state"
                                        {field}
                                        {index}
                                        show={fields[index] === $hoveredField ||
                                            fields[index] === $focusedField}
                                    />
                                </FieldState>
                            </LabelContainer>
                        </svelte:fragment>
                        <svelte:fragment slot="rich-text-input">
                            <Collapsible
                                collapse={richTextsHidden[index]}
                                let:collapsed={hidden}
                                toggleDisplay
                            >
                                <RichTextInput
                                    {hidden}
                                    on:focusout={() => {
                                        saveFieldNow();
                                        $focusedInput = null;
                                    }}
                                    bind:this={richTextInputs[index]}
                                >
                                    <FieldDescription>
                                        {field.description}
                                    </FieldDescription>
                                </RichTextInput>
                            </Collapsible>
                        </svelte:fragment>
                        <svelte:fragment slot="plain-text-input">
                            <Collapsible
                                collapse={plainTextsHidden[index]}
                                let:collapsed={hidden}
                                toggleDisplay
                            >
                                <PlainTextInput
                                    {hidden}
                                    on:focusout={() => {
                                        saveFieldNow();
                                        $focusedInput = null;
                                    }}
                                    bind:this={plainTextInputs[index]}
                                />
                            </Collapsible>
                        </svelte:fragment>
                    </EditorField>
                {/each}

                <MathjaxOverlay />
                <ImageOverlay maxWidth={250} maxHeight={125} />
                {#if insertSymbols}
                    <SymbolsOverlay />
                {/if}
            </Fields>
        </PaneContent>
    </Pane>

    <HorizontalResizer
        panes={[fieldsPane, tagsPane]}
        showIndicator={$tagsCollapsed || snapTags}
        tip={`Double click to ${$tagsCollapsed ? "expand" : "collapse"} tag editor`}
        {clientHeight}
        bind:this={lowerResizer}
        on:dblclick={() => snapResizer(!$tagsCollapsed)}
        on:release={() => {
            snapResizer(snapTags);
        }}
    >
        <div class="tags-expander">
            <TagAddButton
                on:tagappend={() => {
                    tagEditor.appendEmptyTag();
                }}
                keyCombination="Control+Shift+T"
            >
                {@html tagAmount > 0 ? `${tagAmount} Tags` : ""}
            </TagAddButton>
        </div>
    </HorizontalResizer>

    <Pane
        bind:this={tagsPane.resizable}
        on:resize={(e) => {
            tagsPane.height = e.detail.height;
            if (tagsPane.maxHeight > 0) {
                snapTags = tagsPane.height < tagsPane.maxHeight / 2;
            }
        }}
        --opacity={(() => {
            if (!$tagsCollapsed) {
                return 1;
            } else {
                return snapTags ? tagsPane.height / tagsPane.maxHeight : 1;
            }
        })()}
    >
        <PaneContent scroll={false}>
            <TagEditor
                {tags}
                --button-opacity={snapTags ? 0 : 1}
                bind:this={tagEditor}
                on:tagsupdate={saveTags}
                on:tagsFocused={() => {
                    expandTags();
                    $tagsCollapsed = false;
                }}
                on:heightChange={(e) => {
                    tagsPane.maxHeight = e.detail.height;
                    if (!$tagsCollapsed) {
                        expandTags();
                    }
                }}
            />
        </PaneContent>
    </Pane>
</div>

<style lang="scss">
    .note-editor {
        display: flex;
        flex-direction: column;
        height: 100%;
    }
</style>