@ukic/web-components 3.0.0-alpha.2 → 3.0.0-alpha.4

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

@@ -15,6 +15,10 @@ export declare class InputLabel {
      * 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 +35,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-menu/ic-menu.d.ts

@@ -3,15 +3,24 @@ import { IcActivationTypes, IcMenuOption, IcSizes, IcValueEventDetail } from "..
 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 disabledOptionSelected;
     private hasPreviouslyBlurred;
     private hasTimedOut;
     private isLoading;
+    private isMultiSelect;
     private isSearchBar;
     private isSearchableSelect;
+    private lastOptionSelected;
+    private lastOptionFocused;
     private menu;
+    private multiOptionClicked;
     private popperInstance;
     private preventClickOpen;
+    private preventMenuFocus;
+    private selectAllButton;
+    private shiftPressed;
     private ungroupedOptions;
     host: HTMLIcMenuElement;
     focusFromSearchKeypress: boolean;
@@ -19,6 +28,7 @@ export declare class Menu {
     keyboardNav: boolean;
     optionHighlighted: string;
     preventIncorrectTabOrder: boolean;
+    menuOptions: IcMenuOption[];
     /**
      * Determines whether options manually set as values (by pressing 'Enter') when they receive focus using keyboard navigation.
      */
@@ -31,6 +41,10 @@ export declare class Menu {
      * @internal If `true`, autofocus will be applied on selected item when menu is open.
      */
     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.
      */
@@ -69,7 +83,7 @@ export declare class Menu {
      */
     selectOnEnter?: boolean;
     /**
-     * The size of the menu component.
+     * The size of the menu.
      */
     size?: IcSizes;
     /**
@@ -78,23 +92,22 @@ 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;
     /**
-     * @internal Emitted when key is pressed while menu is open
+     * @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 +115,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>;
     /**
-     * @internal Emitted when the timeout menu loses focus
+     * @internal Emitted when the timeout menu loses focus.
      */
     timeoutBlur: EventEmitter<{
         ev: FocusEvent;
@@ -158,10 +173,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 +187,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 emitSelectAll;
     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-item/ic-menu-item.d.ts

@@ -25,7 +25,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.
      */

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

@@ -1,4 +1,4 @@
-import { IcThemeForeground } from "../../utils/types";
+import { IcThemeForeground, IcThemeForegroundNoDefault } from "../../utils/types";
 import { IcNavButtonModes } from "./ic-navigation-button.types";
 /**
  * @slot icon - Content will be placed to the left of the button label.
@@ -9,7 +9,7 @@ export declare class NavigationButton {
     private inheritedAttributes;
     private hostMutationObserver;
     el: HTMLIcNavigationButtonElement;
-    initialAppearance: IcThemeForeground;
+    initialAppearance: IcThemeForegroundNoDefault | IcThemeForeground;
     /**
      * The display mode.
      */

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

@@ -1,4 +1,4 @@
-import { IcNavType } from "../../utils/types";
+import { IcNavType, IcThemeForeground, IcThemeForegroundNoDefault } from "../../utils/types";
 export declare class NavigationGroup {
     private allGroupedNavigationItems;
     private collapsedNavItemsHeight;
@@ -15,7 +15,7 @@ export declare class NavigationGroup {
     deviceSize: number;
     dropdownOpen: boolean;
     expanded: boolean;
-    focusStyle: import("../../utils/types").IcThemeForeground;
+    focusStyle: IcThemeForegroundNoDefault | IcThemeForeground;
     inTopNavSideMenu: boolean;
     navigationType: IcNavType | "";
     parentEl: HTMLElement;

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, IcTheme, IcThemeForeground, IcThemeForegroundNoDefault } from "../../utils/types";
 /**
  * @part link - The `<a>` within ic-navigation-item
  * @slot badge - Badge component overlaying the top right of the icon.
@@ -9,15 +9,18 @@ export declare class NavigationItem {
     private navigationSlot;
     private isInitialRender;
     private itemEl;
+    private hostMutationObserver;
+    private ARIA_LABEL_STRING;
     el: HTMLIcNavigationItemElement;
     deviceSize: number;
-    focusStyle: import("../../utils/types").IcThemeForeground;
+    focusStyle: IcThemeForegroundNoDefault | IcThemeForeground;
     inTopNavSideMenu: boolean;
     isSideNavMobile: boolean;
     isTopNavChild: boolean;
     navigationType: IcNavType | "";
     parentEl: HTMLElement;
     sideNavExpanded: boolean;
+    ariaLabel: string;
     /**
      * @internal If `true`, the icon and label will be displayed when side navigation is collapsed.
      */
@@ -72,6 +75,7 @@ export declare class NavigationItem {
     navItemClicked: EventEmitter<void>;
     disconnectedCallback(): void;
     componentWillLoad(): void;
+    componentDidLoad(): void;
     componentDidUpdate(): void;
     themeChangeHandler({ detail }: CustomEvent<IcTheme>): void;
     /**
@@ -83,6 +87,7 @@ export declare class NavigationItem {
     private sideNavExpandHandler;
     private handleBlur;
     private handleClick;
+    private hostMutationCallback;
     private generateTooltipLabel;
     private renderNavigationItemContent;
     render(): any;

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

@@ -1,5 +1,5 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcThemeForeground } from "../../utils/types";
+import { IcThemeMode } from "../../utils/types";
 import { IcPaginationTypes, IcChangeEventDetail } from "./ic-pagination.types";
 export declare class Pagination {
     el: HTMLIcPaginationElement;
@@ -13,10 +13,6 @@ export declare class Pagination {
      */
     adjacentPageCount: number;
     watchAdjacentPageCountHandler(): void;
-    /**
-     * The appearance of the pagination, e.g. dark, light or the default.
-     */
-    appearance: IcThemeForeground;
     /**
      * The number of pages displayed as boundary items to the current page when using 'complex' type pagination. Accepted values are 0, 1 & 2.
      */
@@ -42,11 +38,19 @@ export declare class Pagination {
      * The label for the pagination item (applicable when simple pagination is being used).
      */
     label: string;
+    /**
+     * If `true`, the pagination will display as black in the light theme, and white in dark theme.
+     */
+    monochrome?: boolean;
     /**
      * The total number of pages.
      */
     pages: number;
     watchNumberPagesHandler(): 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;
     /**
      * The type of pagination to be used.
      */
@@ -73,6 +77,10 @@ export declare class Pagination {
     private handleClickPrevious;
     private handleClickNext;
     private handleClickLast;
+    /**
+     * Temporary function to handle button appearance until other dark mode work is completed.
+     */
+    private handleButtonAppearance;
     private firstButton;
     private previousButton;
     private nextButton;

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

@@ -1,13 +1,9 @@
 import { EventEmitter } from "../../stencil-public-runtime";
 import { IcPaginationItemType } from "./ic-pagination-item.types";
-import { IcThemeForeground } from "../../utils/types";
+import { IcThemeMode } from "../../utils/types";
 export declare class PaginationItem {
     el: HTMLIcPaginationItemElement;
     capitalizedLabel: string;
-    /**
-     * The appearance of the pagination, e.g. dark, light or the default.
-     */
-    appearance: IcThemeForeground;
     /**
      * If `true`, the pagination item will be disabled.
      */
@@ -17,6 +13,10 @@ export declare class PaginationItem {
      */
     label: string;
     watchLabelHandler(): void;
+    /**
+     * If `true`, the pagination item will display as black in the light theme, and white in dark theme.
+     */
+    monochrome?: boolean;
     /**
      * The current page number.
      */
@@ -25,6 +25,10 @@ export declare class PaginationItem {
      * If `true`, the pagination item will be selected.
      */
     selected: boolean;
+    /**
+     * 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 type of pagination item - 'page' or 'ellipsis'.
      */

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

@@ -1,4 +1,5 @@
 import { EventEmitter } from "../../stencil-public-runtime";
+import { IcThemeMode } from "../../utils/types";
 export declare class PopoverMenu {
     private anchorEl;
     private ARIA_LABEL;
@@ -29,6 +30,10 @@ export declare class PopoverMenu {
      * @internal The level of menu being displayed.
      */
     submenuLevel: number;
+    /**
+     * 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;
     /**
      * If `true`, the popover menu will be displayed.
      */

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

@@ -1,5 +1,5 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcInformationStatusOrEmpty, IcOrientation, IcSizesNoLarge, IcValueEventDetail } from "../../utils/types";
+import { IcInformationStatusOrEmpty, IcOrientation, IcSizesNoLarge, IcThemeMode, IcValueEventDetail } from "../../utils/types";
 import { IcChangeEventDetail } from "./ic-radio-group.types";
 export declare class RadioGroup {
     private radioContainer;
@@ -55,6 +55,11 @@ export declare class RadioGroup {
      */
     validationText: string;
     orientationChangeHandler(): 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;
+    watchThemeHandler(newValue: IcThemeMode): void;
     /**
      * Emitted when a user selects a radio.
      */

package/dist/types/components/ic-radio-option/ic-radio-option.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcAdditionalFieldTypes, IcValueEventDetail } from "../../utils/types";
+import { IcAdditionalFieldTypes, IcThemeMode, IcValueEventDetail } from "../../utils/types";
 /**
  * @slot additional-field - Content to displayed alongside a radio option.
  */
@@ -37,6 +37,10 @@ export declare class RadioOption {
      * The name for the radio option.
      */
     name: 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 value for the radio option.
      */
@@ -60,7 +64,7 @@ export declare class RadioOption {
     componentDidLoad(): void;
     componentWillRender(): void;
     componentDidRender(): void;
-    textfieldValueHandler(event: CustomEvent<{
+    additionalFieldValueHandler(event: CustomEvent<{
         value: string;
     }>): void;
     /**
@@ -71,8 +75,9 @@ export declare class RadioOption {
      * @internal Sets the tabIndex of the radio option.
      */
     setTabIndex(value: number): Promise<void>;
+    private getAdditionalField;
     private handleClick;
-    private swallowClick;
+    private handleKeyDown;
     private handleFormReset;
     render(): any;
 }

package/dist/types/components/ic-search-bar/ic-search-bar.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcAutocompleteTypes, IcAutocorrectStates, IcMenuOption, IcSizesNoLarge } from "../../utils/types";
+import { IcAutocompleteTypes, IcAutocorrectStates, IcMenuOption, IcSizesNoLarge, IcThemeMode } from "../../utils/types";
 import { IcSearchBarBlurEventDetail, IcSearchBarSearchModes } from "./ic-search-bar.types";
 import { IcValueEventDetail, IcBlurEventDetail } from "../../utils/types";
 import { IcMenuChangeEventDetail, IcOptionSelectEventDetail } from "../ic-menu/ic-menu.types";
@@ -135,6 +135,10 @@ export declare class SearchBar {
      * If `true`, the value of the search will have its spelling and grammar checked.
      */
     spellcheck: boolean;
+    /**
+     * 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;
     /**
      * If using external filtering, set a timeout for when loading takes too long.
      */

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

@@ -51,7 +51,7 @@ export declare class Select {
      */
     form?: string;
     /**
-     * If `true`, the select element will fill the width of the container. This prop should only be used with searchable select and will only be applied if searchable is true.
+     * If `true`, the select will fill the width of the container.
      */
     fullWidth: boolean;
     /**
@@ -82,6 +82,10 @@ export declare class Select {
      * The message displayed whilst the options are being loaded externally.
      */
     loadingLabel?: string;
+    /**
+     * If `true`, multiple options can be selected.
+     */
+    multiple?: boolean;
     /**
      * The name of the control, which is submitted with the form data.
      */
@@ -107,7 +111,7 @@ export declare class Select {
      */
     searchMatchPosition?: IcSearchMatchPositions;
     /**
-     * If `true`, the icOptionSelect event will be fired on enter instead of ArrowUp and ArrowDown.
+     * If `true`, the icOptionSelect event will be fired on enter instead of ArrowUp and ArrowDown on the single select.
      */
     selectOnEnter?: boolean;
     /**
@@ -115,7 +119,7 @@ export declare class Select {
      */
     showClearButton?: boolean;
     /**
-     * The size of the select component.
+     * The size of the select.
      */
     size?: IcSizes;
     /**
@@ -149,12 +153,14 @@ export declare class Select {
     currDebounce: number;
     debounceChangedHandler(newValue: number): void;
     /**
-     * The value of the select, reflected by the value of the currently selected option. For the searchable variant, the value is also reflected by the user input.
+     * The value of the select, reflected by the value of the currently selected option.
+     * For the searchable variant, the value is also reflected by the user input.
+     * For the multi-select variant, the value must be an array of option values.
      */
-    value?: string;
-    initialValue: string;
+    value?: string | string[];
+    initialValue: string | string[];
     inputValueToFilter: string;
-    currValue: string;
+    currValue: string | string[];
     valueChangedHandler(): void;
     openChangedHandler(): void;
     /**
@@ -186,10 +192,14 @@ export declare class Select {
      */
     icOpen: EventEmitter<void>;
     /**
-     * Emitted when an option is highlighted within the menu.
-     * Highlighting a menu item will also trigger an `icChange/onIcChange` due to the value being updated.
+     * Emitted when an option is selected.
+     * Selecting an option will also trigger an `icChange/onIcChange` due to the value being updated.
      */
     icOptionSelect: EventEmitter<IcOptionSelectEventDetail>;
+    /**
+     * Emitted when `multiple` is `true` and an option is deselected.
+     */
+    icOptionDeselect: EventEmitter<IcOptionSelectEventDetail>;
     /**
      * Emitted when the 'retry loading' button is clicked for a searchable variant.
      */
@@ -221,12 +231,15 @@ export declare class Select {
     private setTextColor;
     private setMenuChange;
     private getLabelFromValue;
+    private getMultipleOptionsString;
     private getFilteredChildMenuOptions;
+    private getValueSortedByOptions;
     private handleNativeSelectChange;
     private handleCustomSelectChange;
+    private handleMultipleSelectChange;
+    private handleSelectAllChange;
     private handleMenuChange;
     private handleMenuKeyPress;
-    private handleMenuValueChange;
     private handleFocusIndicatorDisplay;
     private handleMouseDown;
     private isExternalFiltering;
@@ -248,6 +261,7 @@ export declare class Select {
     private handleSearchableSelectInput;
     private updateSearchableSelectResultAriaLive;
     private debounceAriaLiveUpdate;
+    private updateMultiSelectedCountAriaLive;
     private getDefaultValue;
     private setDefaultValue;
     private onFocus;

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

@@ -1,6 +1,6 @@
 import { EventEmitter } from "../../stencil-public-runtime";
 import { IcSwitchChangeEventDetail } from "./ic-switch.types";
-import { IcSizesNoLarge } from "../../utils/types";
+import { IcSizesNoLarge, IcThemeMode } from "../../utils/types";
 /**
  * @slot right-adornment - Content is placed to the right of switch before state label.
  */
@@ -42,6 +42,10 @@ export declare class Switch {
      * The size of the switch component.
      */
     size?: IcSizesNoLarge;
+    /**
+     * 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 value of the toggle does not mean if it's checked or not, use the `checked`
      * property for that.