@ni/nimble-components 19.4.0 → 19.4.1

package/dist/esm/src/icons/up-right-from-square.d.ts

@@ -0,0 +1,13 @@
+import { Icon } from '../icon-base';
+declare global {
+    interface HTMLElementTagNameMap {
+        'nimble-icon-up-right-from-square': IconUpRightFromSquare;
+    }
+}
+/**
+ * The icon component for the 'upRightFromSquare' icon
+ */
+export declare class IconUpRightFromSquare extends Icon {
+    constructor();
+}
+export declare const iconUpRightFromSquareTag: string;

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

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

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

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

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

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

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

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

package/dist/esm/src/icons/webvi-custom.d.ts

@@ -0,0 +1,13 @@
+import { Icon } from '../icon-base';
+declare global {
+    interface HTMLElementTagNameMap {
+        'nimble-icon-webvi-custom': IconWebviCustom;
+    }
+}
+/**
+ * The icon component for the 'webviCustom' icon
+ */
+export declare class IconWebviCustom extends Icon {
+    constructor();
+}
+export declare const iconWebviCustomTag: string;

package/dist/esm/src/icons/webvi-host.d.ts

@@ -0,0 +1,13 @@
+import { Icon } from '../icon-base';
+declare global {
+    interface HTMLElementTagNameMap {
+        'nimble-icon-webvi-host': IconWebviHost;
+    }
+}
+/**
+ * The icon component for the 'webviHost' icon
+ */
+export declare class IconWebviHost extends Icon {
+    constructor();
+}
+export declare const iconWebviHostTag: string;

package/dist/esm/src/icons/window-code.d.ts

@@ -0,0 +1,13 @@
+import { Icon } from '../icon-base';
+declare global {
+    interface HTMLElementTagNameMap {
+        'nimble-icon-window-code': IconWindowCode;
+    }
+}
+/**
+ * The icon component for the 'windowCode' icon
+ */
+export declare class IconWindowCode extends Icon {
+    constructor();
+}
+export declare const iconWindowCodeTag: string;

package/dist/esm/src/icons/window-text.d.ts

@@ -0,0 +1,13 @@
+import { Icon } from '../icon-base';
+declare global {
+    interface HTMLElementTagNameMap {
+        'nimble-icon-window-text': IconWindowText;
+    }
+}
+/**
+ * The icon component for the 'windowText' icon
+ */
+export declare class IconWindowText extends Icon {
+    constructor();
+}
+export declare const iconWindowTextTag: string;

package/dist/esm/src/icons/wrench-hammer.d.ts

@@ -0,0 +1,13 @@
+import { Icon } from '../icon-base';
+declare global {
+    interface HTMLElementTagNameMap {
+        'nimble-icon-wrench-hammer': IconWrenchHammer;
+    }
+}
+/**
+ * The icon component for the 'wrenchHammer' icon
+ */
+export declare class IconWrenchHammer extends Icon {
+    constructor();
+}
+export declare const iconWrenchHammerTag: string;

package/dist/esm/src/icons/xmark-check.d.ts

@@ -0,0 +1,13 @@
+import { Icon } from '../icon-base';
+declare global {
+    interface HTMLElementTagNameMap {
+        'nimble-icon-xmark-check': IconXmarkCheck;
+    }
+}
+/**
+ * The icon component for the 'xmarkCheck' icon
+ */
+export declare class IconXmarkCheck extends Icon {
+    constructor();
+}
+export declare const iconXmarkCheckTag: string;

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

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

package/dist/esm/src/list-option/index.d.ts

@@ -0,0 +1,15 @@
+import { ListboxOption as FoundationListboxOption } from '@microsoft/fast-foundation';
+declare global {
+    interface HTMLElementTagNameMap {
+        'nimble-list-option': ListOption;
+    }
+}
+/**
+ * A nimble-styled HTML listbox option
+ */
+export declare class ListOption extends FoundationListboxOption {
+    get value(): string;
+    set value(value: string);
+    connectedCallback(): void;
+}
+export declare const listOptionTag: string;

package/dist/esm/src/list-option/styles.d.ts

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

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

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

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

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

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

@@ -0,0 +1,54 @@
+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

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

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

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

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

@@ -0,0 +1,22 @@
+/**
+ * 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

@@ -0,0 +1,12 @@
+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

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

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

@@ -0,0 +1,25 @@
+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

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

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

@@ -0,0 +1,9 @@
+/**
+ * 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

@@ -0,0 +1,2 @@
+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

@@ -0,0 +1,48 @@
+/**
+ * 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";
+};
+export declare type ButtonAppearanceVariant = (typeof ButtonAppearanceVariant)[keyof typeof ButtonAppearanceVariant];

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

@@ -0,0 +1,6 @@
+/**
+ * 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

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

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

@@ -0,0 +1,19 @@
+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

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

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

@@ -0,0 +1,2 @@
+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

@@ -0,0 +1,10 @@
+/**
+ * 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/tab/styles.d.ts

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

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

@@ -0,0 +1,12 @@
+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

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

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

@@ -0,0 +1,14 @@
+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

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

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

@@ -0,0 +1,34 @@
+import { AnchoredRegion, Select as FoundationSelect } from '@microsoft/fast-foundation';
+import { DropdownAppearance } from '../patterns/dropdown/types';
+import type { ErrorPattern } from '../patterns/error/types';
+declare global {
+    interface HTMLElementTagNameMap {
+        'nimble-select': Select;
+    }
+}
+/**
+ * A nimble-styled HTML select
+ */
+export declare class Select extends FoundationSelect implements ErrorPattern {
+    appearance: DropdownAppearance;
+    /**
+     * A message explaining why the value is invalid.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: error-text
+     */
+    errorText: string | undefined;
+    errorVisible: boolean;
+    /**
+     * @internal
+     */
+    region?: AnchoredRegion;
+    setPositioning(): void;
+    slottedOptionsChanged(prev: Element[], next: Element[]): void;
+    private regionChanged;
+    private controlChanged;
+    private maxHeightChanged;
+    private updateListboxMaxHeightCssVariable;
+}
+export declare const selectTag: string;

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

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

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

@@ -0,0 +1,4 @@
+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/types.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Types of dropdown appearance.
+ * @public
+ */
+export { DropdownAppearance } from '../patterns/dropdown/types';

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

@@ -0,0 +1,13 @@
+import { FoundationElement } from '@microsoft/fast-foundation';
+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 {
+}
+export declare const spinnerTag: string;

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

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

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

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

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

@@ -0,0 +1,12 @@
+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: string;

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

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

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

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

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

@@ -0,0 +1,12 @@
+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: string;

package/dist/esm/src/tab-panel/index.d.ts

@@ -0,0 +1,12 @@
+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: string;

package/dist/esm/src/tab-panel/styles.d.ts

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