@ni/nimble-components 27.1.1 → 27.2.0

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

@@ -1,12 +0,0 @@
-import { BreadcrumbItem as FoundationBreadcrumbItem } from '@microsoft/fast-foundation';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-breadcrumb-item': BreadcrumbItem;
-    }
-}
-/**
- * A nimble-styled breadcrumb item
- */
-export declare class BreadcrumbItem extends FoundationBreadcrumbItem {
-}
-export declare const breadcrumbItemTag = "nimble-breadcrumb-item";

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

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

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

@@ -1,32 +0,0 @@
-import { Button as FoundationButton } from '@microsoft/fast-foundation';
-import type { ButtonPattern, ButtonAppearanceVariantPattern } from '../patterns/button/types';
-import { ButtonAppearance, ButtonAppearanceVariant } from './types';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-button': Button;
-    }
-}
-/**
- * A nimble-styled HTML button
- */
-export declare class Button extends FoundationButton implements ButtonPattern, ButtonAppearanceVariantPattern {
-    /**
-     * @public
-     * @remarks
-     * HTML Attribute: appearance
-     */
-    appearance: ButtonAppearance;
-    /**
-     * @public
-     * @remarks
-     * HTML Attribute: appearance-variant
-     */
-    appearanceVariant: ButtonAppearanceVariant;
-    /**
-     * @public
-     * @remarks
-     * HTML Attribute: content-hidden
-     */
-    contentHidden: boolean;
-}
-export declare const buttonTag = "nimble-button";

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

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

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

@@ -1,7 +0,0 @@
-/**
- * Types of button appearance.
- * @public
- */
-import type { Button } from '@microsoft/fast-foundation';
-export { ButtonAppearance, ButtonAppearanceVariant } from '../patterns/button/types';
-export type ButtonType = Button['type'];

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

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

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

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

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

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

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

@@ -1,18 +0,0 @@
-import { Button as FoundationButton } from '@microsoft/fast-foundation';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-card-button': CardButton;
-    }
-}
-/**
- * A nimble-styled card button
- */
-export declare class CardButton extends FoundationButton {
-    /**
-     * @public
-     * @remarks
-     * HTML Attribute: selected
-     */
-    selected: boolean;
-}
-export declare const cardButtonTag = "nimble-card-button";

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

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

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

@@ -1,12 +0,0 @@
-import { Checkbox as FoundationCheckbox } from '@microsoft/fast-foundation';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-checkbox': Checkbox;
-    }
-}
-/**
- * A nimble-styled checkbox control.
- */
-export declare class Checkbox extends FoundationCheckbox {
-}
-export declare const checkboxTag = "nimble-checkbox";

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

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

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

@@ -1,234 +0,0 @@
-import { ComboboxAutocomplete, SelectPosition, ListboxOption, DelegatesARIACombobox, StartEnd } from '@microsoft/fast-foundation';
-import { ToggleButton } from '../toggle-button';
-import type { ErrorPattern } from '../patterns/error/types';
-import type { DropdownPattern } from '../patterns/dropdown/types';
-import { DropdownAppearance } from '../patterns/dropdown/types';
-import type { AnchoredRegion } from '../anchored-region';
-import { FormAssociatedCombobox } from './models/combobox-form-associated';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-combobox': Combobox;
-    }
-}
-/**
- * A nimble-styed HTML combobox
- */
-export declare class Combobox extends FormAssociatedCombobox implements DropdownPattern, ErrorPattern {
-    appearance: DropdownAppearance;
-    /**
-     * A message explaining why the value is invalid.
-     */
-    errorText?: string;
-    errorVisible: boolean;
-    /**
-     * The autocomplete attribute.
-     */
-    autocomplete?: ComboboxAutocomplete;
-    /**
-     * The placement for the listbox when the combobox is open.
-     */
-    positionAttribute?: SelectPosition;
-    /**
-     * The open attribute.
-     */
-    open: boolean;
-    /**
-     * Sets the placeholder value of the element, generally used to provide a hint to the user.
-     * @remarks Using a non-null assertion to mimic FAST's original improper typing of an
-     * uninitialized property:
-     * https://github.com/microsoft/fast/blob/0c27d027ff6e8616ad4fddc17f4432aa7f6cbad0/packages/web-components/fast-foundation/src/combobox/combobox.ts#L199
-     */
-    placeholder: string;
-    /**
-     * The current state of the calculated position of the listbox.
-     *
-     * @public
-     */
-    position?: SelectPosition;
-    /**
-     * @internal
-     */
-    region?: AnchoredRegion;
-    /**
-     * @internal
-     */
-    controlWrapper: HTMLElement;
-    /**
-     * @internal
-     */
-    control: HTMLInputElement;
-    /**
-     * @internal
-     */
-    listbox: HTMLDivElement;
-    /**
-     * @internal
-     */
-    readonly dropdownButton?: ToggleButton;
-    /**
-     * The collection of currently filtered options.
-     */
-    filteredOptions: ListboxOption[];
-    /** @internal */
-    hasOverflow: boolean;
-    get value(): string;
-    set value(next: string);
-    /**
-     * The list of options.
-     *
-     * Overrides `Listbox.options`.
-     */
-    get options(): ListboxOption[];
-    set options(value: ListboxOption[]);
-    /**
-     * The unique id for the internal listbox element.
-     *
-     * @internal
-     */
-    listboxId: string;
-    /**
-     * The max height for the listbox when opened.
-     *
-     * @internal
-     */
-    maxHeight: number;
-    private valueUpdatedByInput;
-    private valueBeforeTextUpdate?;
-    private _value;
-    private filter;
-    /**
-     * The initial state of the position attribute.
-     */
-    private forcedPosition;
-    private get isAutocompleteInline();
-    private get isAutocompleteList();
-    private get isAutocompleteBoth();
-    slottedOptionsChanged(prev: HTMLElement[], next: HTMLElement[]): void;
-    connectedCallback(): void;
-    /**
-     * @internal
-     */
-    clickHandler(e: MouseEvent): boolean;
-    /**
-     * @internal
-     */
-    toggleButtonClickHandler(e: Event): void;
-    /**
-     * @internal
-     */
-    toggleButtonChangeHandler(e: Event): void;
-    /**
-     * @internal
-     */
-    toggleButtonKeyDownHandler(e: KeyboardEvent): boolean;
-    /**
-     * @internal
-     */
-    filterOptions(): void;
-    /**
-     * @internal
-     */
-    inputHandler(e: InputEvent): boolean;
-    keydownHandler(e: KeyboardEvent): boolean;
-    /**
-     * @internal
-     */
-    keyupHandler(e: KeyboardEvent): boolean;
-    /**
-     * @internal
-     */
-    focusoutHandler(e: FocusEvent): boolean;
-    /**
-     * Reset the element to its first selectable option when its parent form is reset.
-     *
-     * @internal
-     */
-    formResetCallback(): void;
-    /** {@inheritDoc (FormAssociated:interface).validate} */
-    validate(): void;
-    /**
-     * Set the default selected options at initialization or reset.
-     *
-     * @internal
-     * @remarks
-     * Overrides `Listbox.setDefaultSelectedOption`
-     */
-    setDefaultSelectedOption(): void;
-    /**
-     * @internal
-     */
-    selectedIndexChanged(prev: number | undefined, next: number): void;
-    /**
-     * Synchronize the `aria-disabled` property when the `disabled` property changes.
-     *
-     * @internal
-     */
-    disabledChanged(prev: boolean, next: boolean): void;
-    /**
-     * Move focus to the previous selectable option.
-     *
-     * @internal
-     * @remarks
-     * Overrides `Listbox.selectPreviousOption`
-     */
-    selectPreviousOption(): void;
-    /**
-     * @internal
-     */
-    setPositioning(): void;
-    /**
-     * Focus the control and scroll the first selected option into view.
-     *
-     * @internal
-     * @remarks
-     * Overrides: `Listbox.focusAndScrollOptionIntoView`
-     */
-    protected focusAndScrollOptionIntoView(): void;
-    protected openChanged(): void;
-    protected placeholderChanged(): void;
-    /**
-     * Ensure that the entire list of options is used when setting the selected property.
-     * @internal
-     * @remarks
-     * Overrides: `Listbox.selectedOptionsChanged`
-     */
-    protected selectedOptionsChanged(_: ListboxOption[] | undefined, next: ListboxOption[]): void;
-    protected positionChanged(_: SelectPosition | undefined, next: SelectPosition | undefined): void;
-    private regionChanged;
-    private controlWrapperChanged;
-    private ariaLabelChanged;
-    private maxHeightChanged;
-    /**
-     * Sets the value and to match the first selected option.
-     */
-    private updateValue;
-    /**
-     * Focus and set the content of the control based on the first selected option.
-     */
-    private setInputToSelection;
-    /**
-     * Focus, set and select the content of the control based on the first selected option.
-     */
-    private setInlineSelection;
-    private clearSelectionRange;
-    /**
-     * Determines if a value update should involve emitting a change event, then updates the value.
-     */
-    private syncValue;
-    private updateListboxMaxHeightCssVariable;
-    private updateInputAriaLabel;
-    /**
-     * This will only emit a `change` event after text entry where the text in the input prior to
-     * typing is different than the text present upon an attempt to commit (e.g. pressing <Enter>).
-     * So, for a concrete example:
-     * 1) User types 'Sue' (when Combobox input was blank).
-     * 2) User presses <Enter> -> 'change' event fires
-     * 3) User deletes 'Sue'
-     * 4) User re-types 'Sue'
-     * 5) User presses <Enter> -> NO 'change' event is fired
-     */
-    private emitChangeIfValueUpdated;
-}
-export interface Combobox extends StartEnd, DelegatesARIACombobox {
-}
-export declare const comboboxTag = "nimble-combobox";

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

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

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

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

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

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

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

@@ -1,2 +0,0 @@
-import { ComboboxAutocomplete } from '@microsoft/fast-foundation';
-export { ComboboxAutocomplete };

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

@@ -1,70 +0,0 @@
-import { ARIAGlobalStatesAndProperties, FoundationElement } from '@microsoft/fast-foundation';
-import { UserDismissed } from '../patterns/dialog/types';
-export { UserDismissed };
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-dialog': Dialog;
-    }
-}
-/**
- * A nimble-styled dialog.
- */
-export declare class Dialog<CloseReason = void> extends FoundationElement {
-    static readonly UserDismissed: symbol;
-    /**
-     * @public
-     * @description
-     * Prevents dismissing the dialog via the Escape key
-     */
-    preventDismiss: boolean;
-    /**
-     * @public
-     * @description
-     * Hides the header of the dialog.
-     */
-    headerHidden: boolean;
-    /**
-     * @public
-     * @description
-     * Hides the footer of the dialog.
-     */
-    footerHidden: boolean;
-    /**
-     * The ref to the internal dialog element.
-     *
-     * @internal
-     */
-    readonly dialogElement: HTMLDialogElement;
-    /** @internal */
-    footerIsEmpty: boolean;
-    /** @internal */
-    readonly slottedFooterElements?: HTMLElement[];
-    /**
-     * True if the dialog is open/showing, false otherwise
-     */
-    get open(): boolean;
-    private resolveShow?;
-    /**
-     * Opens the dialog
-     * @returns Promise that is resolved when the dialog is closed. The value of the resolved Promise is the reason value passed to the close() method, or UserDismissed if the dialog was closed via the ESC key.
-     */
-    show(): Promise<CloseReason | UserDismissed>;
-    /**
-     * Closes the dialog
-     * @param reason An optional value indicating how/why the dialog was closed.
-     */
-    close(reason: CloseReason): void;
-    slottedFooterElementsChanged(_prev: HTMLElement[] | undefined, next: HTMLElement[] | undefined): void;
-    /**
-     * @internal
-     */
-    cancelHandler(event: Event): boolean;
-    /**
-     * @internal
-     */
-    closeHandler(event: Event): void;
-    private doResolveShow;
-}
-export interface Dialog extends ARIAGlobalStatesAndProperties {
-}
-export declare const dialogTag = "nimble-dialog";

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

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

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

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

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

@@ -1,55 +0,0 @@
-import { ARIAGlobalStatesAndProperties, FoundationElement } from '@microsoft/fast-foundation';
-import { UserDismissed } from '../patterns/dialog/types';
-import { DrawerLocation } from './types';
-export { UserDismissed };
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-drawer': Drawer;
-    }
-}
-/**
- * Drawer control. Shows content in a panel on the left / right side of the screen,
- * which animates to be visible with a slide-in / slide-out animation.
- */
-export declare class Drawer<CloseReason = void> extends FoundationElement {
-    static readonly UserDismissed: symbol;
-    location: DrawerLocation;
-    preventDismiss: boolean;
-    dialog: HTMLDialogElement;
-    private closing;
-    private resolveShow?;
-    private closeReason;
-    /**
-     * True if the drawer is open, opening, or closing. Otherwise, false.
-     */
-    get open(): boolean;
-    /**
-     * Opens the drawer
-     * @returns Promise that is resolved when the drawer finishes closing. The value of the resolved
-     * Promise is the reason value passed to the close() method, or UserDismissed if the drawer was
-     * closed via the ESC key.
-     */
-    show(): Promise<CloseReason | UserDismissed>;
-    /**
-     * Closes the drawer
-     * @param reason An optional value indicating how/why the drawer was closed.
-     */
-    close(reason: CloseReason): void;
-    /**
-     * @internal
-     */
-    cancelHandler(event: Event): boolean;
-    /**
-     * @internal
-     */
-    closeHandler(event: Event): void;
-    private doResolveShow;
-    private readonly animationEndHandlerFunction;
-    private openDialog;
-    private closeDialog;
-    private triggerAnimation;
-    private animationEndHandler;
-}
-export interface Drawer extends ARIAGlobalStatesAndProperties {
-}
-export declare const drawerTag = "nimble-drawer";

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

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

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

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

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

@@ -1,5 +0,0 @@
-export declare const DrawerLocation: {
-    readonly left: "left";
-    readonly right: "right";
-};
-export type DrawerLocation = (typeof DrawerLocation)[keyof typeof DrawerLocation];

package/dist/esm/src/icon-base/index.d.ts

@@ -1,19 +0,0 @@
-import { FoundationElement } from '@microsoft/fast-foundation';
-import type { NimbleIcon } from '@ni/nimble-tokens/dist/icons/js';
-import type { IconSeverity } from './types';
-/**
- * The base class for icon components
- */
-export declare class Icon extends FoundationElement {
-    readonly icon: NimbleIcon;
-    /**
-     * @public
-     * @remarks
-     * HTML Attribute: severity
-     */
-    severity: IconSeverity;
-    constructor(/** @internal */ icon: NimbleIcon);
-}
-type IconClass = typeof Icon;
-export declare const registerIcon: (baseName: string, iconClass: IconClass) => void;
-export {};

package/dist/esm/src/icon-base/styles.d.ts

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

package/dist/esm/src/icon-base/template.d.ts

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

package/dist/esm/src/icon-base/types.d.ts

@@ -1,12 +0,0 @@
-/**
- * Predefined icon appearance states
- * @public
- */
-export declare const IconSeverity: {
-    readonly default: undefined;
-    readonly error: "error";
-    readonly warning: "warning";
-    readonly success: "success";
-    readonly information: "information";
-};
-export type IconSeverity = (typeof IconSeverity)[keyof typeof IconSeverity];

package/dist/esm/src/icons/add.d.ts

@@ -1,13 +0,0 @@
-import { Icon } from '../icon-base';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-icon-add': IconAdd;
-    }
-}
-/**
- * The icon component for the 'add' icon
- */
-export declare class IconAdd extends Icon {
-    constructor();
-}
-export declare const iconAddTag = "nimble-icon-add";