@ni/nimble-components 20.5.0 → 20.5.2

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

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

package/dist/esm/src/menu-button/index.d.ts

@@ -1,54 +0,0 @@
-import { FoundationElement } from '@microsoft/fast-foundation';
-import { ButtonAppearance } from '../button/types';
-import type { ToggleButton } from '../toggle-button';
-import { MenuButtonPosition } from './types';
-import type { ButtonPattern } from '../patterns/button/types';
-import type { AnchoredRegion } from '../anchored-region';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-menu-button': MenuButton;
-    }
-}
-/**
- * A nimble-styled menu button control.
- */
-export declare class MenuButton extends FoundationElement implements ButtonPattern {
-    appearance: ButtonAppearance;
-    disabled: boolean;
-    contentHidden: boolean;
-    /**
-     * Specifies whether or not the menu is open.
-     */
-    open: boolean;
-    /**
-     * Configures where the menu should be placed relative to the button that opens the menu.
-     */
-    position: MenuButtonPosition;
-    /** @internal */
-    readonly toggleButton?: ToggleButton;
-    /** @internal */
-    readonly region?: AnchoredRegion;
-    /** @internal */
-    readonly slottedMenus?: HTMLElement[];
-    /**
-     * Used to maintain the internal state of whether the last menu item should be focused instead
-     * of the first menu item the next time the menu is opened.
-     */
-    private focusLastItemWhenOpened;
-    disconnectedCallback(): void;
-    toggleButtonChanged(_prev: ToggleButton | undefined, _next: ToggleButton | undefined): void;
-    regionChanged(prev: AnchoredRegion | undefined, _next: AnchoredRegion | undefined): void;
-    openChanged(_prev: boolean | undefined, _next: boolean): void;
-    regionLoadedHandler(): void;
-    focusoutHandler(e: FocusEvent): boolean;
-    toggleButtonCheckedChangeHandler(e: Event): boolean;
-    toggleButtonKeyDownHandler(e: KeyboardEvent): boolean;
-    menuKeyDownHandler(e: KeyboardEvent): boolean;
-    private setOpen;
-    private getMenu;
-    private isSlotElement;
-    private focusMenu;
-    private focusLastMenuItem;
-    private readonly menuChangeHandler;
-}
-export declare const menuButtonTag: string;

package/dist/esm/src/menu-button/styles.d.ts

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

package/dist/esm/src/menu-button/template.d.ts

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

package/dist/esm/src/menu-button/types.d.ts

@@ -1,22 +0,0 @@
-/**
- * Types of menu button appearance.
- * @public
- */
-export { ButtonAppearance } from '../patterns/button/types';
-/**
- * The options of where to position the menu relative to the menu button.
- */
-export declare const MenuButtonPosition: {
-    readonly above: "above";
-    readonly below: "below";
-    readonly auto: "auto";
-};
-export declare type MenuButtonPosition = (typeof MenuButtonPosition)[keyof typeof MenuButtonPosition];
-/**
- * The type of the detail associated with the `toggle` and `beforetoggle`
- * events on the menu button.
- */
-export interface MenuButtonToggleEventDetail {
-    newState: boolean;
-    oldState: boolean;
-}

package/dist/esm/src/menu-item/index.d.ts

@@ -1,12 +0,0 @@
-import { MenuItem as FoundationMenuItem } from '@microsoft/fast-foundation';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-menu-item': MenuItem;
-    }
-}
-/**
- * A nimble-styled menu-item
- */
-export declare class MenuItem extends FoundationMenuItem {
-}
-export declare const menuItemTag: string;

package/dist/esm/src/menu-item/styles.d.ts

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

package/dist/esm/src/number-field/index.d.ts

@@ -1,25 +0,0 @@
-import { NumberField as FoundationNumberField } from '@microsoft/fast-foundation';
-import { NumberFieldAppearance } from './types';
-import type { ErrorPattern } from '../patterns/error/types';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-number-field': NumberField;
-    }
-}
-/**
- * A nimble-styled HTML number input
- */
-export declare class NumberField extends FoundationNumberField implements ErrorPattern {
-    appearance: NumberFieldAppearance;
-    /**
-     * A message explaining why the value is invalid.
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: error-text
-     */
-    errorText?: string;
-    errorVisible: boolean;
-    connectedCallback(): void;
-}
-export declare const numberFieldTag: string;

package/dist/esm/src/number-field/styles.d.ts

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

package/dist/esm/src/number-field/types.d.ts

@@ -1,9 +0,0 @@
-/**
- * Values for the 'appearance' property of the number field
- */
-export declare const NumberFieldAppearance: {
-    readonly underline: "underline";
-    readonly outline: "outline";
-    readonly block: "block";
-};
-export declare type NumberFieldAppearance = (typeof NumberFieldAppearance)[keyof typeof NumberFieldAppearance];

package/dist/esm/src/patterns/button/styles.d.ts

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

package/dist/esm/src/patterns/button/types.d.ts

@@ -1,49 +0,0 @@
-/**
- * The interface that buttons of various types implement. The properties in this interface
- * are leveraged by the shared button pattern css.
- */
-export interface ButtonPattern {
-    /**
-     * The appearance the button should have.
-     */
-    appearance: ButtonAppearance;
-    /**
-     * Specify as 'true' to hide the text content of the button. The button will
-     * become square, and the text content will be used as the label of the button
-     * for accessibility purposes.
-     */
-    contentHidden: boolean;
-    /**
-     * Whether or not the button is disabled.
-     */
-    disabled: boolean;
-}
-/**
- * Interface for buttons that support appearance variants.
- */
-export interface ButtonAppearanceVariantPattern {
-    /**
-     * The appearance variant the button should have.
-     */
-    appearanceVariant: ButtonAppearanceVariant;
-}
-/**
- * Types of button appearance.
- * @public
- */
-export declare const ButtonAppearance: {
-    readonly outline: "outline";
-    readonly ghost: "ghost";
-    readonly block: "block";
-};
-export declare type ButtonAppearance = (typeof ButtonAppearance)[keyof typeof ButtonAppearance];
-/**
- * Types of button appearance variants.
- * @public
- */
-export declare const ButtonAppearanceVariant: {
-    readonly default: undefined;
-    readonly primary: "primary";
-    readonly accent: "accent";
-};
-export declare type ButtonAppearanceVariant = (typeof ButtonAppearanceVariant)[keyof typeof ButtonAppearanceVariant];

package/dist/esm/src/patterns/dialog/types.d.ts

@@ -1,6 +0,0 @@
-/**
- * Symbol that is returned as the close reason (from the Promise returned by show()) when
- * the dialog or drawer was closed by pressing the ESC key (vs. calling the close() function).
- */
-export declare const UserDismissed: unique symbol;
-export declare type UserDismissed = typeof UserDismissed;

package/dist/esm/src/patterns/dropdown/styles.d.ts

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

package/dist/esm/src/patterns/dropdown/types.d.ts

@@ -1,19 +0,0 @@
-import type { ErrorPattern } from '../error/types';
-/**
- * The interface that dropdowns of various types implement. The properties in this interface
- * are leveraged by the shared dropdown pattern css.
- */
-export interface DropdownPattern extends ErrorPattern {
-    position?: DropdownPosition;
-}
-export declare const DropdownPosition: {
-    readonly above: "above";
-    readonly below: "below";
-};
-export declare type DropdownPosition = (typeof DropdownPosition)[keyof typeof DropdownPosition];
-export declare const DropdownAppearance: {
-    readonly underline: "underline";
-    readonly outline: "outline";
-    readonly block: "block";
-};
-export declare type DropdownAppearance = (typeof DropdownAppearance)[keyof typeof DropdownAppearance];

package/dist/esm/src/patterns/error/styles.d.ts

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

package/dist/esm/src/patterns/error/template.d.ts

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

package/dist/esm/src/patterns/error/types.d.ts

@@ -1,10 +0,0 @@
-/**
- * This interface should be used by components that want to leverage the error pattern. The error pattern conditionally adds error text to the template when an error is configured to be visible.
- */
-export interface ErrorPattern {
-    /**
-     * The error text that will be displayed when a component is in the error appearance
-     */
-    errorText?: string;
-    errorVisible: boolean;
-}

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

@@ -1,12 +0,0 @@
-import { Radio as FoundationRadio } from '@microsoft/fast-foundation';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-radio': Radio;
-    }
-}
-/**
- * A nimble-styled radio button
- */
-export declare class Radio extends FoundationRadio {
-}
-export declare const radioTag: string;

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

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

package/dist/esm/src/radio-group/index.d.ts

@@ -1,14 +0,0 @@
-import { RadioGroup as FoundationRadioGroup } from '@microsoft/fast-foundation';
-import { Orientation } from '@microsoft/fast-web-utilities';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-radio-group': RadioGroup;
-    }
-}
-export { Orientation };
-/**
- * A nimble-styled grouping element for radio buttons
- */
-export declare class RadioGroup extends FoundationRadioGroup {
-}
-export declare const radioGroupTag: string;

package/dist/esm/src/radio-group/styles.d.ts

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

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,43 +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;
-    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>;