@ni/nimble-components 27.1.0 → 27.2.0

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 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,33 +0,0 @@
-import type { ListOption } from '../../list-option';
-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 type DropdownPosition = (typeof DropdownPosition)[keyof typeof DropdownPosition];
-export declare const DropdownAppearance: {
-    readonly underline: "underline";
-    readonly outline: "outline";
-    readonly block: "block";
-};
-export type DropdownAppearance = (typeof DropdownAppearance)[keyof typeof DropdownAppearance];
-/**
- * @internal
- *
- * This interface is used to register options with their parent once their
- * 'connectedCallback' method is run. This allows for the "owner", like the
- * Select, to have its value set to that newly registered option earlier than it
- * might otherwise in certain situations. One such scenario is in an Angular
- * reactive form, where the form value is set to an option immediately after
- * dynamically adding it.
- */
-export interface ListOptionOwner extends HTMLElement {
-    registerOption: (option: ListOption) => void;
-}

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/patterns/expand-collapse/styles.d.ts

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

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 = "nimble-radio";

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 = "nimble-radio-group";

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/base/index.d.ts

@@ -1,49 +0,0 @@
-import { type Notifier } from '@microsoft/fast-element';
-import { FoundationElement } from '@microsoft/fast-foundation';
-import { RichTextMention } from '../../rich-text-mention/base';
-import { Configuration } from '../models/configuration';
-import { RichTextUpdateTracker } from '../models/rich-text-tracker';
-import { RichTextValidator } from '../models/rich-text-validator';
-import type { RichTextValidity } from './types';
-/**
- * Base class for rich text components
- */
-export declare abstract class RichText extends FoundationElement {
-    /**
-     * @internal
-     */
-    mentionInternalsNotifiers: Notifier[];
-    /**
-     * @internal
-     */
-    readonly childItems: Element[];
-    protected configuration?: Configuration;
-    protected mentionElements: RichTextMention[];
-    protected readonly richTextUpdateTracker: RichTextUpdateTracker;
-    protected readonly richTextValidator: RichTextValidator;
-    /**
-     * @public
-     */
-    get validity(): RichTextValidity;
-    /**
-     * @public
-     */
-    checkValidity(): boolean;
-    /**
-     * @internal
-     */
-    abstract getMentionedHrefs(): string[];
-    /**
-     * @internal
-     */
-    handleChange(source: unknown, args: unknown): void;
-    /**
-     * @internal
-     */
-    createConfig(): void;
-    protected validate(): void;
-    private childItemsChanged;
-    private updateMentionElementsFromChildItems;
-    private observeMentionInternals;
-    private removeMentionInternalsObservers;
-}

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

@@ -1,5 +0,0 @@
-import type { ValidityObject } from '../../utilities/models/validator';
-export interface RichTextValidity extends ValidityObject {
-    readonly invalidMentionConfiguration: boolean;
-    readonly duplicateMentionConfiguration: boolean;
-}

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

@@ -1,270 +0,0 @@
-import { ARIAGlobalStatesAndProperties } from '@microsoft/fast-foundation';
-import { Editor } from '@tiptap/core';
-import type { SuggestionProps } from '@tiptap/suggestion';
-import type { ToggleButton } from '../../toggle-button';
-import { MentionDetail } from './types';
-import type { ErrorPattern } from '../../patterns/error/types';
-import { RichTextMarkdownSerializer } from '../models/markdown-serializer';
-import { RichText } from '../base';
-import type { RichTextMentionListbox } from '../mention-listbox';
-import type { MappingConfigs } from '../../rich-text-mention/base/types';
-import type { MentionExtensionConfiguration } from '../models/mention-extension-configuration';
-import { EditorConfiguration } from '../models/editor-configuration';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-rich-text-editor': RichTextEditor;
-    }
-}
-/**
- * A nimble styled rich text editor
- */
-export declare class RichTextEditor extends RichText implements ErrorPattern {
-    /**
-     * @internal
-     */
-    editor: HTMLDivElement;
-    /**
-     * @internal
-     */
-    tiptapEditor: Editor;
-    /**
-     * @internal
-     */
-    readonly xmlSerializer: XMLSerializer;
-    /**
-     * @internal
-     */
-    richTextMarkdownSerializer: RichTextMarkdownSerializer;
-    /**
-     * 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
-     */
-    mentionListbox?: RichTextMentionListbox;
-    /**
-     * @internal
-     */
-    boldButton: ToggleButton;
-    /**
-     * @internal
-     */
-    italicsButton: ToggleButton;
-    /**
-     * @internal
-     */
-    bulletListButton: ToggleButton;
-    /**
-     * @internal
-     */
-    numberedListButton: ToggleButton;
-    /**
-     * The width of the vertical scrollbar, if displayed.
-     * @internal
-     */
-    scrollbarWidth: number;
-    /**
-     * @internal
-     */
-    activeMentionCharacter: string;
-    /**
-     * @internal
-     */
-    activeMappingConfigs?: MappingConfigs;
-    /**
-     * @internal
-     */
-    activeMentionCommand?: SuggestionProps['command'];
-    /**
-     * @internal
-     */
-    editorContainer: HTMLDivElement;
-    private resizeObserver?;
-    private updateScrollbarWidthQueued;
-    /**
-     * @internal
-     */
-    connectedCallback(): void;
-    /**
-     * @internal
-     */
-    disconnectedCallback(): void;
-    /**
-     * @internal
-     */
-    disabledChanged(): void;
-    /**
-     * Update the placeholder text and view of the editor.
-     * @internal
-     */
-    placeholderChanged(_prev: unknown, _next: unknown): void;
-    /**
-     * @internal
-     */
-    ariaLabelChanged(_prev: unknown, _next: unknown): void;
-    /**
-     * @internal
-     */
-    configurationChanged(prev: EditorConfiguration | undefined, next: EditorConfiguration): void;
-    /**
-     * @internal
-     */
-    activeMentionCharacterChanged(): 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;
-    /**
-     * Inserts the mention character into the editor and focus back to the editor
-     * @internal
-     */
-    mentionButtonClick(character: string): void;
-    /**
-     * 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;
-    getMentionedHrefs(): string[];
-    /**
-     * @internal
-     */
-    getMentionExtensionConfig(): MentionExtensionConfiguration[];
-    /**
-     * @internal
-     */
-    onMentionSelect(event: CustomEvent<MentionDetail>): void;
-    /**
-     * @internal
-     */
-    focusoutHandler(): void;
-    createConfig(): void;
-    private isMentionExtensionConfigUnchanged;
-    private createEditor;
-    private initializeEditor;
-    /**
-     * 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;
-    private disableEditor;
-    private disableMentionViewElement;
-    /**
-     * 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;
-    private setActiveMappingConfigs;
-    private shouldInsertSpace;
-    private getMentionExtensionConfigFromCharacter;
-    private resetEditorButtonsState;
-    private getButtonsState;
-}
-export interface RichTextEditor extends ARIAGlobalStatesAndProperties {
-}
-export declare const richTextEditorTag = "nimble-rich-text-editor";

package/dist/esm/src/rich-text/editor/models/create-tiptap-editor.d.ts

@@ -1,5 +0,0 @@
-import { Editor } from '@tiptap/core';
-import { ActiveMentionCommandEmitter, ActiveMentionCharacterEmitter } from '../types';
-import type { MentionExtensionConfiguration } from '../../models/mention-extension-configuration';
-import type { RichTextMentionListbox } from '../../mention-listbox';
-export declare function createTiptapEditor(activeMentionCharacterEmitter: ActiveMentionCharacterEmitter, activeMentionCommandEmitter: ActiveMentionCommandEmitter, editor: HTMLDivElement, mentionExtensionConfig: MentionExtensionConfiguration[], mentionListbox?: RichTextMentionListbox, placeholder?: string): Editor;

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-utils.d.ts

@@ -1,6 +0,0 @@
-import type { RichTextEditor } from '..';
-import { type RichTextMentionUsers } from '../../../rich-text-mention/users';
-import type { MappingConfiguration, UserMentionElements, TestMentionElements } from './types';
-export declare function appendUserMentionConfiguration(element: RichTextEditor, mappings?: MappingConfiguration[]): Promise<UserMentionElements>;
-export declare function appendTestMentionConfiguration(element: RichTextEditor, mappings?: MappingConfiguration[]): Promise<TestMentionElements>;
-export declare function replaceUserMappingElements(element: RichTextMentionUsers, mappings: MappingConfiguration[]): Promise<void>;

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

@@ -1,75 +0,0 @@
-import type { RichTextEditor } from '..';
-import { ArrowKeyButton, MappingConfiguration, 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>;
-    pressEscapeKeyInEditor(): Promise<void>;
-    pressArrowKeyInEditor(arrowButton: ArrowKeyButton): Promise<void>;
-    pressShiftEnterKeysInEditor(): Promise<void>;
-    pressTabKeyInEditor(): Promise<void>;
-    pressShiftTabKeysInEditor(): Promise<void>;
-    /**
-     * In testing environment, when clicking on the footer button, it may not persist in the same state if any editor transaction occurs in between.
-     * This behavior is likely due to dynamic modifications of formatting button states based on cursor positions during editor transactions.
-     * Setting the "force" parameter to true activates the formatting button state; when set to false, it deactivates the state.
-     * If unset, the state toggles by interacting with it once.
-     */
-    toggleFooterButton(button: ToolbarButton, force?: boolean): Promise<void>;
-    clickUserMentionButton(): Promise<void>;
-    getMentionButtonIcon(buttonIndex: number): string | undefined;
-    getMentionButtonTitle(buttonIndex: number): string;
-    getMentionButtonLabel(buttonIndex: number): string;
-    getButtonCheckedState(button: ToolbarButton): boolean;
-    getButtonTabIndex(button: ToolbarButton): number;
-    spaceKeyActivatesButton(button: ToolbarButton): void;
-    enterKeyActivatesButton(button: ToolbarButton): void;
-    pasteToEditor(text: string): void;
-    pasteHTMLToEditor(htmlString: string): void;
-    setEditorTextContent(value: string): Promise<void>;
-    setCursorPosition(position: number): Promise<void>;
-    replaceEditorContent(value: string): Promise<void>;
-    sliceEditorContent(from: number, to: number): Promise<void>;
-    getEditorLastChildAttribute(attribute: string): string;
-    isMentionListboxOpened(): boolean;
-    getEditorMentionViewAttributeValues(attribute: string): string[];
-    getEditorFirstChildTagName(): string;
-    getEditorFirstChildTextContent(): string;
-    getEditorTextContents(): string[];
-    getEditorTagNames(): string[];
-    getMarkdownRenderedTagNames(): 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;
-    getParsedHtmlFromMarkdown(markdown: string, mappings?: MappingConfiguration[]): string;
-    focusOutEditor(): Promise<void>;
-    getMentionListboxItemsName(): string[];
-    getSelectedOption(): string;
-    clickMentionListboxOption(index: number): Promise<void>;
-    moveCursorToStart(): void;
-    getCursorPosition(): number;
-    private getEditorSection;
-    private getFooter;
-    private getTiptapEditor;
-    private getFormattingButton;
-    private getUserMentionButton;
-    private getMentionButtons;
-    private getMentionListbox;
-    private getAllListItemsInMentionBox;
-    private getEditorLastChildElement;
-    private getParserMentionConfigForUser;
-}

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

@@ -1,31 +0,0 @@
-import type { MappingUser } from '../../../mapping/user';
-import type { RichTextMentionTest } from '../../../rich-text-mention/base/tests/rich-text-mention.fixtures';
-import type { RichTextMentionUsers } from '../../../rich-text-mention/users';
-export declare const ToolbarButton: {
-    readonly bold: 0;
-    readonly italics: 1;
-    readonly bulletList: 2;
-    readonly numberedList: 3;
-};
-export type ToolbarButton = (typeof ToolbarButton)[keyof typeof ToolbarButton];
-export declare const ArrowKeyButton: {
-    readonly up: "ArrowUp";
-    readonly down: "ArrowDown";
-    readonly left: "ArrowLeft";
-    readonly right: "ArrowRight";
-};
-export type ArrowKeyButton = (typeof ArrowKeyButton)[keyof typeof ArrowKeyButton];
-export type LabelProvider = 'toggleBold' | 'toggleItalics' | 'toggleBulletedList' | 'toggleNumberedList';
-export type ToolbarButtonKey = keyof typeof ToolbarButton;
-export interface UserMentionElements {
-    userMentionElement: RichTextMentionUsers;
-    mappingElements: MappingUser[];
-}
-export interface TestMentionElements {
-    testMentionElement: RichTextMentionTest;
-    mappingElements: MappingUser[];
-}
-export interface MappingConfiguration {
-    key?: string;
-    displayName?: string;
-}

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

@@ -1,27 +0,0 @@
-import type { SuggestionProps } from '@tiptap/suggestion';
-/**
- * TipTap node types.
- * @public
- */
-export declare const TipTapNodeName: {
-    readonly bulletList: "bulletList";
-    readonly numberedList: "orderedList";
-};
-export type TipTapNodeName = (typeof TipTapNodeName)[keyof typeof TipTapNodeName];
-export interface MentionExtensionConfig {
-    name: string;
-    key: string;
-    character: string;
-    viewElement: string;
-}
-export interface FormatButtonsState {
-    bold: boolean;
-    italics: boolean;
-}
-export interface MentionDetail {
-    href: string;
-    displayName: string;
-}
-export declare const mentionPluginPrefix = "mention-plugin-";
-export type ActiveMentionCommandEmitter = (command?: SuggestionProps['command']) => void;
-export type ActiveMentionCharacterEmitter = (character: string) => void;