@ni/nimble-components 27.1.1 → 27.2.1

package/dist/esm/src/rich-text-mention/base/view/index.d.ts

@@ -1,20 +0,0 @@
-import { FoundationElement } from '@microsoft/fast-foundation';
-/**
- * The base class for Mention View Node
- */
-export declare class RichTextMentionView extends FoundationElement {
-    /**
-     * Stores the unique URL of the mentioned user matching the pattern
-     *
-     * @public
-     * HTML Attribute: mention-href
-     */
-    mentionHref?: string;
-    /**
-     * Stores the value of the rendering label
-     *
-     * @public
-     * HTML Attribute: mention-label
-     */
-    mentionLabel?: string;
-}

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

@@ -1,20 +0,0 @@
-import type { MentionInternalsOptions } from '../base/models/mention-internals';
-import { RichTextMention } from '../base';
-import type { MappingConfig } from '../base/models/mapping-config';
-import type { Mapping } from '../../mapping/base';
-import type { MappingUserKey } from '../../mapping/base/types';
-import { RichTextMentionUsersValidator } from './models/rich-text-mention-users-validator';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-rich-text-mention-users': RichTextMentionUsers;
-    }
-}
-/**
- * Rich Text user mention configuration element which will have MappingMentionUser elements as children
- */
-export declare class RichTextMentionUsers extends RichTextMention<RichTextMentionUsersValidator> {
-    protected getMentionInternalsOptions(): MentionInternalsOptions<RichTextMentionUsersValidator>;
-    protected getObservedMappingProperty(): string[];
-    protected createMappingConfig(mapping: Mapping<MappingUserKey>): MappingConfig;
-}
-export declare const richTextMentionUsersTag = "nimble-rich-text-mention-users";

package/dist/esm/src/rich-text-mention/users/models/mapping-user-config.d.ts

@@ -1,6 +0,0 @@
-import { MappingConfig } from '../../base/models/mapping-config';
-/**
- * Mapping configuration corresponding to a user mapping
- */
-export declare class MappingUserConfig extends MappingConfig {
-}

package/dist/esm/src/rich-text-mention/users/models/rich-text-mention-users-validator.d.ts

@@ -1,15 +0,0 @@
-import type { Mapping } from '../../../mapping/base';
-import type { MappingUserKey } from '../../../mapping/base/types';
-import { RichTextMentionValidator } from '../../base/models/mention-validator';
-declare const usersValidityFlagNames: readonly ["duplicateMappingMentionHref", "missingMentionHrefValue", "mentionHrefNotValidUrl", "mentionHrefDoesNotMatchPattern", "missingPatternAttribute", "unsupportedPatternValue", "missingDisplayNameValue", "unsupportedMappingType"];
-/**
- * Validator for RichTextMentionUsers
- */
-export declare class RichTextMentionUsersValidator extends RichTextMentionValidator<typeof usersValidityFlagNames> {
-    constructor();
-    private static isSupportedMappingElement;
-    validate(mappings: Mapping<MappingUserKey>[], pattern: string): void;
-    private validateNoMissingDisplayName;
-    private validateMappingTypes;
-}
-export {};

package/dist/esm/src/rich-text-mention/users/view/index.d.ts

@@ -1,12 +0,0 @@
-import { RichTextMentionView } from '../../base/view';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-rich-text-mention-users-view': RichTextMentionUsersView;
-    }
-}
-/**
- * A nimble styled rich text mention users view
- */
-export declare class RichTextMentionUsersView extends RichTextMentionView {
-}
-export declare const richTextMentionUsersViewTag = "nimble-rich-text-mention-users-view";

package/dist/esm/src/rich-text-mention/users/view/styles.d.ts

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

package/dist/esm/src/rich-text-mention/users/view/template.d.ts

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

package/dist/esm/src/rich-text-mention/users/view/testing/rich-text-mention-users-view.pageobject.d.ts

@@ -1,9 +0,0 @@
-import type { RichTextMentionUsersView } from '..';
-/**
- * Page object for the `nimble-rich-text-mention-users-view` component.
- */
-export declare class RichTextMentionUsersViewPageObject {
-    private readonly richTextMentionUsersViewElement;
-    constructor(richTextMentionUsersViewElement: RichTextMentionUsersView);
-    getTextContent(): string;
-}

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

@@ -1,281 +0,0 @@
-import { AnchoredRegion, ListboxOption, SelectPosition } from '@microsoft/fast-foundation';
-import { DropdownAppearance, ListOptionOwner } from '../patterns/dropdown/types';
-import type { ErrorPattern } from '../patterns/error/types';
-import { ListOption } from '../list-option';
-import { FilterMode } from './types';
-import { FormAssociatedSelect } from './models/select-form-associated';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-select': Select;
-    }
-}
-type BooleanOrVoid = boolean | void;
-/**
- * A nimble-styled HTML select.
- */
-export declare class Select extends FormAssociatedSelect implements ErrorPattern, ListOptionOwner {
-    appearance: DropdownAppearance;
-    /**
-     * Reflects the placement for the listbox when the select is open.
-     *
-     * @public
-     */
-    positionAttribute?: SelectPosition;
-    /**
-     * A message explaining why the value is invalid.
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: error-text
-     */
-    errorText: string | undefined;
-    errorVisible: boolean;
-    filterMode: FilterMode;
-    /**
-     * @internal
-     */
-    displayPlaceholder: boolean;
-    /**
-     * @internal
-     */
-    open: boolean;
-    /**
-     * Holds the current state for the calculated position of the listbox.
-     *
-     * @public
-     */
-    position?: SelectPosition;
-    /**
-     * The ref to the internal `.control` element.
-     *
-     * @internal
-     */
-    control: HTMLElement;
-    /**
-     * Reference to the internal listbox element.
-     *
-     * @internal
-     */
-    listbox: HTMLDivElement;
-    /**
-     * The unique id for the internal listbox element.
-     *
-     * @internal
-     */
-    listboxId: string;
-    /**
-     * @internal
-     */
-    scrollableRegion: HTMLElement;
-    /**
-     * @internal
-     */
-    filterInput?: HTMLInputElement;
-    /**
-     * @internal
-     */
-    anchoredRegion: AnchoredRegion;
-    /** @internal */
-    hasOverflow: boolean;
-    /**
-     * @internal
-     */
-    filteredOptions: ListboxOption[];
-    /**
-     * @internal
-     */
-    filter: string;
-    /**
-     * @internal
-     */
-    committedSelectedOption?: ListboxOption;
-    /**
-     * The max height for the listbox when opened.
-     *
-     * @internal
-     */
-    maxHeight: number;
-    /**
-     * The component is collapsible when in single-selection mode with no size attribute.
-     *
-     * @internal
-     */
-    get collapsible(): boolean;
-    private _value;
-    private forcedPosition;
-    private indexWhenOpened?;
-    /**
-     * @internal
-     */
-    connectedCallback(): void;
-    get value(): string;
-    set value(next: string);
-    /**
-     * @internal
-     */
-    get displayValue(): string;
-    /**
-     * @internal
-     */
-    anchoredRegionChanged(_prev: AnchoredRegion | undefined, _next: AnchoredRegion | undefined): void;
-    /**
-     * @internal
-     */
-    controlChanged(_prev: HTMLElement | undefined, _next: HTMLElement | undefined): void;
-    /**
-     * @internal
-     */
-    slottedOptionsChanged(prev: Element[], next: Element[]): void;
-    /**
-     * @internal
-     */
-    clickHandler(e: MouseEvent): BooleanOrVoid;
-    /**
-     * Updates the value when an option's value changes.
-     *
-     * @param source - the source object
-     * @param propertyName - the property to evaluate
-     *
-     * @internal
-     * @override
-     */
-    handleChange(source: unknown, propertyName: string): void;
-    /**
-     * Prevents focus when size is set and a scrollbar is clicked.
-     *
-     * @param e - the mouse event object
-     *
-     * @override
-     * @internal
-     */
-    mousedownHandler(e: MouseEvent): BooleanOrVoid;
-    /**
-     * @internal
-     */
-    regionLoadedHandler(): void;
-    /**
-     * Sets the multiple property on the proxy element.
-     *
-     * @param prev - the previous multiple value
-     * @param next - the current multiple value
-     */
-    multipleChanged(prev: boolean | undefined, next: boolean): void;
-    /**
-     * @internal
-     */
-    inputClickHandler(e: MouseEvent): void;
-    /**
-     * @internal
-     */
-    changeValueHandler(): void;
-    /**
-     * @internal
-     */
-    updateDisplayValue(): void;
-    /**
-     * Handle content changes on the control input.
-     *
-     * @param e - the input event
-     * @internal
-     */
-    inputHandler(e: InputEvent): boolean;
-    /**
-     * @internal
-     */
-    focusoutHandler(e: FocusEvent): BooleanOrVoid;
-    /**
-     * @internal
-     */
-    keydownHandler(e: KeyboardEvent): BooleanOrVoid;
-    /**
-     * Updates the proxy value when the selected index changes.
-     *
-     * @param prev - the previous selected index
-     * @param next - the next selected index
-     *
-     * @internal
-     */
-    selectedIndexChanged(_: number | undefined, __: number): void;
-    /**
-     * Synchronize the `aria-disabled` property when the `disabled` property changes.
-     *
-     * @param prev - The previous disabled value
-     * @param next - The next disabled value
-     *
-     * @internal
-     */
-    disabledChanged(prev: boolean, next: boolean): void;
-    /**
-     * Reset the element to its first selectable option when its parent form is reset.
-     *
-     * @internal
-     */
-    formResetCallback(): void;
-    selectNextOption(): void;
-    selectPreviousOption(): void;
-    /**
-     * @internal
-     */
-    registerOption(option: ListOption): void;
-    protected setSelectedOptions(): void;
-    protected focusAndScrollOptionIntoView(): void;
-    protected positionChanged(_: SelectPosition | undefined, next: SelectPosition | undefined): void;
-    /**
-     * Updates the proxy's size property when the size attribute changes.
-     *
-     * @param prev - the previous size
-     * @param next - the current size
-     *
-     * @override
-     * @internal
-     */
-    protected sizeChanged(prev: number | undefined, next: number): void;
-    protected openChanged(): void;
-    /**
-     * Updates the selectedness of each option when the list of selected options changes.
-     *
-     * @param prev - the previous list of selected options
-     * @param next - the current list of selected options
-     *
-     * @override
-     * @internal
-     */
-    protected selectedOptionsChanged(_prev: ListboxOption[] | undefined, next: ListboxOption[]): void;
-    /**
-     * Sets the selected index to match the first option with the selected attribute, or
-     * the first selectable option.
-     *
-     * @override
-     * @internal
-     */
-    protected setDefaultSelectedOption(): void;
-    private committedSelectedOptionChanged;
-    private setPositioning;
-    /**
-     * Filter available options by text value.
-     *
-     * @public
-     */
-    private filterOptions;
-    /**
-     * Sets the value and display value to match the first selected option.
-     *
-     * @param shouldEmit - if true, the input and change events will be emitted
-     *
-     * @internal
-     */
-    private updateValue;
-    /**
-     * Resets and fills the proxy to match the component's options.
-     *
-     * @internal
-     */
-    private setProxyOptions;
-    private clearSelection;
-    private filterChanged;
-    private maxHeightChanged;
-    private initializeOpenState;
-    private updateListboxMaxHeightCssVariable;
-}
-export declare const selectTag = "nimble-select";
-export {};

package/dist/esm/src/select/models/select-form-associated.d.ts

@@ -1,16 +0,0 @@
-import { FormAssociated, ListboxElement } from '@microsoft/fast-foundation';
-declare class Select extends ListboxElement {
-}
-interface Select extends FormAssociated {
-}
-declare const FormAssociatedSelect_base: typeof Select;
-/**
- * A form-associated base class for the Select component. This was copied from the
- * FAST FormAssociatedSelect (which is not exported by fast-foundation)
- *
- * @internal
- */
-export declare class FormAssociatedSelect extends FormAssociatedSelect_base {
-    proxy: HTMLSelectElement;
-}
-export {};

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/testing/select.pageobject.d.ts

@@ -1,39 +0,0 @@
-import type { Select } from '..';
-import type { ListOption } from '../../list-option';
-/**
- * Page object for the `nimble-select` component to provide consistent ways
- * of querying and interacting with the component during tests.
- */
-export declare class SelectPageObject {
-    private readonly selectElement;
-    constructor(selectElement: Select);
-    openAndSetFilterText(filterText: string): Promise<void>;
-    closeDropdown(): Promise<void>;
-    setOptions(options: ListOption[]): Promise<void>;
-    getFilteredOptions(): ListOption[];
-    getSelectedOption(): ListOption | null;
-    /**
-     * Either opens or closes the dropdown depending on its current state
-     */
-    clickSelect(): void;
-    clickSelectedItem(): void;
-    clickFilterInput(): Promise<void>;
-    clickOption(index: number): void;
-    /**
-     * Click the option with the text provided by the 'displayText' parameter.
-     * @param value The text of the option to be selected
-     */
-    clickOptionWithDisplayText(displayText: string): void;
-    clickAway(): Promise<void>;
-    pressEnterKey(): void;
-    pressEscapeKey(): void;
-    pressArrowDownKey(): void;
-    pressArrowUpKey(): void;
-    pressSpaceKey(): Promise<void>;
-    isDropdownVisible(): boolean;
-    isFilterInputVisible(): boolean;
-    isOptionVisible(index: number): boolean;
-    isNoResultsLabelVisible(): boolean;
-    getFilterInputText(): string;
-    private getFilterInput;
-}

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

@@ -1,14 +0,0 @@
-/**
- * Types of dropdown appearance.
- * @public
- */
-export { DropdownAppearance } from '../patterns/dropdown/types';
-/**
- * Types of select filter mode.
- * @public
- */
-export declare const FilterMode: {
-    readonly none: undefined;
-    readonly standard: "standard";
-};
-export type FilterMode = (typeof FilterMode)[keyof typeof FilterMode];

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

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

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

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

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

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;
-    immediateChildCount?: 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 = "nimble-table-group-row";

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,21 +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;
-    indicatorsHidden: 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 = "nimble-table-header";

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

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