@ni/nimble-components 20.5.1 → 20.5.3

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

@@ -1,213 +0,0 @@
-import { ARIAGlobalStatesAndProperties, FoundationElement } from '@microsoft/fast-foundation';
-import { Editor } from '@tiptap/core';
-import type { ToggleButton } from '../../toggle-button';
-import type { ErrorPattern } from '../../patterns/error/types';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-rich-text-editor': RichTextEditor;
-    }
-}
-/**
- * A nimble styled rich text editor
- */
-export declare class RichTextEditor extends FoundationElement implements ErrorPattern {
-    /**
-     * @internal
-     */
-    editor: HTMLDivElement;
-    /**
-     * @internal
-     */
-    tiptapEditor: Editor;
-    /**
-     * Whether to disable user from editing and interacting with toolbar buttons
-     *
-     * @public
-     * HTML Attribute: disabled
-     */
-    disabled: boolean;
-    /**
-     * Whether to hide the footer of the rich text editor
-     *
-     * @public
-     * HTML Attribute: footer-hidden
-     */
-    footerHidden: boolean;
-    /**
-     * Whether to display the error state.
-     *
-     * @public
-     * HTML Attribute: error-visible
-     */
-    errorVisible: boolean;
-    /**
-     * A message explaining why the value is invalid.
-     *
-     * @public
-     * HTML Attribute: error-text
-     */
-    errorText?: string;
-    /**
-     * @public
-     * HTML Attribute: placeholder
-     */
-    placeholder?: string;
-    /**
-     * True if the editor is empty or contains only whitespace, false otherwise.
-     *
-     * @public
-     */
-    get empty(): boolean;
-    /**
-     * @internal
-     */
-    boldButton: ToggleButton;
-    /**
-     * @internal
-     */
-    italicsButton: ToggleButton;
-    /**
-     * @internal
-     */
-    bulletListButton: ToggleButton;
-    /**
-     * @internal
-     */
-    numberedListButton: ToggleButton;
-    /**
-     * The width of the vertical scrollbar, if displayed.
-     * @internal
-     */
-    scrollbarWidth: number;
-    /**
-     * @internal
-     */
-    editorContainer: HTMLDivElement;
-    private resizeObserver?;
-    private updateScrollbarWidthQueued;
-    private readonly xmlSerializer;
-    /**
-     * @internal
-     */
-    connectedCallback(): void;
-    /**
-     * @internal
-     */
-    disconnectedCallback(): void;
-    /**
-     * @internal
-     */
-    disabledChanged(): void;
-    /**
-     * Update the placeholder text and view of the editor.
-     * @internal
-     */
-    placeholderChanged(): void;
-    /**
-     * @internal
-     */
-    ariaLabelChanged(): 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;
-    /**
-     * This function load tip tap editor with provided markdown content by parsing into html
-     * @public
-     */
-    setMarkdown(markdown: string): void;
-    /**
-     * This function returns markdown string by serializing tiptap editor document using prosemirror MarkdownSerializer
-     * @public
-     */
-    getMarkdown(): string;
-    /**
-     * @internal
-     */
-    stopEventPropagation(event: Event): boolean;
-    private createEditor;
-    private createTiptapEditor;
-    /**
-     * Extending the default link mark schema defined in the TipTap.
-     *
-     * "excludes": https://prosemirror.net/docs/ref/#model.MarkSpec.excludes
-     * "inclusive": https://prosemirror.net/docs/ref/#model.MarkSpec.inclusive
-     * "parseHTML": https://tiptap.dev/guide/custom-extensions#parse-html
-     * "renderHTML": https://tiptap.dev/guide/custom-extensions/#render-html
-     */
-    private getCustomLinkExtension;
-    /**
-     * This function takes the Fragment from parseMarkdownToDOM function and return the serialized string using XMLSerializer
-     */
-    private getHtmlContent;
-    /**
-     * 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;
-    private unbindEditorUpdateEvent;
-    /**
-     * input event is fired when there is a change in the content of the editor.
-     *
-     * https://tiptap.dev/api/events#update
-     */
-    private bindEditorUpdateEvent;
-    /**
-     * Stopping the native input event propagation emitted by the contenteditable element in the Tiptap
-     * since there is an issue (linked below) in ProseMirror where selecting the text and removing it
-     * does not trigger the native HTMLElement input event. So using the "update" event emitted by the
-     * Tiptap to capture it as an "input" customEvent in the rich text editor.
-     *
-     * Prose Mirror issue: https://discuss.prosemirror.net/t/how-to-handle-select-backspace-delete-cut-type-kind-of-events-handletextinput-or-handledomevents-input-doesnt-help/4844
-     */
-    private stopNativeInputEventPropagation;
-    private unbindNativeInputEvent;
-    private queueUpdateScrollbarWidth;
-    private updateScrollbarWidth;
-    private onResize;
-    private getTipTapExtension;
-    private setEditorTabIndex;
-}
-export interface RichTextEditor extends ARIAGlobalStatesAndProperties {
-}
-export declare const richTextEditorTag: string;

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

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

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

@@ -1,2 +0,0 @@
-import type { RichTextEditor } from '.';
-export declare const template: import("@microsoft/fast-element").ViewTemplate<RichTextEditor, any>;

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

@@ -1,44 +0,0 @@
-import type { RichTextEditor } from '..';
-import type { ToolbarButton } from './types';
-/**
- * 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>;
-    pressShiftEnterKeysInEditor(): Promise<void>;
-    pressTabKeyInEditor(): Promise<void>;
-    pressShiftTabKeysInEditor(): Promise<void>;
-    clickFooterButton(button: ToolbarButton): Promise<void>;
-    getButtonCheckedState(button: ToolbarButton): boolean;
-    getButtonTabIndex(button: ToolbarButton): number;
-    spaceKeyActivatesButton(button: ToolbarButton): void;
-    enterKeyActivatesButton(button: ToolbarButton): void;
-    pasteToEditor(text: string): void;
-    setEditorTextContent(value: string): Promise<void>;
-    replaceEditorContent(value: string): Promise<void>;
-    getEditorLastChildAttribute(attribute: string): string;
-    getEditorFirstChildTagName(): string;
-    getEditorFirstChildTextContent(): string;
-    getEditorTagNames(): string[];
-    getEditorLeafContents(): string[];
-    getEditorTagNamesWithClosingTags(): string[];
-    getFormattingButtonTextContent(toolbarButton: ToolbarButton): string;
-    getFormattingButtonTitle(toolbarButton: ToolbarButton): string;
-    isRichTextEditorActiveElement(): boolean;
-    getEditorTabIndex(): string;
-    setFooterHidden(footerHidden: boolean): Promise<void>;
-    isFooterHidden(): boolean;
-    setDisabled(disabled: boolean): Promise<void>;
-    isButtonDisabled(button: ToolbarButton): boolean;
-    getPlaceholderValue(): string;
-    private getEditorSection;
-    private getFooter;
-    private getTiptapEditor;
-    private getFormattingButton;
-    private getEditorLastChildElement;
-}

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

@@ -1,8 +0,0 @@
-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];
-export declare type LabelProvider = 'toggleBold' | 'toggleItalics' | 'toggleBulletedList' | 'toggleNumberedList';

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

@@ -1,9 +0,0 @@
-/**
- * TipTap node types.
- * @public
- */
-export declare const TipTapNodeName: {
-    readonly bulletList: "bulletList";
-    readonly numberedList: "orderedList";
-};
-export declare type TipTapNodeName = (typeof TipTapNodeName)[keyof typeof TipTapNodeName];

package/dist/esm/src/rich-text/models/markdown-parser.d.ts

@@ -1,16 +0,0 @@
-/**
- * Provides markdown parser for rich text components
- */
-export declare class RichTextMarkdownParser {
-    private static readonly updatedSchema;
-    private static readonly markdownParser;
-    private static readonly domSerializer;
-    /**
-     * This function takes a markdown string, parses it using the ProseMirror MarkdownParser, serializes the parsed content into a
-     * DOM structure using a DOMSerializer, and returns the serialized result.
-     * If the markdown parser returns null, it will clear the viewer component by creating an empty document fragment.
-     */
-    static parseMarkdownToDOM(value: string): HTMLElement | DocumentFragment;
-    private static initializeMarkdownParser;
-    private static getSchemaWithLinkConfiguration;
-}

package/dist/esm/src/rich-text/models/markdown-serializer.d.ts

@@ -1,9 +0,0 @@
-import type { Node } from 'prosemirror-model';
-/**
- * Provides markdown serializer for rich text components
- */
-export declare class RichTextMarkdownSerializer {
-    private static readonly markdownSerializer;
-    static serializeDOMToMarkdown(doc: Node): string;
-    private static initializeMarkdownSerializerForTipTap;
-}

package/dist/esm/src/rich-text/models/testing/markdown-parser-utils.d.ts

@@ -1,4 +0,0 @@
-export declare const getTagsFromElement: (doc: DocumentFragment | HTMLElement) => string[];
-export declare const getLeafContentsFromElement: (doc: DocumentFragment | HTMLElement) => string[];
-export declare const getLastChildElementAttribute: (attribute: string, doc: DocumentFragment | HTMLElement) => string;
-export declare function getLastChildElement(doc: DocumentFragment | HTMLElement): Element | null | undefined;

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

@@ -1,31 +0,0 @@
-import { FoundationElement } from '@microsoft/fast-foundation';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-rich-text-viewer': RichTextViewer;
-    }
-}
-/**
- * A nimble styled rich text viewer
- */
-export declare class RichTextViewer extends FoundationElement {
-    /**
-     *
-     * @public
-     * Markdown string to render its corresponding rich text content in the component.
-     */
-    markdown: string;
-    /**
-     * @internal
-     */
-    viewer: HTMLDivElement;
-    /**
-     * @internal
-     */
-    connectedCallback(): void;
-    /**
-     * @internal
-     */
-    markdownChanged(): void;
-    private updateView;
-}
-export declare const richTextViewerTag: string;

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

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

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

@@ -1,2 +0,0 @@
-import type { RichTextViewer } from '.';
-export declare const template: import("@microsoft/fast-element").ViewTemplate<RichTextViewer, any>;

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

@@ -1,26 +0,0 @@
-import type { RichTextViewer } from '..';
-/**
- * Page object for the `nimble-rich-text-viewer` component.
- */
-export declare class RichTextViewerPageObject {
-    private readonly richTextViewerElement;
-    constructor(richTextViewerElement: RichTextViewer);
-    getRenderedMarkdownLastChildContents(): string;
-    getRenderedMarkdownLastChildAttribute(attribute: string): string;
-    /**
-     * Retrieves tag names for the rendered markdown content in document order
-     * @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
-     */
-    getRenderedMarkdownLeafContents(): string[];
-    private getMarkdownRenderedElement;
-    private getLastChildMarkdownRenderedElement;
-}

package/dist/esm/src/select/index.d.ts

@@ -1,34 +0,0 @@
-import { AnchoredRegion, Select as FoundationSelect } from '@microsoft/fast-foundation';
-import { DropdownAppearance } from '../patterns/dropdown/types';
-import type { ErrorPattern } from '../patterns/error/types';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-select': Select;
-    }
-}
-/**
- * A nimble-styled HTML select
- */
-export declare class Select extends FoundationSelect implements ErrorPattern {
-    appearance: DropdownAppearance;
-    /**
-     * A message explaining why the value is invalid.
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: error-text
-     */
-    errorText: string | undefined;
-    errorVisible: boolean;
-    /**
-     * @internal
-     */
-    region?: AnchoredRegion;
-    setPositioning(): void;
-    slottedOptionsChanged(prev: Element[], next: Element[]): void;
-    private regionChanged;
-    private controlChanged;
-    private maxHeightChanged;
-    private updateListboxMaxHeightCssVariable;
-}
-export declare const selectTag: string;

package/dist/esm/src/select/styles.d.ts

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

package/dist/esm/src/select/template.d.ts

@@ -1,4 +0,0 @@
-import { ViewTemplate } from '@microsoft/fast-element';
-import { FoundationElementTemplate, SelectOptions } from '@microsoft/fast-foundation';
-import type { Select } from '.';
-export declare const template: FoundationElementTemplate<ViewTemplate<Select>, SelectOptions>;

package/dist/esm/src/select/types.d.ts

@@ -1,5 +0,0 @@
-/**
- * Types of dropdown appearance.
- * @public
- */
-export { DropdownAppearance } from '../patterns/dropdown/types';

package/dist/esm/src/spinner/index.d.ts

@@ -1,20 +0,0 @@
-import { FoundationElement } from '@microsoft/fast-foundation';
-import { SpinnerAppearance } from './types';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-spinner': Spinner;
-    }
-}
-/**
- * A Nimble-styled spinner component.
- * A spinner is an animating indicator that can be placed in a particular region of a page to represent loading progress, or an ongoing operation, of an indeterminate / unknown duration.
- */
-export declare class Spinner extends FoundationElement {
-    /**
-     * @public
-     * @description
-     * The appearance the spinner area should have.
-     */
-    appearance: SpinnerAppearance;
-}
-export declare const spinnerTag: string;

package/dist/esm/src/spinner/styles.d.ts

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

package/dist/esm/src/spinner/template.d.ts

@@ -1,2 +0,0 @@
-import type { Spinner } from '.';
-export declare const template: import("@microsoft/fast-element").ViewTemplate<Spinner, any>;

package/dist/esm/src/spinner/types.d.ts

@@ -1,9 +0,0 @@
-/**
- * Types of spinner appearance.
- * @public
- */
-export declare const SpinnerAppearance: {
-    readonly default: undefined;
-    readonly accent: "accent";
-};
-export declare type SpinnerAppearance = (typeof SpinnerAppearance)[keyof typeof SpinnerAppearance];

package/dist/esm/src/switch/index.d.ts

@@ -1,12 +0,0 @@
-import { Switch as FoundationSwitch } from '@microsoft/fast-foundation';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-switch': Switch;
-    }
-}
-/**
- * A nimble-styled switch control.
- */
-export declare class Switch extends FoundationSwitch {
-}
-export declare const switchTag: string;

package/dist/esm/src/switch/styles.d.ts

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

package/dist/esm/src/switch/template.d.ts

@@ -1,2 +0,0 @@
-import type { Switch } from '.';
-export declare const template: import("@microsoft/fast-element").ViewTemplate<Switch, any>;

package/dist/esm/src/tab/index.d.ts

@@ -1,12 +0,0 @@
-import { Tab as FoundationTab } from '@microsoft/fast-foundation';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-tab': Tab;
-    }
-}
-/**
- * A nimble-styled HTML tab
- */
-export declare class Tab extends FoundationTab {
-}
-export declare const tabTag: string;

package/dist/esm/src/tab/styles.d.ts

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

package/dist/esm/src/tab-panel/index.d.ts

@@ -1,12 +0,0 @@
-import { TabPanel as FoundationTabPanel } from '@microsoft/fast-foundation';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-tab-panel': TabPanel;
-    }
-}
-/**
- * A nimble-styled tab panel
- */
-export declare class TabPanel extends FoundationTabPanel {
-}
-export declare const tabPanelTag: string;

package/dist/esm/src/tab-panel/styles.d.ts

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

package/dist/esm/src/table/components/cell/index.d.ts

@@ -1,30 +0,0 @@
-import { ViewTemplate } from '@microsoft/fast-element';
-import { FoundationElement } from '@microsoft/fast-foundation';
-import type { MenuButton } from '../../../menu-button';
-import type { MenuButtonToggleEventDetail } from '../../../menu-button/types';
-import type { TableColumn } from '../../../table-column/base';
-import type { TableCellRecord, TableCellState } from '../../../table-column/base/types';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-table-cell': TableCell;
-    }
-}
-/**
- * A styled cell that is used within the nimble-table-row.
- * @internal
- */
-export declare class TableCell<TCellRecord extends TableCellRecord = TableCellRecord> extends FoundationElement {
-    cellState?: TableCellState<TCellRecord>;
-    column?: TableColumn;
-    recordId?: string;
-    columnId?: string;
-    hasActionMenu: boolean;
-    menuOpen: boolean;
-    actionMenuLabel?: string;
-    cellViewTemplate?: ViewTemplate<TableCell>;
-    nestingLevel: number;
-    readonly actionMenuButton?: MenuButton;
-    onActionMenuBeforeToggle(event: CustomEvent<MenuButtonToggleEventDetail>): void;
-    onActionMenuToggle(event: CustomEvent<MenuButtonToggleEventDetail>): void;
-}
-export declare const tableCellTag: string;

package/dist/esm/src/table/components/cell/styles.d.ts

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

package/dist/esm/src/table/components/cell/template.d.ts

@@ -1,2 +0,0 @@
-import type { TableCell } from '.';
-export declare const template: import("@microsoft/fast-element").ViewTemplate<TableCell<import("../../../table-column/base/types").TableCellRecord>, any>;

package/dist/esm/src/table/components/group-row/index.d.ts

@@ -1,42 +0,0 @@
-import { Checkbox, FoundationElement } from '@microsoft/fast-foundation';
-import type { TableColumn } from '../../../table-column/base';
-import { TableRowSelectionState } from '../../types';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-table-group-row': TableGroupRow;
-    }
-}
-/**
- * A styled cell that is used within the nimble-table-row.
- * @internal
- */
-export declare class TableGroupRow extends FoundationElement {
-    groupRowValue?: unknown;
-    nestingLevel: number;
-    leafItemCount?: number;
-    groupColumn?: TableColumn;
-    expanded: boolean;
-    selectable: boolean;
-    selectionState: TableRowSelectionState;
-    /**
-     * @internal
-     */
-    readonly expandIcon: HTMLElement;
-    /**
-     * @internal
-     */
-    readonly selectionCheckbox?: Checkbox;
-    /**
-     * @internal
-     */
-    animationClass: string;
-    private ignoreSelectionChangeEvents;
-    onGroupExpandToggle(): void;
-    /** @internal */
-    onSelectionChange(event: CustomEvent): void;
-    private selectionStateChanged;
-    private selectionCheckboxChanged;
-    private setSelectionCheckboxState;
-    private readonly removeAnimatingClass;
-}
-export declare const tableGroupRowTag: string;

package/dist/esm/src/table/components/group-row/styles.d.ts

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

package/dist/esm/src/table/components/group-row/template.d.ts

@@ -1,2 +0,0 @@
-import type { TableGroupRow } from '.';
-export declare const template: import("@microsoft/fast-element").ViewTemplate<TableGroupRow, any>;

package/dist/esm/src/table/components/header/index.d.ts

@@ -1,20 +0,0 @@
-import { FoundationElement } from '@microsoft/fast-foundation';
-import { TableColumnSortDirection } from '../../types';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-table-header': TableHeader;
-    }
-}
-/**
- * A styled header that is used within the nimble-table.
- * @internal
- */
-export declare class TableHeader extends FoundationElement {
-    sortDirection: TableColumnSortDirection;
-    firstSortedColumn: boolean;
-    isGrouped: boolean;
-    protected sortDirectionChanged(_prev: TableColumnSortDirection | undefined, _next: TableColumnSortDirection): void;
-    protected firstSortedColumnChanged(_prev: boolean | undefined, _next: boolean): void;
-    private updateAriaSort;
-}
-export declare const tableHeaderTag: string;

package/dist/esm/src/table/components/header/styles.d.ts

@@ -1 +0,0 @@
-export declare const styles: import("@microsoft/fast-element").ElementStyles;

package/dist/esm/src/table/components/header/template.d.ts

@@ -1,2 +0,0 @@
-import type { TableHeader } from '.';
-export declare const template: import("@microsoft/fast-element").ViewTemplate<TableHeader, any>;