@ni/nimble-components 20.5.1 → 20.5.3

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

@@ -1,29 +0,0 @@
-import { DesignTokensFor, LabelProviderBase } from '../base';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-label-provider-rich-text': LabelProviderRichText;
-    }
-}
-declare const supportedLabels: {
-    readonly toggleBold: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly toggleItalics: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly toggleBulletedList: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly toggleNumberedList: import("@microsoft/fast-foundation").DesignToken<string>;
-};
-/**
- * Label provider for the Nimble rich text component
- */
-export declare class LabelProviderRichText extends LabelProviderBase<typeof supportedLabels> implements DesignTokensFor<typeof supportedLabels> {
-    toggleBold: string | undefined;
-    toggleItalics: string | undefined;
-    toggleBulletedList: string | undefined;
-    toggleNumberedList: string | undefined;
-    protected readonly supportedLabels: {
-        readonly toggleBold: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly toggleItalics: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly toggleBulletedList: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly toggleNumberedList: import("@microsoft/fast-foundation").DesignToken<string>;
-    };
-}
-export declare const labelProviderRichTextTag: string;
-export {};

package/dist/esm/src/label-provider/rich-text/label-token-defaults.d.ts

@@ -1,6 +0,0 @@
-import type * as TokensNamespace from './label-tokens';
-declare type TokenName = keyof typeof TokensNamespace;
-export declare const richTextLabelDefaults: {
-    readonly [key in TokenName]: string;
-};
-export {};

package/dist/esm/src/label-provider/rich-text/label-tokens.d.ts

@@ -1,5 +0,0 @@
-import { DesignToken } from '@microsoft/fast-foundation';
-export declare const richTextToggleBoldLabel: DesignToken<string>;
-export declare const richTextToggleItalicsLabel: DesignToken<string>;
-export declare const richTextToggleBulletedListLabel: DesignToken<string>;
-export declare const richTextToggleNumberedListLabel: DesignToken<string>;

package/dist/esm/src/label-provider/table/index.d.ts

@@ -1,50 +0,0 @@
-import { DesignTokensFor, LabelProviderBase } from '../base';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-label-provider-table': LabelProviderTable;
-    }
-}
-declare const supportedLabels: {
-    readonly groupCollapse: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly groupExpand: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly groupsCollapseAll: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly cellActionMenu: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly columnHeaderGrouped: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly columnHeaderSortedAscending: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly columnHeaderSortedDescending: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly selectAll: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly groupSelectAll: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly rowSelect: import("@microsoft/fast-foundation").DesignToken<string>;
-    readonly rowOperationColumn: import("@microsoft/fast-foundation").DesignToken<string>;
-};
-/**
- * Label provider for the Nimble table (and its sub-components and columns)
- */
-export declare class LabelProviderTable extends LabelProviderBase<typeof supportedLabels> implements DesignTokensFor<typeof supportedLabels> {
-    groupCollapse: string | undefined;
-    groupExpand: string | undefined;
-    groupsCollapseAll: string | undefined;
-    cellActionMenu: string | undefined;
-    columnHeaderGrouped: string | undefined;
-    columnHeaderSortedAscending: string | undefined;
-    columnHeaderSortedDescending: string | undefined;
-    selectAll: string | undefined;
-    groupSelectAll: string | undefined;
-    rowSelect: string | undefined;
-    rowOperationColumn: string | undefined;
-    protected readonly supportedLabels: {
-        readonly groupCollapse: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly groupExpand: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly groupsCollapseAll: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly cellActionMenu: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly columnHeaderGrouped: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly columnHeaderSortedAscending: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly columnHeaderSortedDescending: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly selectAll: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly groupSelectAll: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly rowSelect: import("@microsoft/fast-foundation").DesignToken<string>;
-        readonly rowOperationColumn: import("@microsoft/fast-foundation").DesignToken<string>;
-    };
-}
-export declare const labelProviderTableTag: string;
-export {};

package/dist/esm/src/label-provider/table/label-token-defaults.d.ts

@@ -1,6 +0,0 @@
-import type * as TokensNamespace from './label-tokens';
-declare type TokenName = keyof typeof TokensNamespace;
-export declare const tableLabelDefaults: {
-    readonly [key in TokenName]: string;
-};
-export {};

package/dist/esm/src/label-provider/table/label-tokens.d.ts

@@ -1,12 +0,0 @@
-import { DesignToken } from '@microsoft/fast-foundation';
-export declare const tableGroupCollapseLabel: DesignToken<string>;
-export declare const tableGroupExpandLabel: DesignToken<string>;
-export declare const tableGroupsCollapseAllLabel: DesignToken<string>;
-export declare const tableCellActionMenuLabel: DesignToken<string>;
-export declare const tableColumnHeaderGroupedLabel: DesignToken<string>;
-export declare const tableColumnHeaderSortedAscendingLabel: DesignToken<string>;
-export declare const tableColumnHeaderSortedDescendingLabel: DesignToken<string>;
-export declare const tableSelectAllLabel: DesignToken<string>;
-export declare const tableGroupSelectAllLabel: DesignToken<string>;
-export declare const tableRowSelectLabel: DesignToken<string>;
-export declare const tableRowOperationColumnLabel: DesignToken<string>;

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

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

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

package/dist/esm/src/mapping/base/index.d.ts

@@ -1,18 +0,0 @@
-import { FoundationElement } from '@microsoft/fast-foundation';
-import type { MappingKey } from './types';
-/**
- * Base class for mapping configuration elements
- */
-export declare abstract class Mapping extends FoundationElement {
-    /**
-     * The data value that is mapped to another representation
-     */
-    key?: MappingKey;
-    /**
-     * In the case of a mapping that maps to text, this is that mapped text.
-     * For mappings to non-textual representations, this is a string that can
-     * be displayed in contexts such as group headers or tooltips and used as
-     * an accessible label.
-     */
-    text?: string;
-}

package/dist/esm/src/mapping/base/template.d.ts

@@ -1 +0,0 @@
-export declare const template: import("@microsoft/fast-element").ViewTemplate<any, any>;

package/dist/esm/src/mapping/base/types.d.ts

@@ -1 +0,0 @@
-export declare type MappingKey = string | number | boolean;

package/dist/esm/src/mapping/icon/index.d.ts

@@ -1,25 +0,0 @@
-import { Mapping } from '../base';
-import type { IconSeverity } from '../../icon-base/types';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-mapping-icon': MappingIcon;
-    }
-}
-/**
- * Maps a data value to an icon.
- * One or more may be added as children of a nimble-table-column-icon element to define
- * how specific data values should be displayed as icons in that column's cells.
- */
-export declare class MappingIcon extends Mapping {
-    icon?: string;
-    severity: IconSeverity;
-    /**
-     * @internal
-     * Calculated asynchronously by the icon mapping based on the configured icon value.
-     * When assigned, it corresponds to an element name that is resolved to type of Nimble Icon.
-     */
-    resolvedIcon?: string;
-    private resolveIconAsync;
-    private iconChanged;
-}
-export declare const mappingIconTag: string;

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

@@ -1,14 +0,0 @@
-import { Mapping } from '../base';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-mapping-spinner': MappingSpinner;
-    }
-}
-/**
- * Maps data values to a spinner.
- * One or more may be added as children of a nimble-table-column-icon element to define
- * which specific data values should be displayed as spinners in that column's cells.
- */
-export declare class MappingSpinner extends Mapping {
-}
-export declare const mappingSpinnerTag: string;

package/dist/esm/src/mapping/text/index.d.ts

@@ -1,14 +0,0 @@
-import { Mapping } from '../base';
-declare global {
-    interface HTMLElementTagNameMap {
-        'nimble-mapping-text': MappingText;
-    }
-}
-/**
- * Defines a mapping from one data value ('key' property) to display text ('text' property).
- * One or more may be added as children of a nimble-table-column-enum-text element to define
- * how a specific data value should be displayed as text in that column's cells.
- */
-export declare class MappingText extends Mapping {
-}
-export declare const mappingTextTag: string;

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

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

@@ -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 } 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

@@ -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 } 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

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

@@ -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: string;

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

@@ -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/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: string;

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

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

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