@ni/nimble-components 20.1.10 → 20.1.11

package/dist/esm/rich-text-editor/testing/rich-text-editor.pageobject.js

@@ -0,0 +1,143 @@
+import { keySpace, keyEnter, keyTab } from '@microsoft/fast-web-utilities';
+import { waitForUpdatesAsync } from '../../testing/async-helpers';
+/**
+ * Page object for the `nimble-rich-text-editor` component.
+ */
+export class RichTextEditorPageObject {
+    constructor(richTextEditorElement) {
+        this.richTextEditorElement = richTextEditorElement;
+    }
+    editorSectionHasChildNodes() {
+        const editorSection = this.getEditorSection();
+        return editorSection.hasChildNodes();
+    }
+    getEditorSectionFirstElementChildClassName() {
+        const editorSection = this.getEditorSection();
+        return editorSection.firstElementChild.className;
+    }
+    async clickEditorShortcutKeys(shortcutKey, isShiftKey) {
+        const editor = this.getTiptapEditor();
+        const event = new KeyboardEvent('keydown', {
+            key: shortcutKey,
+            ctrlKey: true,
+            shiftKey: isShiftKey,
+            bubbles: true,
+            cancelable: true
+        });
+        editor.dispatchEvent(event);
+        await waitForUpdatesAsync();
+    }
+    async pressEnterKeyInEditor() {
+        const editor = this.getTiptapEditor();
+        const event = new KeyboardEvent('keydown', {
+            key: keyEnter,
+            bubbles: true,
+            cancelable: true
+        });
+        editor.dispatchEvent(event);
+        await waitForUpdatesAsync();
+    }
+    async pressTabKeyInEditor() {
+        const editor = this.getTiptapEditor();
+        const event = new KeyboardEvent('keydown', {
+            key: keyTab,
+            bubbles: true,
+            cancelable: true
+        });
+        editor.dispatchEvent(event);
+        await waitForUpdatesAsync();
+    }
+    async pressShiftTabKeysInEditor() {
+        const editor = this.getTiptapEditor();
+        const shiftTabEvent = new KeyboardEvent('keydown', {
+            key: keyTab,
+            shiftKey: true,
+            bubbles: true,
+            cancelable: true
+        });
+        editor.dispatchEvent(shiftTabEvent);
+        await waitForUpdatesAsync();
+    }
+    /**
+     * To click a formatting button in the footer section, pass its position value as an index (starting from '0')
+     * @param buttonIndex can be imported from an enum for each button using the `ButtonIndex`.
+     */
+    async clickFooterButton(buttonIndex) {
+        const button = this.getFormattingButton(buttonIndex);
+        button.click();
+        await waitForUpdatesAsync();
+    }
+    /**
+     * To retrieve the checked state of the button, provide its position value as an index (starting from '0')
+     * @param buttonIndex can be imported from an enum for each button using the `ButtonIndex`.
+     */
+    getButtonCheckedState(buttonIndex) {
+        const button = this.getFormattingButton(buttonIndex);
+        return button.checked;
+    }
+    /**
+     * To retrieve the tab index of the button, provide its position value as an index (starting from '0')
+     * @param buttonIndex can be imported from an enum for each button using the `ButtonIndex`.
+     */
+    getButtonTabIndex(buttonIndex) {
+        const button = this.getFormattingButton(buttonIndex);
+        return button.tabIndex;
+    }
+    /**
+     * To trigger a space key press for the button, provide its position value as an index (starting from '0')
+     * @param buttonIndex can be imported from an enum for each button using the `ButtonIndex`.
+     */
+    spaceKeyActivatesButton(buttonIndex) {
+        const button = this.getFormattingButton(buttonIndex);
+        const event = new KeyboardEvent('keypress', {
+            key: keySpace
+        });
+        button.control.dispatchEvent(event);
+    }
+    /**
+     * To trigger a enter key press for the button, provide its position value as an index (starting from '0')
+     * @param buttonIndex can be imported from an enum for each button using the `ButtonIndex`.
+     */
+    enterKeyActivatesButton(buttonIndex) {
+        const button = this.getFormattingButton(buttonIndex);
+        const event = new KeyboardEvent('keypress', {
+            key: keyEnter
+        });
+        button.control.dispatchEvent(event);
+    }
+    async setEditorTextContent(value) {
+        let lastElement = this.getTiptapEditor()?.lastElementChild;
+        while (lastElement?.lastElementChild) {
+            lastElement = lastElement?.lastElementChild;
+        }
+        lastElement.parentElement.textContent = value;
+        await waitForUpdatesAsync();
+    }
+    getEditorFirstChildTagName() {
+        return this.getTiptapEditor()?.firstElementChild?.tagName ?? '';
+    }
+    getEditorFirstChildTextContent() {
+        return this.getTiptapEditor()?.firstElementChild?.textContent ?? '';
+    }
+    getEditorTagNames() {
+        return Array.from(this.getTiptapEditor().querySelectorAll('*')).map(el => el.tagName);
+    }
+    getEditorLeafContents() {
+        return Array.from(this.getTiptapEditor().querySelectorAll('*'))
+            .filter((el, _) => {
+            return el.children.length === 0;
+        })
+            .map(el => el.textContent || '');
+    }
+    getEditorSection() {
+        return this.richTextEditorElement.shadowRoot?.querySelector('.editor');
+    }
+    getTiptapEditor() {
+        return this.richTextEditorElement.shadowRoot?.querySelector('.ProseMirror');
+    }
+    getFormattingButton(index) {
+        const buttons = this.richTextEditorElement.shadowRoot.querySelectorAll('nimble-toggle-button');
+        return buttons[index];
+    }
+}
+//# sourceMappingURL=rich-text-editor.pageobject.js.map

package/dist/esm/rich-text-editor/testing/rich-text-editor.pageobject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rich-text-editor.pageobject.js","sourceRoot":"","sources":["../../../../src/rich-text-editor/testing/rich-text-editor.pageobject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAE3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAGlE;;GAEG;AACH,MAAM,OAAO,wBAAwB;IACjC,YACqB,qBAAqC;QAArC,0BAAqB,GAArB,qBAAqB,CAAgB;IACvD,CAAC;IAEG,0BAA0B;QAC7B,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC9C,OAAO,aAAc,CAAC,aAAa,EAAE,CAAC;IAC1C,CAAC;IAEM,0CAA0C;QAC7C,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC9C,OAAO,aAAc,CAAC,iBAAkB,CAAC,SAAS,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAChC,WAAmB,EACnB,UAAmB;QAEnB,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE;YACvC,GAAG,EAAE,WAAW;YAChB,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,UAAU;YACpB,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QACH,MAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC7B,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,qBAAqB;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE;YACvC,GAAG,EAAE,QAAQ;YACb,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QACH,MAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC7B,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,mBAAmB;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE;YACvC,GAAG,EAAE,MAAM;YACX,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QACH,MAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC7B,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,yBAAyB;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACtC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE;YAC/C,GAAG,EAAE,MAAM;YACX,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QACH,MAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACrC,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,iBAAiB,CAAC,WAAmB;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACrD,MAAO,CAAC,KAAK,EAAE,CAAC;QAChB,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,qBAAqB,CAAC,WAAmB;QAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACrD,OAAO,MAAO,CAAC,OAAO,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,WAAmB;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QACrD,OAAO,MAAO,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,uBAAuB,CAAC,WAAmB;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAE,CAAC;QACtD,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,UAAU,EAAE;YACxC,GAAG,EAAE,QAAQ;SACK,CAAC,CAAC;QACxB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,uBAAuB,CAAC,WAAmB;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAE,CAAC;QACtD,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,UAAU,EAAE;YACxC,GAAG,EAAE,QAAQ;SACK,CAAC,CAAC;QACxB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,KAAa;QAC3C,IAAI,WAAW,GAAG,IAAI,CAAC,eAAe,EAAE,EAAE,gBAAgB,CAAC;QAE3D,OAAO,WAAW,EAAE,gBAAgB,EAAE;YAClC,WAAW,GAAG,WAAW,EAAE,gBAAgB,CAAC;SAC/C;QACD,WAAY,CAAC,aAAc,CAAC,WAAW,GAAG,KAAK,CAAC;QAChD,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC;IAEM,0BAA0B;QAC7B,OAAO,IAAI,CAAC,eAAe,EAAE,EAAE,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;IACpE,CAAC;IAEM,8BAA8B;QACjC,OAAO,IAAI,CAAC,eAAe,EAAE,EAAE,iBAAiB,EAAE,WAAW,IAAI,EAAE,CAAC;IACxE,CAAC;IAEM,iBAAiB;QACpB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAChE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CACnB,CAAC;IACN,CAAC;IAEM,qBAAqB;QACxB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;aAC3D,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;YACd,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC;QACpC,CAAC,CAAC;aACD,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAEO,gBAAgB;QACpB,OAAO,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;IAEO,eAAe;QACnB,OAAO,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,aAAa,CACvD,cAAc,CACjB,CAAC;IACN,CAAC;IAEO,mBAAmB,CACvB,KAAa;QAEb,MAAM,OAAO,GAA6B,IAAI,CAAC,qBAAqB,CAAC,UAAW,CAAC,gBAAgB,CAC7F,sBAAsB,CACzB,CAAC;QACF,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;CACJ"}

package/dist/esm/rich-text-editor/testing/types.d.ts

@@ -0,0 +1,7 @@
+export declare const ToolbarButton: {
+    readonly bold: 0;
+    readonly italics: 1;
+    readonly bulletList: 2;
+    readonly numberedList: 3;
+};
+export declare type ToolbarButton = (typeof ToolbarButton)[keyof typeof ToolbarButton];

package/dist/esm/rich-text-editor/testing/types.js

@@ -0,0 +1,7 @@
+export const ToolbarButton = {
+    bold: 0,
+    italics: 1,
+    bulletList: 2,
+    numberedList: 3
+};
+//# sourceMappingURL=types.js.map

package/dist/esm/rich-text-editor/testing/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/rich-text-editor/testing/types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,aAAa,GAAG;IACzB,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,CAAC;IACV,UAAU,EAAE,CAAC;IACb,YAAY,EAAE,CAAC;CACT,CAAC"}

package/dist/esm/rich-text-viewer/testing/rich-text-viewer.pageobject.d.ts

@@ -12,6 +12,10 @@ export declare class RichTextViewerPageObject {
      * @returns An array of tag names in document order
      */
     getRenderedMarkdownTagNames(): string[];
+    /**
+     * @returns An array of tag names with the closing tags (eg: '/P') in a document order
+     */
+    getRenderedMarkdownTagNamesWithClosingTags(): string[];
     /**
      * Retrieves text contents for the rendered markdown content in document order
      * @returns An array of text contents of last elements in a tree

package/dist/esm/rich-text-viewer/testing/rich-text-viewer.pageobject.js

@@ -18,6 +18,25 @@ export class RichTextViewerPageObject {
     getRenderedMarkdownTagNames() {
         return Array.from(this.getMarkdownRenderedElement().querySelectorAll('*')).map(el => el.tagName);
     }
+    /**
+     * @returns An array of tag names with the closing tags (eg: '/P') in a document order
+     */
+    getRenderedMarkdownTagNamesWithClosingTags() {
+        const tagNames = [];
+        const renderedElement = this.getMarkdownRenderedElement();
+        const processNode = (node) => {
+            if (node.nodeType === Node.ELEMENT_NODE) {
+                const el = node;
+                tagNames.push(el.tagName);
+                el.childNodes.forEach(processNode);
+                tagNames.push(`/${el.tagName}`);
+            }
+        };
+        if (renderedElement) {
+            processNode(renderedElement);
+        }
+        return tagNames.slice(1, -1);
+    }
     /**
      * Retrieves text contents for the rendered markdown content in document order
      * @returns An array of text contents of last elements in a tree

package/dist/esm/rich-text-viewer/testing/rich-text-viewer.pageobject.js.map

@@ -1 +1 @@
-{"version":3,"file":"rich-text-viewer.pageobject.js","sourceRoot":"","sources":["../../../../src/rich-text-viewer/testing/rich-text-viewer.pageobject.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,wBAAwB;IACjC,YACqB,qBAAqC;QAArC,0BAAqB,GAArB,qBAAqB,CAAgB;IACvD,CAAC;IAEG,oCAAoC;QACvC,OAAO,IAAI,CAAC,mCAAmC,EAAE,EAAE,WAAW,IAAI,EAAE,CAAC;IACzE,CAAC;IAEM,qCAAqC,CAAC,SAAiB;QAC1D,OAAO,CACH,IAAI,CAAC,mCAAmC,EAAE,EAAE,YAAY,CACpD,SAAS,CACZ,IAAI,EAAE,CACV,CAAC;IACN,CAAC;IAED;;;OAGG;IACI,2BAA2B;QAC9B,OAAO,KAAK,CAAC,IAAI,CACb,IAAI,CAAC,0BAA0B,EAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAC3D,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,+BAA+B;QAClC,OAAO,KAAK,CAAC,IAAI,CACb,IAAI,CAAC,0BAA0B,EAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAC3D;aACI,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;YACd,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC;QACpC,CAAC,CAAC;aACD,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAEO,0BAA0B;QAC9B,OAAO,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;IAEO,mCAAmC;QACvC,IAAI,WAAW,GAAG,IAAI,CAAC,0BAA0B,EAAE,EAAE,gBAAgB,CAAC;QAEtE,OAAO,WAAW,EAAE,gBAAgB,EAAE;YAClC,WAAW,GAAG,WAAW,EAAE,gBAAgB,CAAC;SAC/C;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;CACJ"}
+{"version":3,"file":"rich-text-viewer.pageobject.js","sourceRoot":"","sources":["../../../../src/rich-text-viewer/testing/rich-text-viewer.pageobject.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,wBAAwB;IACjC,YACqB,qBAAqC;QAArC,0BAAqB,GAArB,qBAAqB,CAAgB;IACvD,CAAC;IAEG,oCAAoC;QACvC,OAAO,IAAI,CAAC,mCAAmC,EAAE,EAAE,WAAW,IAAI,EAAE,CAAC;IACzE,CAAC;IAEM,qCAAqC,CAAC,SAAiB;QAC1D,OAAO,CACH,IAAI,CAAC,mCAAmC,EAAE,EAAE,YAAY,CACpD,SAAS,CACZ,IAAI,EAAE,CACV,CAAC;IACN,CAAC;IAED;;;OAGG;IACI,2BAA2B;QAC9B,OAAO,KAAK,CAAC,IAAI,CACb,IAAI,CAAC,0BAA0B,EAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAC3D,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,0CAA0C;QAC7C,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,eAAe,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAE1D,MAAM,WAAW,GAAG,CAAC,IAAU,EAAQ,EAAE;YACrC,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,YAAY,EAAE;gBACrC,MAAM,EAAE,GAAG,IAAe,CAAC;gBAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;gBAE1B,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBAEnC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;aACnC;QACL,CAAC,CAAC;QAEF,IAAI,eAAe,EAAE;YACjB,WAAW,CAAC,eAAe,CAAC,CAAC;SAChC;QAED,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,+BAA+B;QAClC,OAAO,KAAK,CAAC,IAAI,CACb,IAAI,CAAC,0BAA0B,EAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAC3D;aACI,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;YACd,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC;QACpC,CAAC,CAAC;aACD,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAEO,0BAA0B;QAC9B,OAAO,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;IAEO,mCAAmC;QACvC,IAAI,WAAW,GAAG,IAAI,CAAC,0BAA0B,EAAE,EAAE,gBAAgB,CAAC;QAEtE,OAAO,WAAW,EAAE,gBAAgB,EAAE;YAClC,WAAW,GAAG,WAAW,EAAE,gBAAgB,CAAC;SAC/C;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;CACJ"}

package/dist/esm/src/rich-text-editor/index.d.ts

@@ -1,4 +1,5 @@
 import { FoundationElement } from '@microsoft/fast-foundation';
+import type { ToggleButton } from '../toggle-button';
 declare global {
     interface HTMLElementTagNameMap {
         'nimble-rich-text-editor': RichTextEditor;
@@ -8,5 +9,88 @@ declare global {
  * A nimble styled rich text editor
  */
 export declare class RichTextEditor extends FoundationElement {
+    /**
+     * @internal
+     */
+    boldButton: ToggleButton;
+    /**
+     * @internal
+     */
+    italicsButton: ToggleButton;
+    /**
+     * @internal
+     */
+    bulletListButton: ToggleButton;
+    /**
+     * @internal
+     */
+    numberedListButton: ToggleButton;
+    /**
+     * @internal
+     */
+    editor: HTMLDivElement;
+    private tiptapEditor;
+    /**
+     * @internal
+     */
+    connectedCallback(): void;
+    /**
+     * @internal
+     */
+    disconnectedCallback(): void;
+    /**
+     * Toggle the bold mark and focus back to the editor
+     * @internal
+     */
+    boldButtonClick(): void;
+    /**
+     * Toggle the bold mark and focus back to the editor
+     * @internal
+     */
+    boldButtonKeyDown(event: KeyboardEvent): boolean;
+    /**
+     * Toggle the italics mark and focus back to the editor
+     * @internal
+     */
+    italicsButtonClick(): void;
+    /**
+     * Toggle the italics mark and focus back to the editor
+     * @internal
+     */
+    italicsButtonKeyDown(event: KeyboardEvent): boolean;
+    /**
+     * Toggle the unordered list node and focus back to the editor
+     * @internal
+     */
+    bulletListButtonClick(): void;
+    /**
+     * Toggle the unordered list node and focus back to the editor
+     * @internal
+     */
+    bulletListButtonKeyDown(event: KeyboardEvent): boolean;
+    /**
+     * Toggle the ordered list node and focus back to the editor
+     * @internal
+     */
+    numberedListButtonClick(): void;
+    /**
+     * Toggle the ordered list node and focus back to the editor
+     * @internal
+     */
+    numberedListButtonKeyDown(event: KeyboardEvent): boolean;
+    /**
+     * @internal
+     */
+    stopEventPropagation(event: Event): boolean;
+    private initializeEditor;
+    /**
+     * Binding the "transaction" event to the editor allows continuous monitoring the events and updating the button state in response to
+     * various actions such as mouse events, keyboard events, changes in the editor content etc,.
+     * https://tiptap.dev/api/events#transaction
+     */
+    private bindEditorTransactionEvent;
+    private unbindEditorTransactionEvent;
+    private updateEditorButtonsState;
+    private keyActivatesButton;
 }
 export declare const richTextEditorTag: string;

package/dist/esm/src/rich-text-editor/testing/rich-text-editor.pageobject.d.ts

@@ -0,0 +1,47 @@
+import type { RichTextEditor } from '..';
+/**
+ * Page object for the `nimble-rich-text-editor` component.
+ */
+export declare class RichTextEditorPageObject {
+    private readonly richTextEditorElement;
+    constructor(richTextEditorElement: RichTextEditor);
+    editorSectionHasChildNodes(): boolean;
+    getEditorSectionFirstElementChildClassName(): string;
+    clickEditorShortcutKeys(shortcutKey: string, isShiftKey: boolean): Promise<void>;
+    pressEnterKeyInEditor(): Promise<void>;
+    pressTabKeyInEditor(): Promise<void>;
+    pressShiftTabKeysInEditor(): Promise<void>;
+    /**
+     * To click a formatting button in the footer section, pass its position value as an index (starting from '0')
+     * @param buttonIndex can be imported from an enum for each button using the `ButtonIndex`.
+     */
+    clickFooterButton(buttonIndex: number): Promise<void>;
+    /**
+     * To retrieve the checked state of the button, provide its position value as an index (starting from '0')
+     * @param buttonIndex can be imported from an enum for each button using the `ButtonIndex`.
+     */
+    getButtonCheckedState(buttonIndex: number): boolean;
+    /**
+     * To retrieve the tab index of the button, provide its position value as an index (starting from '0')
+     * @param buttonIndex can be imported from an enum for each button using the `ButtonIndex`.
+     */
+    getButtonTabIndex(buttonIndex: number): number;
+    /**
+     * To trigger a space key press for the button, provide its position value as an index (starting from '0')
+     * @param buttonIndex can be imported from an enum for each button using the `ButtonIndex`.
+     */
+    spaceKeyActivatesButton(buttonIndex: number): void;
+    /**
+     * To trigger a enter key press for the button, provide its position value as an index (starting from '0')
+     * @param buttonIndex can be imported from an enum for each button using the `ButtonIndex`.
+     */
+    enterKeyActivatesButton(buttonIndex: number): void;
+    setEditorTextContent(value: string): Promise<void>;
+    getEditorFirstChildTagName(): string;
+    getEditorFirstChildTextContent(): string;
+    getEditorTagNames(): string[];
+    getEditorLeafContents(): string[];
+    private getEditorSection;
+    private getTiptapEditor;
+    private getFormattingButton;
+}

package/dist/esm/src/rich-text-editor/testing/types.d.ts

@@ -0,0 +1,7 @@
+export declare const ToolbarButton: {
+    readonly bold: 0;
+    readonly italics: 1;
+    readonly bulletList: 2;
+    readonly numberedList: 3;
+};
+export declare type ToolbarButton = (typeof ToolbarButton)[keyof typeof ToolbarButton];

package/dist/esm/src/rich-text-viewer/testing/rich-text-viewer.pageobject.d.ts

@@ -12,6 +12,10 @@ export declare class RichTextViewerPageObject {
      * @returns An array of tag names in document order
      */
     getRenderedMarkdownTagNames(): string[];
+    /**
+     * @returns An array of tag names with the closing tags (eg: '/P') in a document order
+     */
+    getRenderedMarkdownTagNamesWithClosingTags(): string[];
     /**
      * Retrieves text contents for the rendered markdown content in document order
      * @returns An array of text contents of last elements in a tree

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ni/nimble-components",
-  "version": "20.1.10",
+  "version": "20.1.11",
   "description": "Styled web components for the NI Nimble Design System",
   "scripts": {
     "build": "npm run generate-icons && npm run build-components && npm run bundle-components && npm run generate-scss && npm run build-storybook",
@@ -64,6 +64,16 @@
     "@ni/nimble-tokens": "^6.3.0",
     "@tanstack/table-core": "^8.9.3",
     "@tanstack/virtual-core": "^3.0.0-beta.44",
+    "@tiptap/core": "^2.0.4",
+    "@tiptap/extension-bold": "^2.0.4",
+    "@tiptap/extension-bullet-list": "^2.0.4",
+    "@tiptap/extension-document": "^2.0.4",
+    "@tiptap/extension-history": "^2.0.4",
+    "@tiptap/extension-italic": "^2.0.4",
+    "@tiptap/extension-list-item": "^2.0.4",
+    "@tiptap/extension-ordered-list": "^2.0.4",
+    "@tiptap/extension-paragraph": "^2.0.4",
+    "@tiptap/extension-text": "^2.0.4",
     "@types/d3-array": "^3.0.4",
     "@types/d3-random": "^3.0.1",
     "@types/d3-scale": "^4.0.2",