@nvidia-elements/core 2.2.0 → 2.2.2

package/dist/bundles/index.d.ts

@@ -876,15 +876,15 @@ export interface ButtonFormControlMixinInstance {
 	 */
 	expanded: boolean;
 	/**
-	 * Like input readonly, sets a button semantically as visual treatment only.
+	 * Indicates whether the element is a noninteractive visual treatment instead of a button.
 	 * https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly
 	 * @attr readonly
 	 * @reflect
 	 */
 	readOnly: boolean;
 	/**
-	 * Like input form, sets a button to submit a form outside its parent form.
-	 * Returns a reference to the form element if available.
+	 * Associates the button with a form. Set the property to a form element or its ID. The HTML attribute accepts only
+	 * the form ID. Reading the property returns the associated form element or `null`.
 	 * https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/form
 	 * @attr form
 	 */
@@ -1078,7 +1078,7 @@ export declare class IconButton extends Button {
  * @documentation https://nvidia.github.io/elements/docs/elements/accordion/
  * @since 0.12.0
  * @entrypoint \@nvidia-elements/core/accordion
- * @slot - default content slot
+ * @slot - Heading text and supporting content that labels the accordion section.
  * @slot prefix - slot for prefix content
  * @slot suffix - slot for suffix content
  * @cssprop --cursor
@@ -1093,6 +1093,7 @@ export declare class AccordionHeader extends LitElement {
 	/** @private */
 	_internals: ElementInternals;
 	render(): TemplateResult<1>;
+	/** @private */
 	slot: string;
 	connectedCallback(): void;
 }
@@ -1123,14 +1124,13 @@ export declare class AccordionContent extends LitElement {
  * @command --open - use to open the accordion
  * @command --close - use to close the accordion
  * @command --toggle - use to toggle the accordion
- * @slot - This is a default/unnamed slot for accordion content
+ * @slot - Content displayed in the collapsible region, typically an `nve-accordion-content` element.
  * @slot icon-button - icon elements to display for expand/collapse
  * @slot header - header element (Use `accordion-header` or custom content)
- * @slot content - content element (Use `accordion-content` or custom content)
  * @cssprop --background
  * @cssprop --color
  * @cssprop --border-radius
- * @cssprop --header-padding
+ * @cssprop --header-padding - Padding around the header content.
  * @cssprop --cursor
  * @cssprop --transition
  * @csspart icon-button - The toggle icon button element
@@ -1197,7 +1197,9 @@ export declare class AccordionGroup extends LitElement {
 	 * Determines whether the accordion should opt-in to stateful expansion of a single accordion at a time
 	 */
 	behaviorExpandSingle: boolean;
-	/** flat (Borderless, container-less accordions), full (default), or inset (Rounded corner, contained accordion) */
+	/**
+	 * Controls the container style applied to child accordions. `flat` removes the visual container, `inset` adds rounded containment, and omission uses the default divided presentation.
+	 */
 	container?: Extract<Container, "flat" | "inset">;
 	static readonly metadata: {
 		tag: string;
@@ -1308,7 +1310,7 @@ export declare class AlertGroup extends LitElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/avatar/
  * @since 1.20.0
  * @entrypoint \@nvidia-elements/core/avatar
- * @slot - default slot for content
+ * @slot - Initials, an image, or other content that identifies the represented user or bot.
  * @cssprop --background
  * @cssprop --color
  * @cssprop --border-radius
@@ -1337,7 +1339,7 @@ export declare class Avatar extends LitElement {
  * @description An avatar group displays a collection of user avatars in a compact and organized layout, showcasing many participants or contributors in a space-efficient way.
  * @since 1.20.0
  * @entrypoint \@nvidia-elements/core/avatar
- * @slot - default slot for content
+ * @slot - `nve-avatar` elements that represent the group members.
  * @aria https://www.w3.org/WAI/ARIA/apg/patterns/alert/
  *
  */
@@ -1358,7 +1360,7 @@ export declare class AvatarGroup extends LitElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/badge/
  * @since 0.11.0
  * @entrypoint \@nvidia-elements/core/badge
- * @slot - default slot for content
+ * @slot - Short text that communicates the badge status.
  * @slot prefix-icon - slot for prefix icon
  * @slot suffix-icon - slot for suffix icon
  * @cssprop --background
@@ -1524,7 +1526,7 @@ export declare class Card extends LitElement implements ContainerElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/card/
  * @since 0.1.3
  * @entrypoint \@nvidia-elements/core/card
- * @slot - default slot
+ * @slot - Card title, supporting text, and optional action controls.
  * @cssprop --padding
  * @cssprop --border-bottom
  * @cssprop --line-height
@@ -1538,6 +1540,7 @@ export declare class CardHeader extends LitElement {
 		version: string;
 		parents: string[];
 	};
+	/** @private */
 	slot: string;
 	render(): TemplateResult<1>;
 }
@@ -1578,6 +1581,7 @@ export declare class CardFooter extends LitElement {
 		version: string;
 		parents: string[];
 	};
+	/** @private */
 	slot: string;
 	render(): TemplateResult<1>;
 }
@@ -1587,7 +1591,7 @@ export declare class CardFooter extends LitElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/chat-message/
  * @since 1.25.0
  * @entrypoint \@nvidia-elements/core/chat-message
- * @slot - default slot for content
+ * @slot - The message body displayed between the prefix and suffix content.
  * @slot prefix - for avatar/img content
  * @slot suffix - for avatar/img content
  * @cssprop --background
@@ -1607,8 +1611,10 @@ export declare class ChatMessage extends LitElement {
 		tag: string;
 		version: string;
 	};
+	/** Applies a transparent background and reduced horizontal padding for embedding the message in another container. */
 	container: "flat";
 	color: Color;
+	/** Removes the border radius from the selected message corner to indicate the speaker direction. */
 	arrowPosition: "top-start" | "top-end" | "bottom-start" | "bottom-end";
 	render(): TemplateResult<1>;
 	connectedCallback(): void;
@@ -1714,7 +1720,7 @@ export type ValidityStateError = "badInput" | "customError" | "patternMismatch"
  * @documentation https://nvidia.github.io/elements/docs/elements/control/
  * @since 0.3.0
  * @entrypoint \@nvidia-elements/core/forms
- * @slot - default slot for content
+ * @slot - Validation or supporting message text for the associated control.
  * @cssprop --color
  * @cssprop --font-weight
  * @cssprop --font-size
@@ -1740,6 +1746,7 @@ export declare class ControlMessage extends LitElement {
 	static elementDefinitions: {
 		[Icon.metadata.tag]: typeof Icon;
 	};
+	/** @private */
 	slot: string;
 	render(): TemplateResult<1>;
 }
@@ -1856,7 +1863,7 @@ declare const MenuItem_base: ButtonFormControlMixinReturn<typeof LitElement>;
  * @documentation https://nvidia.github.io/elements/docs/elements/menu/
  * @since 0.11.0
  * @entrypoint \@nvidia-elements/core/menu
- * @slot - default slot for content
+ * @slot - Label and supporting content for the menu option.
  * @slot suffix - slot for suffix icon
  * @cssprop --background
  * @cssprop --border-radius
@@ -1877,6 +1884,7 @@ declare const MenuItem_base: ButtonFormControlMixinReturn<typeof LitElement>;
  */
 export declare class MenuItem extends MenuItem_base {
 	static styles: CSSResult[];
+	/** Applies danger styling to destructive or high-risk menu actions. */
 	status: "danger";
 	static readonly metadata: {
 		tag: string;
@@ -1961,6 +1969,7 @@ export declare class Dropdown extends LitElement {
 	modal: boolean;
 	/** @private */
 	popoverType: PopoverType;
+	/** @private */
 	popoverArrow: HTMLElement;
 	protected typeNativePopoverController: TypeNativePopoverController<Dropdown>;
 	/** @private */
@@ -2023,7 +2032,7 @@ declare const Tag_base: ButtonFormControlMixinReturn<typeof LitElement>;
  * @documentation https://nvidia.github.io/elements/docs/elements/tag/
  * @since 0.10.0
  * @entrypoint \@nvidia-elements/core/tag
- * @slot - default slot for content
+ * @slot - Text or other content that identifies the category or group.
  * @cssprop --background
  * @cssprop --color
  * @cssprop --gap
@@ -2141,7 +2150,7 @@ export declare class Combobox extends Control implements ContainerElement {
  * @event toggle - Dispatched on a popover element just after showing or hiding. [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event)
  * @event open - Dispatched when the toast opens.
  * @event close - Dispatched when the toast closes.
- * @slot - default content slot
+ * @slot - The message communicated by the toast.
  * @slot prefix - custom status icon slot
  * @cssprop --padding
  * @cssprop --justify-content
@@ -2233,7 +2242,7 @@ export declare class Toast extends LitElement {
  * @event toggle - Dispatched on a popover element just after showing or hiding. [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event)
  * @event open - Dispatched when the tooltip opens.
  * @event close - Dispatched when the tooltip closes.
- * @slot - default content slot
+ * @slot - Noninteractive text or other descriptive content shown in the tooltip.
  * @cssprop --border-radius
  * @cssprop --background
  * @cssprop --color
@@ -2287,6 +2296,7 @@ export declare class Tooltip extends LitElement {
 	 * @deprecated Use interest-delay-start css property instead
 	 */
 	openDelay: number;
+	/** @private */
 	popoverArrow: HTMLElement;
 	/** @private */
 	readonly popoverType: PopoverType;
@@ -2302,7 +2312,7 @@ export declare class Tooltip extends LitElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/copy-button/
  * @since 1.1.4
  * @entrypoint \@nvidia-elements/core/copy-button
- * @slot - default
+ * @slot - Text label displayed before the copy icon.
  * @slot icon - slot for custom icon
  * @cssprop --color
  * @cssprop --background
@@ -2437,7 +2447,7 @@ export declare class Datetime extends Control implements ContainerElement {
  * @event toggle - Dispatched on a popover element just after showing or hiding. [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event)
  * @event open - Dispatched when the dialog opens.
  * @event close - Dispatched when the dialog closes.
- * @slot - default content slot
+ * @slot - Dialog body content displayed between the header and footer.
  * @cssprop --border
  * @cssprop --border-radius
  * @cssprop --background
@@ -2633,7 +2643,7 @@ export declare class Dot extends LitElement {
  * @event toggle - Dispatched on a popover element just after showing or hiding. [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event)
  * @event open - Dispatched when the drawer opens.
  * @event close - Dispatched when the drawer closes.
- * @slot - default content slot
+ * @slot - Drawer body content displayed between the header and footer.
  * @cssprop --border
  * @cssprop --background
  * @cssprop --color
@@ -2785,8 +2795,6 @@ export declare class DrawerHeader extends LitElement {
  * @slot - default slot for dropdown content
  * @event open - Dispatched when a dropdown in the group opens
  * @event close - Dispatched when a dropdown in the group closes
- * @cssprop --nve-dropdown-group-spacing
- * @cssprop --nve-dropdown-group-transition
  * @cssprop --arrow-transform - Transform applied to the popover arrow
  * @aria https://www.w3.org/WAI/ARIA/apg/patterns/menubar/
  */
@@ -2802,6 +2810,7 @@ export declare class DropdownGroup extends LitElement {
 	render(): TemplateResult<1>;
 	connectedCallback(): void;
 	disconnectedCallback(): void;
+	/** Closes every descendant dropdown in the group. */
 	close(): void;
 }
 declare function fileTypeValidator(value: unknown, element: unknown): ValidatorResult;
@@ -2812,22 +2821,24 @@ declare const Dropzone_base: FormControlMixinReturn<typeof LitElement, File[]>;
  * @documentation https://nvidia.github.io/elements/docs/elements/dropzone/
  * @since 1.29.0
  * @entrypoint \@nvidia-elements/core/dropzone
+ * @property {File[]} value - Files selected or dropped by the user. Assign files through the JavaScript property; the HTML `value` attribute is not supported.
  * @event change - Dispatched when the value has changed (files located in event.target)
- * @slot - use only when custom messaging requires it
+ * @slot - Custom messaging that replaces the default upload instructions.
  * @cssprop --background
  * @cssprop --border-color
  * @cssprop --border-radius
  * @cssprop --padding
  * @cssprop --min-height
  * @cssprop --color
- * @slot icon - default slot for icon
- * @slot content - default slot for content
+ * @slot icon - Custom icon that replaces the default upload icon.
  * @csspart icon - The upload icon element
  * @aria https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file
  */
 export declare class Dropzone extends Dropzone_base {
 	#private;
+	/** Comma-separated file extensions or MIME types accepted by the dropzone. */
 	accept: string;
+	/** File size limit in bytes. */
 	maxFileSize: number;
 	/**
 	 * Enables internal string values to update for internationalization.
@@ -2862,6 +2873,7 @@ export declare class Dropzone extends Dropzone_base {
 	static elementDefinitions: {
 		[Icon.metadata.tag]: typeof Icon;
 	};
+	/** @protected */
 	formResetCallback(): void;
 	constructor();
 	connectedCallback(): void;
@@ -3042,7 +3054,7 @@ export declare class FormatNumber extends LitElement {
 	/**
 	 * Grouping separators: 'auto' | 'always' | 'min2' | 'true' | 'false'.
 	 */
-	useGrouping?: string;
+	useGrouping?: "auto" | "always" | "min2" | "true" | "false" | boolean;
 	/**
 	 * Pad fraction output to at least this many digits (0-20).
 	 */
@@ -3161,7 +3173,7 @@ export declare class Gauge extends LitElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/data-grid/
  * @since 0.11.0
  * @entrypoint \@nvidia-elements/core/grid
- * @slot - default slot for content
+ * @slot - Column heading text or controls.
  * @slot actions - slot for column actions
  * @cssprop --color
  * @cssprop --padding
@@ -3271,7 +3283,7 @@ export declare class GridRow extends LitElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/data-grid/
  * @since 0.11.0
  * @entrypoint \@nvidia-elements/core/grid
- * @slot - default slot for content
+ * @slot - Data or interactive controls displayed within the cell.
  * @cssprop --background
  * @cssprop --color
  * @cssprop --padding
@@ -3302,7 +3314,7 @@ export declare class GridCell extends LitElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/data-grid/
  * @since 0.11.0
  * @entrypoint \@nvidia-elements/core/grid
- * @slot - default slot for content
+ * @slot - `nve-grid-header`, `nve-grid-row`, and `nve-grid-placeholder` elements.
  * @slot footer - slot for grid-footer or toolbar
  * @cssprop --background
  * @cssprop --color
@@ -3352,7 +3364,7 @@ export declare class Grid extends LitElement implements ContainerElement {
  * @since 0.11.0
  * @entrypoint \@nvidia-elements/core/grid
  * @description Grid footer displays contextual information or user actions such as pagination.
- * @slot - default slot for content
+ * @slot - Grid summary, pagination, or other footer controls.
  * @cssprop --background
  * @cssprop --color
  * @cssprop --padding
@@ -3368,6 +3380,7 @@ export declare class GridFooter extends LitElement {
 	static elementDefinitions: {};
 	/** @private */
 	_internals: ElementInternals;
+	/** @private */
 	slot: string;
 	render(): TemplateResult<1>;
 	connectedCallback(): void;
@@ -3377,7 +3390,7 @@ export declare class GridFooter extends LitElement {
  * @since 0.11.0
  * @entrypoint \@nvidia-elements/core/grid
  * @description Placeholder displays a message while data loads for the grid or shows empty states for datasets.
- * @slot - default slot for content
+ * @slot - Loading or empty-state message displayed in place of grid rows.
  * @cssprop --color
  * @cssprop --padding
  * @aria https://www.w3.org/WAI/ARIA/apg/patterns/grid/
@@ -3460,7 +3473,7 @@ export declare class InputGroup extends ControlGroup {
  * @documentation https://nvidia.github.io/elements/docs/elements/logo/
  * @since 0.10.0
  * @entrypoint \@nvidia-elements/core/logo
- * @slot - default slot for content
+ * @slot - Text, an image, or other visual content representing the brand or application.
  * @cssprop --background
  * @cssprop --gap
  * @cssprop --color
@@ -3531,7 +3544,7 @@ export declare class Month extends Control implements ContainerElement {
  * @event toggle - Dispatched on a popover element just after showing or hiding. [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event)
  * @event open - Dispatched when the notification opens.
  * @event close - Dispatched when the notification closes.
- * @slot - default content slot
+ * @slot - The message communicated by the notification.
  * @slot icon - content slot for the status icon
  * @cssprop --border-radius
  * @cssprop --background
@@ -3712,7 +3725,7 @@ export declare class Page extends LitElement {
  * @since 1.15.0
  * @event open - Dispatched after an invoker command removes `hidden` and opens the panel.
  * @event close - Dispatched after an invoker command sets `hidden` and closes the panel.
- * @slot - default content slot
+ * @slot - `nve-page-panel-content` elements that provide the panel body.
  * @slot actions - slot for action / dismiss buttons
  * @command --open - Removes `hidden` and dispatches `open`.
  * @command --close - Sets `hidden` and dispatches `close`.
@@ -3795,6 +3808,7 @@ export declare class PagePanelFooter extends LitElement {
 		tag: string;
 		version: string;
 	};
+	/** @private */
 	slot: string;
 	render(): TemplateResult<1>;
 }
@@ -3817,6 +3831,7 @@ export declare class PagePanelHeader extends LitElement {
 		tag: string;
 		version: string;
 	};
+	/** @private */
 	slot: string;
 	render(): TemplateResult<1>;
 }
@@ -3901,7 +3916,7 @@ export declare class ProgressRing extends LitElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/page-loader/
  * @since 0.19.0
  * @entrypoint \@nvidia-elements/core/page-loader
- * @slot - default slot for content
+ * @slot - Loading status text displayed with the progress indicator.
  * @cssprop --gap
  * @cssprop --animation-duration - Duration of page loader open/close animations
  * @csspart progress-ring - The progress ring element
@@ -4002,8 +4017,8 @@ declare const Pagination_base: FormControlMixinReturn<typeof LitElement, number>
  * @event change - Dispatched when the value (page) has changed
  * @event first-page - Dispatched when the first page is active
  * @event last-page - Dispatched when the last page is active
- * @slot - default slot for content
- * @slot suffix-label - slot for overriding the "n of total" label when total is an approximation
+ * @event step-change - Dispatched after the page size changes with the current page size in `detail`. The event bubbles and crosses shadow boundaries.
+ * @slot suffix-label - Overrides the "of total" label when the total is an approximation.
  * @cssprop --background
  * @cssprop --font-size
  * @cssprop --width
@@ -4015,6 +4030,7 @@ declare const Pagination_base: FormControlMixinReturn<typeof LitElement, number>
  * @csspart select - The page size select element
  * @aria https://www.w3.org/WAI/ARIA/apg/patterns/toolbar/
  * @property {number} value - value the current page number
+ * @attribute {string} step-sizes - A JSON-serialized array of page-size options available in the selector.
  */
 export declare class Pagination extends Pagination_base {
 	#private;
@@ -4023,7 +4039,7 @@ export declare class Pagination extends Pagination_base {
 	 */
 	step: number;
 	/**
-	 * The array of custom step-size.
+	 * Page-size options available in the selector.
 	 */
 	stepSizes: number[];
 	/**
@@ -4282,6 +4298,8 @@ declare const PreferencesInput_base: FormControlMixinReturn<typeof LitElement, P
  * @documentation https://nvidia.github.io/elements/docs/elements/preferences-input/
  * @since 1.23.7
  * @entrypoint \@nvidia-elements/core/preferences-input
+ * @property {PreferencesInputValue} value - Contains the current color scheme, scale, and reduced motion preferences. Assign an object through JavaScript or provide its JSON serialization in the HTML `value` attribute.
+ * @attribute {string} value - JSON object parsed as `PreferencesInputValue`.
  * @event input - Dispatched when the value has changed
  * @event change - Dispatched when the value has changed
  * @cssprop --color
@@ -4371,7 +4389,7 @@ export declare class ProgressBar extends LitElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/progressive-filter-chip/
  * @since 0.16.0
  * @entrypoint \@nvidia-elements/core/progressive-filter-chip
- * @slot - default slot for content
+ * @slot - `input`, `select`, `nve-button`, or other `[nve-control]` elements used to build the filter.
  * @event close - Dispatched when the filter chip closes.
  * @cssprop --gap
  * @cssprop --border-radius
@@ -4614,7 +4632,7 @@ export declare class Search extends Control implements ContainerElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/skeleton/
  * @since 1.44.0
  * @entrypoint \@nvidia-elements/core/skeleton
- * @slot - default content slot
+ * @slot - Loaded content that replaces the placeholder when provided.
  * @cssprop --background
  * @cssprop --border-radius
  * @cssprop --min-height
@@ -4631,7 +4649,7 @@ export declare class Skeleton extends LitElement {
 	effect: "shimmer" | "pulse";
 	/** Geometry of the placeholder — rounded corners or a full pill outline. */
 	shape: "round" | "pill";
-	/** Whether the skeleton hides its content */
+	/** Hides the skeleton host when `true` and sets `aria-busy` to the inverse visibility state. */
 	hidden: boolean;
 	/** @private */
 	_internals: ElementInternals;
@@ -4801,7 +4819,7 @@ export declare class StepsItem extends StepsItem_base {
 	 */
 	selected: boolean;
 	/**
-	 * Four visual treatments represent the `status` of tasks. When `status` has a value of `warning`, `success`, or `danger`, the component embeds appropriate icons.
+	 * Controls the step status. `accent` has no default status icon, `danger` displays an alert icon, `success` displays a check icon, and `pending` displays a progress indicator. Omit the property to display the step number.
 	 */
 	status?: "accent" | "danger" | "success" | "pending";
 	/**
@@ -4871,7 +4889,7 @@ declare const TabsItem_base: ButtonFormControlMixinReturn<typeof LitElement>;
  * @documentation https://nvidia.github.io/elements/docs/elements/tabs/
  * @since 0.10.0
  * @entrypoint \@nvidia-elements/core/tabs
- * @slot - default slot for content
+ * @slot - The label displayed for the tab.
  * @cssprop --font-size
  * @cssprop --width
  * @cssprop --padding
@@ -5131,6 +5149,7 @@ export declare class Toggletip extends LitElement {
 	 * Determines if the component renders an arrow.
 	 */
 	arrow: boolean;
+	/** @private */
 	popoverArrow: HTMLElement;
 	/** @private */
 	readonly popoverType: PopoverType;
@@ -5196,7 +5215,7 @@ export declare class ToggletipHeader extends LitElement {
  * @documentation https://nvidia.github.io/elements/docs/elements/toolbar/
  * @since 0.19.0
  * @entrypoint \@nvidia-elements/core/toolbar
- * @slot - default slot for content
+ * @slot - Primary buttons, inputs, and other toolbar controls.
  * @slot prefix - slot for prefix content
  * @slot suffix - slot for suffix content
  * @cssprop --background
@@ -5311,8 +5330,11 @@ export declare class TreeNode extends LitElement {
 	 * Returns list of child nodes
 	 */
 	readonly nodes: TreeNode[];
+	/** @private */
 	indeterminate: boolean;
+	/** @private */
 	behaviorExpand: boolean;
+	/** @private */
 	behaviorSelect: boolean;
 	static metadata: {
 		tag: string;