@ukic/web-components 3.0.0 → 3.1.0

package/dist/types/components/ic-input-label/ic-input-label.d.ts

@@ -1,20 +1,20 @@
 export declare class InputLabel {
-    /**
-     * The appearance of the input label.
-     */
-    appearance?: "dark" | "default";
     /**
      * If `true`, the disabled state will be set.
      */
-    disabled: boolean;
+    disabled?: boolean;
     /**
      * The ID of the form element the label is bound to.
      */
-    for: string;
+    for?: string;
     /**
      * The helper text that will be displayed.
      */
     helperText: string;
+    /**
+     * The label will be visually hidden.
+     */
+    hideLabel: boolean;
     /**
      * The text content of the label.
      */
@@ -31,6 +31,10 @@ export declare class InputLabel {
      * The status of the label - e.g. 'error'.
      */
     status: "error" | "";
+    /**
+     * @internal If `true`, wraps label text in label tag
+     */
+    useLabelTag: boolean;
     componentDidLoad(): void;
     render(): any;
 }

package/dist/types/components/ic-input-validation/ic-input-validation.d.ts

@@ -8,15 +8,15 @@ export declare class InputValidation {
     /**
      *  The ARIA live mode to apply to the message.
      */
-    ariaLiveMode: IcAriaLiveModeVariants;
+    ariaLiveMode?: IcAriaLiveModeVariants;
     /**
      * The ID of the form element the validation is bound to.
      */
-    for: string;
+    for?: string;
     /**
      *  If `true`, the input validation will fill the width of the container.
      */
-    fullWidth: boolean;
+    fullWidth?: boolean;
     /**
      * The validation message to display.
      */
@@ -24,7 +24,7 @@ export declare class InputValidation {
     /**
      * The status of the validation - e.g. 'error' | 'warning' | 'success'.
      */
-    status: IcInformationStatusOrEmpty;
+    status?: IcInformationStatusOrEmpty;
     componentDidLoad(): void;
     render(): any;
 }

package/dist/types/components/ic-link/ic-link.d.ts

@@ -1,4 +1,4 @@
-import { IcTheme, IcThemeForeground } from "../../utils/types";
+import { IcBrand, IcThemeMode } from "../../utils/types";
 /**
  * @slot router-item - Handle routing by nesting your routes in this slot.
  */
@@ -7,10 +7,6 @@ export declare class Link {
     private routerSlot;
     private hostMutationObserver;
     el: HTMLIcLinkElement;
-    /**
-     * The appearance of the link, e.g. dark, light, or default.
-     */
-    appearance?: IcThemeForeground;
     /**
      * If `true`, the user can save the linked URL instead of navigating to it.
      */
@@ -23,6 +19,10 @@ export declare class Link {
      * The human language of the linked URL.
      */
     hreflang?: string;
+    /**
+     * If `true`, the link will display as black in the light theme, and white in the dark theme.
+     */
+    monochrome?: boolean;
     /**
      * How much of the referrer to send when following the link.
      */
@@ -35,10 +35,14 @@ export declare class Link {
      * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
      */
     target?: string;
+    /**
+     * Sets the theme color to the dark or light theme color. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme?: IcThemeMode;
     componentWillLoad(): void;
     componentDidLoad(): void;
     disconnectedCallback(): void;
-    themeChangeHandler({ detail }: CustomEvent<IcTheme>): void;
+    brandChangeHandler({ detail }: CustomEvent<IcBrand>): void;
     /**
      * Sets focus on the link.
      */

package/dist/types/components/ic-loading-indicator/ic-loading-indicator.d.ts

@@ -1,7 +1,7 @@
 import { IcLoadingSizes, IcLoadingTypes } from "./ic-loading-indicator.types";
-import { IcThemeForegroundNoDefault } from "../../utils/types";
+import { IcThemeMode } from "../../utils/types";
 export declare class LoadingIndicator {
-    private circularMeter;
+    private circularMeter?;
     private innerElement?;
     private interval;
     private labelList;
@@ -12,10 +12,6 @@ export declare class LoadingIndicator {
     indeterminate: boolean;
     indicatorLabel: string;
     clipInnerElement: boolean;
-    /**
-     * The appearance of the loading indicator, e.g. dark or light.
-     */
-    appearance?: IcThemeForegroundNoDefault;
     /**
      * The description that will be set as the aria-label of the loading indicator when not using a visible label.
      */
@@ -42,6 +38,10 @@ export declare class LoadingIndicator {
      * Used to calculate the proportional width of the progress bar.
      */
     min?: number;
+    /**
+     * If `true`, the element will display as black and white.
+     */
+    monochrome?: boolean;
     /**
      * The size of the loading indicator.
      */
@@ -52,9 +52,9 @@ export declare class LoadingIndicator {
     type?: IcLoadingTypes;
     /**
      * The label to be displayed beneath the loading indicator.
-     * Display a changing label by separating multiple messages with forward slashes.
+     * Display a changing label by supplying an array of messages.
      */
-    label?: string;
+    label?: string | string[];
     watchPropHandler(): void;
     /**
      * The current amount of progress made.
@@ -62,6 +62,10 @@ export declare class LoadingIndicator {
      */
     progress?: number;
     watchProgressHandler(): void;
+    /**
+     * Sets the theme color to the dark or light theme color. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme?: IcThemeMode;
     disconnectedCallback(): void;
     componentWillLoad(): void;
     componentDidLoad(): void;

package/dist/types/components/ic-loading-indicator/ic-loading-indicator.types.d.ts

@@ -1,4 +1,4 @@
-export type IcLoadingSizes = "default" | "small" | "large" | "icon";
+export type IcLoadingSizes = "medium" | "small" | "large" | "icon";
 export type IcLoadingTypes = "circular" | "linear";
 export interface IcLoadingCircleXYR {
     x: number;

package/dist/types/components/ic-menu/ic-menu.d.ts

@@ -1,24 +1,35 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcActivationTypes, IcMenuOption, IcSizes, IcValueEventDetail } from "../../utils/types";
+import { IcActivationTypes, IcMenuOption, IcSizes, IcMultiValueEventDetail } from "../../utils/types";
 import { IcOptionSelectEventDetail, IcMenuChangeEventDetail, IcMenuOptionIdEventDetail } from "./ic-menu.types";
 import { IcSearchBarSearchModes } from "../ic-search-bar/ic-search-bar.types";
 export declare class Menu {
+    private ACTIVE_DESCENDANT;
+    private CLEAR_BUTTON_ID;
+    private SEARCH_BAR_TAG;
     private disabledOptionSelected;
     private hasPreviouslyBlurred;
     private hasTimedOut;
     private isLoading;
+    private isMultiSelect;
     private isSearchBar;
     private isSearchableSelect;
-    private menu;
+    private lastOptionSelected;
+    private lastOptionFocused;
+    private menu?;
+    private multiOptionClicked;
     private popperInstance;
     private preventClickOpen;
+    private preventMenuFocus;
+    private selectAllButton?;
+    private shiftPressed;
     private ungroupedOptions;
     host: HTMLIcMenuElement;
     focusFromSearchKeypress: boolean;
     initialOptionsListRender: boolean;
     keyboardNav: boolean;
-    optionHighlighted: string;
+    optionHighlighted: string | undefined;
     preventIncorrectTabOrder: boolean;
+    menuOptions: IcMenuOption[];
     /**
      * Determines whether options manually set as values (by pressing 'Enter') when they receive focus using keyboard navigation.
      */
@@ -30,11 +41,15 @@ export declare class Menu {
     /**
      * @internal If `true`, autofocus will be applied on selected item when menu is open.
      */
-    autoFocusOnSelected: boolean;
+    autofocusOnSelected?: boolean;
+    /**
+     *  If `true`, the menu will close when an option is selected.
+     */
+    closeOnSelect?: boolean;
     /**
      *  If `true`, the menu will fill the width of the container.
      */
-    fullWidth: boolean;
+    fullWidth?: boolean;
     /**
      * The reference to the input element.
      */
@@ -46,7 +61,7 @@ export declare class Menu {
     /**
      * The custom name for the label field for IcMenuOption.
      */
-    labelField: string;
+    labelField?: string;
     /**
      * The ID of the menu.
      */
@@ -69,7 +84,7 @@ export declare class Menu {
      */
     selectOnEnter?: boolean;
     /**
-     * The size of the menu component.
+     * The size of the menu.
      */
     size?: IcSizes;
     /**
@@ -78,23 +93,26 @@ export declare class Menu {
     options: IcMenuOption[];
     watchOptionsHandler(newOptions: IcMenuOption[]): void;
     /**
-     * The value of the currently selected option.
+     * The value of the currently selected option - or array of values (if multiple options allowed).
      */
-    value: string;
-    watchValueHandler(): void;
+    value: string | string[];
     /**
      * The custom name for the value field for IcMenuOption.
      */
-    valueField: string;
+    valueField?: string;
     /**
-     * @internal Emitted when key is pressed while menu is open
+     * Emitted when the clear all button is clicked.
+     */
+    icClear: EventEmitter<void>;
+    /**
+     * @internal Emitted when key is pressed while menu is open.
      */
     menuKeyPress: EventEmitter<{
         isNavKey: boolean;
         key: string;
     }>;
     /**
-     * @internal Emitted when an option has been highlighted
+     * @internal Emitted when an option has been highlighted.
      */
     menuOptionId: EventEmitter<IcMenuOptionIdEventDetail>;
     /**
@@ -102,19 +120,21 @@ export declare class Menu {
      */
     menuOptionSelect: EventEmitter<IcOptionSelectEventDetail>;
     /**
-     * @internal Emitted when state of menu changes (i.e. open or close).
+     * @internal Emitted when all options are selected or deselected.
      */
-    menuStateChange: EventEmitter<IcMenuChangeEventDetail>;
+    menuOptionSelectAll: EventEmitter<{
+        select: boolean;
+    }>;
     /**
-     * @internal Emitted when menu value changes.
+     * @internal Emitted when state of menu changes (i.e. open or closed).
      */
-    menuValueChange: EventEmitter<IcValueEventDetail>;
+    menuStateChange: EventEmitter<IcMenuChangeEventDetail>;
     /**
-     * @internal Emitted when the retry button is clicked
+     * @internal Emitted when the retry button is clicked.
      */
-    retryButtonClicked: EventEmitter<IcValueEventDetail>;
+    retryButtonClicked: EventEmitter<IcMultiValueEventDetail>;
     /**
-     * @internal Emitted when the timeout menu loses focus
+     * @internal Emitted when the timeout menu loses focus.
      */
     timeoutBlur: EventEmitter<{
         ev: FocusEvent;
@@ -158,10 +178,13 @@ export declare class Menu {
     private setPreviousOptionValue;
     private getParentEl;
     private arrowBehaviour;
-    private setMenuOptions;
+    private getMenuOptions;
     private setHighlightedOption;
     private autoSetInputValueKeyboardOpen;
-    private manSetInputValueKeyboardOpen;
+    private selectHighlightedOption;
+    private isOptionSelected;
+    private deselectSelectedOptions;
+    private manualSetInputValueKeyboardOpen;
     private setInputValue;
     private handleOptionClick;
     private handleRetry;
@@ -169,12 +192,22 @@ export declare class Menu {
     private handleBlur;
     private handleMouseDown;
     private handleMenuKeyDown;
+    private handleMenuKeyUp;
+    private handleSelectAllClick;
+    private handleSelectAllBlur;
+    private handleSelectAllFocus;
+    private handleSelectAllMouseDown;
+    private handleSingleShiftSelect;
+    private handleMultipleShiftSelect;
+    private handleOptionSelect;
+    private getFirstOptionInSelection;
+    private emitSelectAllEvents;
     private emitMenuKeyPress;
     private autoSetValueOnMenuKeyDown;
-    private handleMenuKeyUp;
     private getOptionId;
     private getOptionAriaLabel;
     private getSortedOptions;
+    private getOptionHighlightedIndex;
     private isManualMode;
     private scrollToSelected;
     private loadUngroupedOptions;

package/dist/types/components/ic-menu/ic-menu.types.d.ts

@@ -1,5 +1,5 @@
 export interface IcOptionSelectEventDetail {
-    value: string;
+    value: string | undefined;
     label?: string;
     optionId?: string;
 }

package/dist/types/components/ic-menu-item/ic-menu-item.d.ts

@@ -5,7 +5,10 @@ import { IcMenuItemVariants } from "./ic-menu-item.types";
  */
 export declare class MenuItem {
     el: HTMLIcMenuItemElement;
-    toggleChecked: boolean;
+    /**
+     * If `true`, the menu item will be in a checked state. This is only applicable when variant is set to `toggle`.
+     */
+    checked?: boolean;
     /**
      * The description displayed in the menu item, below the label.
      */
@@ -14,6 +17,7 @@ export declare class MenuItem {
      * If `true`, the menu item will be in disabled state.
      */
     disabled?: boolean;
+    watchDisabledHandler(): void;
     /**
      * The URL that the link points to. This will render the menu item as an "a" tag.
      */
@@ -25,7 +29,7 @@ export declare class MenuItem {
     /**
      * The label describing the keyboard shortcut for a menu item's action.
      */
-    keyboardShortcut?: string;
+    keyboardShortcutLabel?: string;
     /**
      * The label to display in the menu item.
      */
@@ -49,7 +53,7 @@ export declare class MenuItem {
     /**
      * The variant of the menu item.
      */
-    variant: IcMenuItemVariants;
+    variant?: IcMenuItemVariants;
     /**
      * @internal Emitted when item loses focus.
      */
@@ -57,9 +61,12 @@ export declare class MenuItem {
     /**
      * @internal Emitted when the user clicks a menu item.
      */
-    handleMenuItemClick: EventEmitter<{
-        label: string;
-        hasSubMenu: boolean;
+    handleMenuItemClick: EventEmitter<HTMLIcMenuItemElement>;
+    /**
+     * Emitted when the user clicks a menu item that is set to the toggle variant.
+     */
+    icToggleChecked: EventEmitter<{
+        checked: boolean;
     }>;
     /**
      * @internal Emitted when the user clicks a menu item that triggers a popover menu instance.

package/dist/types/components/ic-navigation-button/ic-navigation-button.d.ts

@@ -1,15 +1,15 @@
-import { IcThemeForeground } from "../../utils/types";
+import { IcBrand, IcBrandForeground, IcBrandForegroundNoDefault, IcThemeMode } from "../../utils/types";
 import { IcNavButtonModes } from "./ic-navigation-button.types";
 /**
  * @slot icon - Content will be placed to the left of the button label.
  * @slot badge - Badge component overlaying the top right of the button.
  */
 export declare class NavigationButton {
-    private buttonEl;
+    private buttonEl?;
     private inheritedAttributes;
     private hostMutationObserver;
     el: HTMLIcNavigationButtonElement;
-    initialAppearance: IcThemeForeground;
+    initialAppearance: IcBrandForegroundNoDefault | IcBrandForeground;
     /**
      * The display mode.
      */
@@ -42,13 +42,17 @@ export declare class NavigationButton {
      * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
      */
     target?: string;
+    /**
+     * Sets the theme color to the dark or light theme color. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme?: IcThemeMode;
     componentWillLoad(): void;
     componentDidLoad(): void;
     componentWillRender(): void;
     disconnectedCallback(): void;
     navBarMenuOpenHandler(): void;
     navBarMenuCloseHandler(): void;
-    themeChangeHandler(ev: CustomEvent): void;
+    brandChangeHandler(ev: CustomEvent<IcBrand>): void;
     /**
      * Sets focus on the native `button`.
      */

package/dist/types/components/ic-navigation-group/ic-navigation-group.d.ts

@@ -1,13 +1,14 @@
-import { IcNavType } from "../../utils/types";
+import { EventEmitter } from "../../stencil-public-runtime";
+import { IcNavType, IcBrand, IcBrandForeground, IcBrandForegroundNoDefault, IcThemeMode } from "../../utils/types";
+import { IcNavigationExpandEventDetail, IcNavigationOpenEventDetail } from "./ic-navigation-group.types";
 export declare class NavigationGroup {
     private allGroupedNavigationItems;
     private collapsedNavItemsHeight;
-    private dropdown;
+    private dropdown?;
     private DYNAMIC_GROUPED_LINKS_HEIGHT_MS;
     private expandedNavItemsHeight;
-    private groupEl;
+    private groupEl?;
     private IC_NAVIGATION_ITEM;
-    private isSideNavExpanded;
     private mouseGate;
     private nodeName;
     private GROUPED_LINKS_WRAPPER_CLASS;
@@ -15,24 +16,38 @@ export declare class NavigationGroup {
     deviceSize: number;
     dropdownOpen: boolean;
     expanded: boolean;
-    focusStyle: import("../../utils/types").IcThemeForeground;
+    focusStyle: IcBrandForegroundNoDefault | IcBrandForeground;
     inTopNavSideMenu: boolean;
     navigationType: IcNavType | "";
-    parentEl: HTMLElement;
+    parentEl: HTMLElement | null;
+    isSideNavExpanded: boolean;
     /**
-     *  If `true`, the group will be expandable in the side menu.
+     *  If `true`, the group will be expandable when in an ic-side-navigation component, or, when in an ic-top-navigation component, in the side menu displayed at small screen sizes.
      */
-    expandable: boolean;
+    expandable?: boolean;
     /**
      * The label to display on the group.
      */
     label: string;
+    /**
+     * Sets the theme color to the dark or light theme color. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme?: IcThemeMode;
+    /**
+     * @internal Emitted when a navigation group is opened - when within an ic-top-navigation at large screen sizes.
+     */
+    navigationGroupOpened: EventEmitter<IcNavigationOpenEventDetail>;
+    /**
+     * @internal Emitted when a navigation group is expanded - when within an ic-top-navigation at small screen sizes.
+     */
+    navigationGroupExpanded: EventEmitter<IcNavigationExpandEventDetail>;
     disconnectedCallback(): void;
     componentWillLoad(): void;
     componentDidLoad(): void;
     childBlurHandler(): void;
+    handleNavigationGroupOpened(event: CustomEvent): void;
     navItemClickHandler(): void;
-    themeChangeHandler(ev: CustomEvent): void;
+    brandChangeHandler(ev: CustomEvent<IcBrand>): void;
     /**
      * Sets focus on the nav item.
      */
@@ -59,6 +74,7 @@ export declare class NavigationGroup {
      */
     private getNavigationChildItemsHeight;
     private setInitialGroupedLinksWrapperHeight;
+    private renderGroupTitleText;
     private renderNavigationItems;
     private setGroupedLinksElementHeight;
     render(): any;

package/dist/types/components/ic-navigation-group/ic-navigation-group.types.d.ts

@@ -0,0 +1,6 @@
+export interface IcNavigationOpenEventDetail {
+    source: HTMLElement;
+}
+export interface IcNavigationExpandEventDetail {
+    expanded: boolean;
+}

package/dist/types/components/ic-navigation-item/ic-navigation-item.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcNavType, IcTheme } from "../../utils/types";
+import { IcNavType, IcBrand, IcBrandForeground, IcBrandForegroundNoDefault, IcThemeMode } from "../../utils/types";
 /**
  * @part link - The `<a>` within ic-navigation-item
  * @slot badge - Badge component overlaying the top right of the icon.
@@ -8,24 +8,28 @@ import { IcNavType, IcTheme } from "../../utils/types";
 export declare class NavigationItem {
     private navigationSlot;
     private isInitialRender;
-    private itemEl;
+    private itemEl?;
+    private hostMutationObserver;
+    private ANIMATION_DURATION;
+    private ARIA_LABEL_STRING;
     el: HTMLIcNavigationItemElement;
     deviceSize: number;
-    focusStyle: import("../../utils/types").IcThemeForeground;
+    focusStyle: IcBrandForegroundNoDefault | IcBrandForeground;
     inTopNavSideMenu: boolean;
     isSideNavMobile: boolean;
     isTopNavChild: boolean;
     navigationType: IcNavType | "";
-    parentEl: HTMLElement;
+    parentEl: HTMLElement | null;
     sideNavExpanded: boolean;
+    ariaLabel: string;
     /**
      * @internal If `true`, the icon and label will be displayed when side navigation is collapsed.
      */
-    collapsedIconLabel: boolean;
+    collapsedIconLabel?: boolean;
     /**
      * @internal If `true`, the navigation item will be displayed within a tooltip.
      */
-    displayNavigationTooltip: boolean;
+    displayNavigationTooltip?: boolean;
     /**
      * If `true`, the user can save the linked URL instead of navigating to it.
      */
@@ -33,11 +37,11 @@ export declare class NavigationItem {
     /**
      *  @internal If `true`, the navigation item will be expandable.
      */
-    expandable: boolean;
+    expandable?: boolean;
     /**
      * The destination of the navigation item.
      */
-    href: string;
+    href?: string;
     /**
      * The human language of the linked URL.
      */
@@ -45,7 +49,7 @@ export declare class NavigationItem {
     /**
      * The label of the navigation item.
      */
-    label: string;
+    label?: string;
     /**
      * The relationship of the linked URL as space-separated link types.
      */
@@ -57,11 +61,15 @@ export declare class NavigationItem {
     /**
      *  If `true`, the navigation item will be set in a selected state.
      */
-    selected: boolean;
+    selected?: boolean;
     /**
      *  The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
      */
     target?: string;
+    /**
+     * Sets the theme color to the dark or light theme color. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme?: IcThemeMode;
     /**
      * @internal - Emitted when item loses focus.
      */
@@ -72,8 +80,9 @@ export declare class NavigationItem {
     navItemClicked: EventEmitter<void>;
     disconnectedCallback(): void;
     componentWillLoad(): void;
+    componentDidLoad(): void;
     componentDidUpdate(): void;
-    themeChangeHandler({ detail }: CustomEvent<IcTheme>): void;
+    brandChangeHandler({ detail }: CustomEvent<IcBrand>): void;
     /**
      * Sets focus on the nav item.
      */
@@ -83,7 +92,9 @@ export declare class NavigationItem {
     private sideNavExpandHandler;
     private handleBlur;
     private handleClick;
+    private hostMutationCallback;
     private generateTooltipLabel;
     private renderNavigationItemContent;
+    private sideNavToggleTooltip;
     render(): any;
 }

package/dist/types/components/ic-navigation-menu/ic-navigation-menu.d.ts

@@ -1,25 +1,31 @@
 import { EventEmitter } from "../../stencil-public-runtime";
+import { IcThemeMode } from "../../utils/types";
 /**
  * @slot navigation - Content will be rendered at top of panel.
  * @slot buttons - Content will be rendered above version info and below navigation.
  */
 export declare class NavigationMenu {
-    private closeButton;
+    private closeButton?;
     private hasButtons;
     private hasNavigation;
     private lastTabStop;
     private navBarEl;
     private navGroupFirst;
+    private navigationEls;
     private navItemAboveButtons;
     el: HTMLIcNavigationMenuElement;
     /**
      * The status info to display.
      */
-    status: string;
+    status?: string;
+    /**
+     * Sets the theme color to the dark or light theme color. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme?: IcThemeMode;
     /**
      * The version info to display.
      */
-    version: string;
+    version?: string;
     /**
      * @internal - Emitted when the menu is closed.
      */
@@ -29,6 +35,7 @@ export declare class NavigationMenu {
     componentWillRender(): void;
     navItemClickHandler(): void;
     handleKeyDown(ev: KeyboardEvent): void;
+    private setLastTabStop;
     private closeMenu;
     private focusCloseButton;
     private focusLastTabStop;