@ni/nimble-components 27.1.1 → 27.2.0

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

@@ -1,12 +0,0 @@
-import { Menu as FoundationMenu } from '@microsoft/fast-foundation';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-menu': Menu;
-    }
-}
-/**
- * A nimble-styled menu
- */
-export declare class Menu extends FoundationMenu {
-}
-export declare const menuTag = "nimble-menu";

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, ButtonAppearanceVariant, MenuButtonPosition } from './types';
-import type { ToggleButton } from '../toggle-button';
-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;
-    appearanceVariant: ButtonAppearanceVariant;
-    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 = "nimble-menu-button";

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, ButtonAppearanceVariant } 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 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,13 +0,0 @@
-import { MenuItem as FoundationMenuItem } from '@microsoft/fast-foundation';
-import '../anchored-region';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-menu-item': MenuItem;
-    }
-}
-/**
- * A nimble-styled menu-item
- */
-export declare class MenuItem extends FoundationMenuItem {
-}
-export declare const menuItemTag = "nimble-menu-item";

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

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 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 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 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 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>;