wabtec-internal-volt-basic-components 1.0.0 → 1.2.0

package/dist/types/components.d.ts

@@ -5,7 +5,8 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { BorderColors, Colors, IconColors } from "./definitions/colors";
+import { BorderColors, Colors, IconColors, Palettes, StaticGlobal } from "./definitions/colors";
+import { SelectedValueChangedEventDetail } from "./components/autocomplete/vds-basic-autocomplete.utils";
 import { VdsInputType } from "./components/input/vds-basic-input.utils";
 import { Spacing } from "./definitions/spacing";
 import { ShadowBox } from "./definitions/shadows";
@@ -13,11 +14,13 @@ import { CheckboxEvent } from "./components/checkbox/vds-checkbox.utils";
 import { BorderThickness } from "./definitions/thickness";
 import { GroupHeaderSize } from "./components/base-group-header/base-group-header";
 import { DropdownItemClickedEvent } from "./components/dropdown-item/vds-dropdown-item-clicked-event";
+import { Colors as Colors1 } from "./components";
 import { Typography } from "./definitions/typography";
 import { MenuItemClickedEvent } from "./components/menu-item/vds-menu-item";
 import { NotificationsCustomColors, NotificationStatus } from "./components/notification/vds-notification-utils";
 import { RadioButtonChecked } from "./components/radio-button/vds-radio-button.utils";
-export { BorderColors, Colors, IconColors } from "./definitions/colors";
+export { BorderColors, Colors, IconColors, Palettes, StaticGlobal } from "./definitions/colors";
+export { SelectedValueChangedEventDetail } from "./components/autocomplete/vds-basic-autocomplete.utils";
 export { VdsInputType } from "./components/input/vds-basic-input.utils";
 export { Spacing } from "./definitions/spacing";
 export { ShadowBox } from "./definitions/shadows";
@@ -25,6 +28,7 @@ export { CheckboxEvent } from "./components/checkbox/vds-checkbox.utils";
 export { BorderThickness } from "./definitions/thickness";
 export { GroupHeaderSize } from "./components/base-group-header/base-group-header";
 export { DropdownItemClickedEvent } from "./components/dropdown-item/vds-dropdown-item-clicked-event";
+export { Colors as Colors1 } from "./components";
 export { Typography } from "./definitions/typography";
 export { MenuItemClickedEvent } from "./components/menu-item/vds-menu-item";
 export { NotificationsCustomColors, NotificationStatus } from "./components/notification/vds-notification-utils";
@@ -89,6 +93,10 @@ export namespace Components {
         "value": string;
     }
     interface VdsAvatar {
+        /**
+          * Name of the icon to show as overlay on hover. If not set, no overlay is shown.
+         */
+        "overlayIcon"?: string;
         /**
           * Set icon size in px or rem, IE: 32px or 1.25rem
           * @default '20px'
@@ -156,7 +164,7 @@ export namespace Components {
           * Sets the color of the badge, it provides special colors such as warning, danger, healthy, information, neutral If you pass a color from out pallete it will consider as custom. The color will be applied as background color; To fully customize please refer to props contentColor and borderFocusColor.
           * @default 'neutral'
          */
-        "statusColor": 'warning' | 'danger' | 'healthy' | 'information' | 'neutral';
+        "statusColor": 'warning' | 'danger' | 'healthy' | 'information' | 'neutral' | Colors;
         /**
           * Sets the text value of the badge.
          */
@@ -411,7 +419,7 @@ export namespace Components {
     }
     interface VdsBasicDropdown {
         /**
-          * Toggles the floating container auto-positioning based on available window space.  False by default as it may cause positioning issues in some situations, use with caution
+          * Toggles the floating container auto-positioning based on available window space. False by default as it may cause positioning issues in some situations, use with caution
           * @default false
          */
         "autoPosition": boolean;
@@ -592,7 +600,7 @@ export namespace Components {
         "allowedStyles": { [key: string]: string }[];
         /**
           * Clears value prop from the vds-input element.
-          * @returns Promise<voiid>
+          * @returns Promise<void>
          */
         "clear": () => Promise<void>;
         /**
@@ -646,6 +654,7 @@ export namespace Components {
         "type": VdsInputType;
         /**
           * Sets the input value.
+          * @default ""
          */
         "value": string;
     }
@@ -813,6 +822,11 @@ export namespace Components {
           * @default true
          */
         "autogrow": boolean;
+        /**
+          * Clears value prop from the vds-basic-textarea element.
+          * @returns Promise<void>
+         */
+        "clear": () => Promise<void>;
         /**
           * Sets the textarea in disabled state.
          */
@@ -869,6 +883,7 @@ export namespace Components {
         "size": "small" | "medium" | "large";
         /**
           * Sets the textarea's value.
+          * @default ""
          */
         "value": string;
         /**
@@ -876,6 +891,18 @@ export namespace Components {
          */
         "width": string;
     }
+    interface VdsBreadcrumbsItem {
+        /**
+          * Sets the breacrumb item in disabled state
+          * @default false
+         */
+        "disabled": boolean;
+        /**
+          * Sets the breacrumb item in active state
+          * @default false
+         */
+        "isActive": boolean;
+    }
     interface VdsButton {
         /**
           * Enable button's danger/error state
@@ -1116,7 +1143,7 @@ export namespace Components {
           * Set the divider line color
           * @default 'color-border-low'
          */
-        "color": BorderColors;
+        "color": BorderColors | StaticGlobal | Palettes;
         /**
           * Define divider orientation horizontal or vertical
           * @default 'horizontal'
@@ -1325,6 +1352,20 @@ export namespace Components {
           * Defines the value in the avatar component
          */
         "avatar": string;
+        /**
+          * Sets the aria label in badge
+         */
+        "badgeAriaLabel": string;
+        /**
+          * Sets the status color for badge
+          * @default "neutral"
+         */
+        "badgeStatusColor": "warning" | "danger" | "healthy" | "information" | "neutral" | Colors1;
+        /**
+          * Shows/hides badge dot to show notification or status
+          * @default false
+         */
+        "showBadge": boolean;
         /**
           * Allow hide/show User-Section
           * @default true
@@ -1346,7 +1387,7 @@ export namespace Components {
         "alt": string;
         /**
           * Set icon color based in volt palette
-          * @default 'brand-main'
+          * @default 'static-brand-main'
          */
         "color": IconColors | Colors;
         /**
@@ -1997,6 +2038,7 @@ export namespace Components {
         "setFocus": () => Promise<void>;
         /**
           * Sets the input's value.
+          * @default ""
          */
         "value": string;
     }
@@ -2017,6 +2059,68 @@ export namespace Components {
          */
         "width": string;
     }
+    interface VdsStepperItem {
+        /**
+          * Internal prop, it is used along side with `vds-vertical-stepper` on content inside mode (text-alignment='left') When true, the item stepper display the slot content of the element  without being manage by the `vds-vertical-stepper` or `vds-horizontal-stepper`
+          * @default false
+         */
+        "activeContent": boolean;
+        /**
+          * Sets the stepper in disabled state
+          * @default false
+         */
+        "disabled": boolean;
+        /**
+          * Internal prop, it is used along side with `vds-vertical-stepper` on content inside mode (text-alignment='left') When true, the item stepper renders a vds-divider after the header
+          * @default false
+         */
+        "divider": boolean;
+        /**
+          * Sets the icon inside the circle in the stepper. When set, the icon will override the text value
+          * @default ''
+         */
+        "icon": string;
+        /**
+          * Internal prop, it is used along side with `vds-vertical-stepper` on content inside mode (text-alignment='left') When true, the item stepper can render divider and activeContent
+          * @default false
+         */
+        "manageContent": boolean;
+        /**
+          * Sets the stepper state
+          * @default 'default'
+         */
+        "state": 'default' | 'completed' | 'error';
+        /**
+          * Sets the text inside the circle in the stepper
+          * @default ''
+         */
+        "text": string;
+        /**
+          * Sets the text alignment
+          * @default 'left'
+         */
+        "textAlignment": 'center' | 'left';
+    }
+    interface VdsStepperItemHeader {
+        /**
+          * Define the text in the description label
+         */
+        "description": string;
+        /**
+          * Sets the stepper item header in disabled state
+          * @default false
+         */
+        "disabled": boolean;
+        /**
+          * Sets the text alignment
+          * @default 'left'
+         */
+        "textAlignment": 'center' | 'left';
+        /**
+          * Define the text in the title label
+         */
+        "title": string;
+    }
     interface VdsSwitch {
         /**
           * Sets the switch in checked state
@@ -2362,6 +2466,10 @@ export interface VdsSidenavItemInputCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLVdsSidenavItemInputElement;
 }
+export interface VdsStepperItemCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLVdsStepperItemElement;
+}
 export interface VdsSwitchCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLVdsSwitchElement;
@@ -2445,6 +2553,7 @@ declare global {
         "cleared": void;
         "actionIconClick": void;
         "changeInput": string;
+        "selectedValueChanged": SelectedValueChangedEventDetail;
     }
     interface HTMLVdsBasicAutocompleteElement extends Components.VdsBasicAutocomplete, HTMLStencilElement {
         addEventListener<K extends keyof HTMLVdsBasicAutocompleteElementEventMap>(type: K, listener: (this: HTMLVdsBasicAutocompleteElement, ev: VdsBasicAutocompleteCustomEvent<HTMLVdsBasicAutocompleteElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2588,6 +2697,12 @@ declare global {
         prototype: HTMLVdsBasicTextareaElement;
         new (): HTMLVdsBasicTextareaElement;
     };
+    interface HTMLVdsBreadcrumbsItemElement extends Components.VdsBreadcrumbsItem, HTMLStencilElement {
+    }
+    var HTMLVdsBreadcrumbsItemElement: {
+        prototype: HTMLVdsBreadcrumbsItemElement;
+        new (): HTMLVdsBreadcrumbsItemElement;
+    };
     interface HTMLVdsButtonElement extends Components.VdsButton, HTMLStencilElement {
     }
     var HTMLVdsButtonElement: {
@@ -3044,6 +3159,29 @@ declare global {
         prototype: HTMLVdsSkeletonLoadingElement;
         new (): HTMLVdsSkeletonLoadingElement;
     };
+    interface HTMLVdsStepperItemElementEventMap {
+        "selected": MouseEvent;
+    }
+    interface HTMLVdsStepperItemElement extends Components.VdsStepperItem, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLVdsStepperItemElementEventMap>(type: K, listener: (this: HTMLVdsStepperItemElement, ev: VdsStepperItemCustomEvent<HTMLVdsStepperItemElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLVdsStepperItemElementEventMap>(type: K, listener: (this: HTMLVdsStepperItemElement, ev: VdsStepperItemCustomEvent<HTMLVdsStepperItemElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    }
+    var HTMLVdsStepperItemElement: {
+        prototype: HTMLVdsStepperItemElement;
+        new (): HTMLVdsStepperItemElement;
+    };
+    interface HTMLVdsStepperItemHeaderElement extends Components.VdsStepperItemHeader, HTMLStencilElement {
+    }
+    var HTMLVdsStepperItemHeaderElement: {
+        prototype: HTMLVdsStepperItemHeaderElement;
+        new (): HTMLVdsStepperItemHeaderElement;
+    };
     interface HTMLVdsSwitchElementEventMap {
         "check": boolean;
     }
@@ -3152,6 +3290,7 @@ declare global {
         "vds-basic-slider-continuous": HTMLVdsBasicSliderContinuousElement;
         "vds-basic-slider-range-continuous": HTMLVdsBasicSliderRangeContinuousElement;
         "vds-basic-textarea": HTMLVdsBasicTextareaElement;
+        "vds-breadcrumbs-item": HTMLVdsBreadcrumbsItemElement;
         "vds-button": HTMLVdsButtonElement;
         "vds-card": HTMLVdsCardElement;
         "vds-checkbox": HTMLVdsCheckboxElement;
@@ -3190,6 +3329,8 @@ declare global {
         "vds-sidenav-item-category": HTMLVdsSidenavItemCategoryElement;
         "vds-sidenav-item-input": HTMLVdsSidenavItemInputElement;
         "vds-skeleton-loading": HTMLVdsSkeletonLoadingElement;
+        "vds-stepper-item": HTMLVdsStepperItemElement;
+        "vds-stepper-item-header": HTMLVdsStepperItemHeaderElement;
         "vds-switch": HTMLVdsSwitchElement;
         "vds-tab": HTMLVdsTabElement;
         "vds-tabs-group": HTMLVdsTabsGroupElement;
@@ -3270,6 +3411,10 @@ declare namespace LocalJSX {
         "value"?: string;
     }
     interface VdsAvatar {
+        /**
+          * Name of the icon to show as overlay on hover. If not set, no overlay is shown.
+         */
+        "overlayIcon"?: string;
         /**
           * Set icon size in px or rem, IE: 32px or 1.25rem
           * @default '20px'
@@ -3337,7 +3482,7 @@ declare namespace LocalJSX {
           * Sets the color of the badge, it provides special colors such as warning, danger, healthy, information, neutral If you pass a color from out pallete it will consider as custom. The color will be applied as background color; To fully customize please refer to props contentColor and borderFocusColor.
           * @default 'neutral'
          */
-        "statusColor"?: 'warning' | 'danger' | 'healthy' | 'information' | 'neutral';
+        "statusColor"?: 'warning' | 'danger' | 'healthy' | 'information' | 'neutral' | Colors;
         /**
           * Sets the text value of the badge.
          */
@@ -3496,6 +3641,10 @@ declare namespace LocalJSX {
         /**
           * Emits event when an item is selected, this event contains the value of the selected item(s)
          */
+        "onSelectedValueChanged"?: (event: VdsBasicAutocompleteCustomEvent<SelectedValueChangedEventDetail>) => void;
+        /**
+          * Emits event when an item is selected, this event contains the label of the selected item(s)
+         */
         "onValueChanged"?: (event: VdsBasicAutocompleteCustomEvent<string | string[]>) => void;
         /**
           * Sets the internal input placeholder.
@@ -3591,7 +3740,7 @@ declare namespace LocalJSX {
     }
     interface VdsBasicDropdown {
         /**
-          * Toggles the floating container auto-positioning based on available window space.  False by default as it may cause positioning issues in some situations, use with caution
+          * Toggles the floating container auto-positioning based on available window space. False by default as it may cause positioning issues in some situations, use with caution
           * @default false
          */
         "autoPosition"?: boolean;
@@ -3809,6 +3958,7 @@ declare namespace LocalJSX {
         "type"?: VdsInputType;
         /**
           * Sets the input value.
+          * @default ""
          */
         "value"?: string;
     }
@@ -4002,6 +4152,7 @@ declare namespace LocalJSX {
         "size"?: "small" | "medium" | "large";
         /**
           * Sets the textarea's value.
+          * @default ""
          */
         "value"?: string;
         /**
@@ -4009,6 +4160,18 @@ declare namespace LocalJSX {
          */
         "width"?: string;
     }
+    interface VdsBreadcrumbsItem {
+        /**
+          * Sets the breacrumb item in disabled state
+          * @default false
+         */
+        "disabled"?: boolean;
+        /**
+          * Sets the breacrumb item in active state
+          * @default false
+         */
+        "isActive"?: boolean;
+    }
     interface VdsButton {
         /**
           * Enable button's danger/error state
@@ -4267,7 +4430,7 @@ declare namespace LocalJSX {
           * Set the divider line color
           * @default 'color-border-low'
          */
-        "color"?: BorderColors;
+        "color"?: BorderColors | StaticGlobal | Palettes;
         /**
           * Define divider orientation horizontal or vertical
           * @default 'horizontal'
@@ -4494,6 +4657,20 @@ declare namespace LocalJSX {
           * Defines the value in the avatar component
          */
         "avatar"?: string;
+        /**
+          * Sets the aria label in badge
+         */
+        "badgeAriaLabel"?: string;
+        /**
+          * Sets the status color for badge
+          * @default "neutral"
+         */
+        "badgeStatusColor"?: "warning" | "danger" | "healthy" | "information" | "neutral" | Colors1;
+        /**
+          * Shows/hides badge dot to show notification or status
+          * @default false
+         */
+        "showBadge"?: boolean;
         /**
           * Allow hide/show User-Section
           * @default true
@@ -4515,7 +4692,7 @@ declare namespace LocalJSX {
         "alt"?: string;
         /**
           * Set icon color based in volt palette
-          * @default 'brand-main'
+          * @default 'static-brand-main'
          */
         "color"?: IconColors | Colors;
         /**
@@ -5210,6 +5387,7 @@ declare namespace LocalJSX {
         "placeholder"?: string;
         /**
           * Sets the input's value.
+          * @default ""
          */
         "value"?: string;
     }
@@ -5230,6 +5408,72 @@ declare namespace LocalJSX {
          */
         "width"?: string;
     }
+    interface VdsStepperItem {
+        /**
+          * Internal prop, it is used along side with `vds-vertical-stepper` on content inside mode (text-alignment='left') When true, the item stepper display the slot content of the element  without being manage by the `vds-vertical-stepper` or `vds-horizontal-stepper`
+          * @default false
+         */
+        "activeContent"?: boolean;
+        /**
+          * Sets the stepper in disabled state
+          * @default false
+         */
+        "disabled"?: boolean;
+        /**
+          * Internal prop, it is used along side with `vds-vertical-stepper` on content inside mode (text-alignment='left') When true, the item stepper renders a vds-divider after the header
+          * @default false
+         */
+        "divider"?: boolean;
+        /**
+          * Sets the icon inside the circle in the stepper. When set, the icon will override the text value
+          * @default ''
+         */
+        "icon"?: string;
+        /**
+          * Internal prop, it is used along side with `vds-vertical-stepper` on content inside mode (text-alignment='left') When true, the item stepper can render divider and activeContent
+          * @default false
+         */
+        "manageContent"?: boolean;
+        /**
+          * Emits event when item is selected
+         */
+        "onSelected"?: (event: VdsStepperItemCustomEvent<MouseEvent>) => void;
+        /**
+          * Sets the stepper state
+          * @default 'default'
+         */
+        "state"?: 'default' | 'completed' | 'error';
+        /**
+          * Sets the text inside the circle in the stepper
+          * @default ''
+         */
+        "text"?: string;
+        /**
+          * Sets the text alignment
+          * @default 'left'
+         */
+        "textAlignment"?: 'center' | 'left';
+    }
+    interface VdsStepperItemHeader {
+        /**
+          * Define the text in the description label
+         */
+        "description"?: string;
+        /**
+          * Sets the stepper item header in disabled state
+          * @default false
+         */
+        "disabled"?: boolean;
+        /**
+          * Sets the text alignment
+          * @default 'left'
+         */
+        "textAlignment"?: 'center' | 'left';
+        /**
+          * Define the text in the title label
+         */
+        "title"?: string;
+    }
     interface VdsSwitch {
         /**
           * Sets the switch in checked state
@@ -5483,6 +5727,7 @@ declare namespace LocalJSX {
         "vds-basic-slider-continuous": VdsBasicSliderContinuous;
         "vds-basic-slider-range-continuous": VdsBasicSliderRangeContinuous;
         "vds-basic-textarea": VdsBasicTextarea;
+        "vds-breadcrumbs-item": VdsBreadcrumbsItem;
         "vds-button": VdsButton;
         "vds-card": VdsCard;
         "vds-checkbox": VdsCheckbox;
@@ -5521,6 +5766,8 @@ declare namespace LocalJSX {
         "vds-sidenav-item-category": VdsSidenavItemCategory;
         "vds-sidenav-item-input": VdsSidenavItemInput;
         "vds-skeleton-loading": VdsSkeletonLoading;
+        "vds-stepper-item": VdsStepperItem;
+        "vds-stepper-item-header": VdsStepperItemHeader;
         "vds-switch": VdsSwitch;
         "vds-tab": VdsTab;
         "vds-tabs-group": VdsTabsGroup;
@@ -5546,6 +5793,7 @@ declare module "@stencil/core" {
             "vds-basic-slider-continuous": LocalJSX.VdsBasicSliderContinuous & JSXBase.HTMLAttributes<HTMLVdsBasicSliderContinuousElement>;
             "vds-basic-slider-range-continuous": LocalJSX.VdsBasicSliderRangeContinuous & JSXBase.HTMLAttributes<HTMLVdsBasicSliderRangeContinuousElement>;
             "vds-basic-textarea": LocalJSX.VdsBasicTextarea & JSXBase.HTMLAttributes<HTMLVdsBasicTextareaElement>;
+            "vds-breadcrumbs-item": LocalJSX.VdsBreadcrumbsItem & JSXBase.HTMLAttributes<HTMLVdsBreadcrumbsItemElement>;
             "vds-button": LocalJSX.VdsButton & JSXBase.HTMLAttributes<HTMLVdsButtonElement>;
             "vds-card": LocalJSX.VdsCard & JSXBase.HTMLAttributes<HTMLVdsCardElement>;
             "vds-checkbox": LocalJSX.VdsCheckbox & JSXBase.HTMLAttributes<HTMLVdsCheckboxElement>;
@@ -5584,6 +5832,8 @@ declare module "@stencil/core" {
             "vds-sidenav-item-category": LocalJSX.VdsSidenavItemCategory & JSXBase.HTMLAttributes<HTMLVdsSidenavItemCategoryElement>;
             "vds-sidenav-item-input": LocalJSX.VdsSidenavItemInput & JSXBase.HTMLAttributes<HTMLVdsSidenavItemInputElement>;
             "vds-skeleton-loading": LocalJSX.VdsSkeletonLoading & JSXBase.HTMLAttributes<HTMLVdsSkeletonLoadingElement>;
+            "vds-stepper-item": LocalJSX.VdsStepperItem & JSXBase.HTMLAttributes<HTMLVdsStepperItemElement>;
+            "vds-stepper-item-header": LocalJSX.VdsStepperItemHeader & JSXBase.HTMLAttributes<HTMLVdsStepperItemHeaderElement>;
             "vds-switch": LocalJSX.VdsSwitch & JSXBase.HTMLAttributes<HTMLVdsSwitchElement>;
             "vds-tab": LocalJSX.VdsTab & JSXBase.HTMLAttributes<HTMLVdsTabElement>;
             "vds-tabs-group": LocalJSX.VdsTabsGroup & JSXBase.HTMLAttributes<HTMLVdsTabsGroupElement>;