@ukic/web-components 3.3.0 → 3.5.0

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

@@ -1,6 +1,9 @@
 import { EventEmitter } from "../../stencil-public-runtime";
 import { IcInformationStatusOrEmpty, IcOrientation, IcSizesNoLarge, IcThemeMode, IcValueEventDetail } from "../../utils/types";
 import { IcChangeEventDetail } from "./ic-radio-group.types";
+/**
+ * @slot helper-text - Content is set as the helper text for the radio group.
+ */
 export declare class RadioGroup {
     private radioContainer?;
     private radioOptions;

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

@@ -3,6 +3,10 @@ import { IcAutocompleteTypes, IcAutocorrectStates, IcMenuOption, IcMultiValueEve
 import { IcSearchBarBlurEventDetail, IcSearchBarSearchModes } from "./ic-search-bar.types";
 import { IcValueEventDetail, IcBlurEventDetail } from "../../utils/types";
 import { IcMenuChangeEventDetail, IcOptionSelectEventDetail } from "../ic-menu/ic-menu.types";
+import { IcButtonTypes } from "../ic-button/ic-button.types";
+/**
+ * @slot helper-text - Content is set as the helper text for the search bar.
+ */
 export declare class SearchBar {
     private anchorEl?;
     private assistiveHintEl?;
@@ -49,6 +53,7 @@ export declare class SearchBar {
      * The number of characters until suggestions appear. The submit button will be disabled until the inputted value is equal to or greater than this number.
      */
     charactersUntilSuggestion: number;
+    watchCharactersUntilSuggestionHandler(): void;
     /**
      * If `true`, the disabled state will be set.
      */
@@ -118,6 +123,12 @@ export declare class SearchBar {
      * The placeholder value to display.
      */
     placeholder: string;
+    /**
+     * If `true` the parent form will not submit when the icSubmitSearch event fires.
+     */
+    preventFormSubmitOnSearch: boolean;
+    searchButtonType: IcButtonTypes;
+    preventFormSubmitOnSearchHandler(): void;
     /**
      * If `true`, the readonly state will be set.
      */
@@ -249,5 +260,7 @@ export declare class SearchBar {
     private hasOptionsOrFilterDisabled;
     private hadNoOptions;
     private isSubmitDisabled;
+    private showMenuWithNoInput;
+    private updateSearchButtonType;
     render(): any;
 }

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

@@ -2,15 +2,16 @@ import { EventEmitter } from "../../stencil-public-runtime";
 import { IcInformationStatusOrEmpty, IcMenuOption, IcSearchMatchPositions, IcMultiValueEventDetail, IcSizes, IcThemeMode } from "../../utils/types";
 import { IcOptionSelectEventDetail } from "../ic-menu/ic-menu.types";
 /**
+ * @slot helper-text - Content is set as the helper text for the select.
  * @slot icon - Content will be placed to the left of the select text input.
  */
 export declare class Select {
     private anchorEl?;
     private blurredBecauseButtonPressed;
-    private characterKeyPressTimer;
+    private characterKeyPressTimer?;
     private clearButton?;
     private customSelectElement?;
-    private debounceAria;
+    private debounceAria?;
     private hasSetDefaultValue;
     private hasTimedOut;
     private inheritedAttributes;
@@ -22,13 +23,13 @@ export declare class Select {
     private retryButtonClick;
     private searchableMenuItemSelected;
     private searchableSelectElement?;
-    private timeoutTimer;
+    private timeoutTimer?;
     private ungroupedOptions;
     private hostMutationObserver;
     el: HTMLIcSelectElement;
-    ariaActiveDescendant: string;
+    ariaActiveDescendant?: string;
     clearButtonFocused: boolean;
-    debounceIcInput: number;
+    debounceIcInput?: number;
     hiddenInputValue: string | null;
     noOptions: IcMenuOption[] | null;
     open: boolean;
@@ -37,16 +38,16 @@ export declare class Select {
     /**
      * If `true`, the disabled state will be set.
      */
-    disabled?: boolean;
+    disabled: boolean;
     watchDisabledHandler(): void;
     /**
      * If `true`, the built in filtering will be disabled for a searchable variant. For example, if options will already be filtered from external source.
      */
-    disableAutoFiltering?: boolean;
+    disableAutoFiltering: boolean;
     /**
      * The text displayed when there are no options in the option list.
      */
-    emptyOptionListText?: string;
+    emptyOptionListText: string;
     /**
      * The <form> element to associate the select with.
      */
@@ -54,23 +55,23 @@ export declare class Select {
     /**
      * If `true`, the select will fill the width of the container.
      */
-    fullWidth?: boolean;
+    fullWidth: boolean;
     /**
      * The helper text that will be displayed for additional field guidance.
      */
-    helperText?: string;
+    helperText: string;
     /**
      * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
      */
-    hideLabel?: boolean;
+    hideLabel: boolean;
     /**
      * If `true`, descriptions of options will be included when filtering options in a searchable select. Only applies to built in filtering.
      */
-    includeDescriptionsInSearch?: boolean;
+    includeDescriptionsInSearch: boolean;
     /**
      * If `true`, group titles of grouped options will be included when filtering options in a searchable select. Only applies to built in filtering.
      */
-    includeGroupTitlesInSearch?: boolean;
+    includeGroupTitlesInSearch: boolean;
     /**
      * The label for the select.
      */
@@ -78,51 +79,51 @@ export declare class Select {
     /**
      * The message displayed when external loading times out.
      */
-    loadingErrorLabel?: string;
+    loadingErrorLabel: string;
     /**
      * The message displayed whilst the options are being loaded externally.
      */
-    loadingLabel?: string;
+    loadingLabel: string;
     /**
      * If `true`, multiple options can be selected.
      */
-    multiple?: boolean;
+    multiple: boolean;
     /**
      * The name of the control, which is submitted with the form data.
      */
-    name?: string;
+    name: string;
     /**
      * The placeholder value to be displayed.
      */
-    placeholder?: string;
+    placeholder: string;
     /**
      * If `true`, the readonly state will be set.
      */
-    readonly?: boolean;
+    readonly: boolean;
     /**
      * If `true`, the select will require a value.
      */
-    required?: boolean;
+    required: boolean;
     /**
      * If `true`, a searchable variant of the select will be displayed which can be typed in to filter options. This functionality is only available on the single-select variant of the select component.
      */
-    searchable?: boolean;
+    searchable: boolean;
     /**
      * Whether the search string of the searchable select should match the start of or anywhere in the options. Only applies to built in filtering.
      */
-    searchMatchPosition?: IcSearchMatchPositions;
+    searchMatchPosition: IcSearchMatchPositions;
     /**
      * If `true`, the icOptionSelect event will be fired on enter instead of ArrowUp and ArrowDown on the single select.
      */
-    selectOnEnter?: boolean;
+    selectOnEnter: boolean;
     /**
      * If `true`, a button which clears the select input when clicked will be displayed. The button will always appear on the searchable select.
      */
-    showClearButton?: boolean;
+    showClearButton: boolean;
     /**
      * The size of the select.
      */
-    size?: IcSizes;
+    size: IcSizes;
     /**
      * If using external filtering, set a timeout for when loading takes too long.
      */
@@ -130,42 +131,42 @@ export declare class Select {
     /**
      * 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;
+    theme: IcThemeMode;
     /**
      * The validation status - e.g. 'error' | 'warning' | 'success'.
      */
-    validationStatus?: IcInformationStatusOrEmpty;
+    validationStatus: IcInformationStatusOrEmpty;
     /**
      * The text to display as the validation message.
      */
-    validationText?: string;
+    validationText: string;
     /**
      * If `true`, the loading state will be triggered when fetching options asynchronously.
      */
-    loading?: boolean;
+    loading: boolean;
     loadingHandler(newValue: boolean): void;
     /**
      * The possible selection options.
      */
-    options?: IcMenuOption[];
+    options: IcMenuOption[];
     filteredOptions: IcMenuOption[];
     uniqueOptions: IcMenuOption[];
     watchOptionsHandler(): void;
     /**
      * The amount of time, in milliseconds, to wait to trigger the `icInput` event after each keystroke.
      */
-    debounce?: number;
-    currDebounce: number | undefined;
+    debounce: number;
+    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.
      * For the multi-select variant, the value must be an array of option values.
      */
-    value?: string | string[] | null;
-    initialValue: string | string[] | null | undefined;
+    value: string | string[] | null;
+    initialValue: string | string[] | null;
     inputValueToFilter: string | null;
-    currValue?: string | string[] | null;
+    currValue: string | string[] | null;
     valueChangedHandler(): void;
     openChangedHandler(): void;
     /**
@@ -219,7 +220,6 @@ export declare class Select {
     setFocus(): Promise<void>;
     private hostMutationCallback;
     private handleRetry;
-    private updateOnChangeDebounce;
     private emitIcChange;
     private emitIcInput;
     private setOptions;
@@ -242,7 +242,6 @@ export declare class Select {
     private getValueSortedByOptions;
     private handleNativeSelectChange;
     private handleCustomSelectChange;
-    private handleMultipleSelectChange;
     private handleSelectAllChange;
     private handleMenuChange;
     private handleMenuKeyPress;
@@ -266,7 +265,6 @@ export declare class Select {
     private getValueFromLabel;
     private handleSearchableSelectInput;
     private updateSearchableSelectResultAriaLive;
-    private debounceAriaLiveUpdate;
     private updateMultiSelectedCountAriaLive;
     private getDefaultValue;
     private setDefaultValue;
@@ -275,5 +273,6 @@ export declare class Select {
     private onTimeoutBlur;
     private handleFormReset;
     private clearInput;
+    private renderNativeOption;
     render(): any;
 }

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

@@ -25,6 +25,10 @@ export declare class SideNavigation {
      * The app title to be displayed. This is required, unless a slotted app title link is used.
      */
     appTitle?: string;
+    /**
+     * If `true`, the side navigation will close when a navigation item is clicked. This behaviour is only applicable on larger device sizes.
+     */
+    closeOnNavItemClick?: boolean;
     /**
      * If `true`, the icon and label will appear when side navigation is collapsed.
      */
@@ -96,6 +100,7 @@ export declare class SideNavigation {
     private paddingIconWidth;
     private displayTooltipWithExpandedLongLabel;
     private setMenuExpanded;
+    private handleNavItemClicked;
     /**
      * As the mobile top bar is fixed, a padding top is required
      * to push main content down the height of the mobile top bar

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

@@ -2,6 +2,7 @@ import { EventEmitter } from "../../stencil-public-runtime";
 import { IcSwitchChangeEventDetail } from "./ic-switch.types";
 import { IcSizesNoLarge, IcThemeMode } from "../../utils/types";
 /**
+ * @slot helper-text - Content is set as the helper text for the switch.
  * @slot right-adornment - Content is placed to the right of switch.
  */
 export declare class Switch {

package/dist/types/components/ic-text-field/ic-text-field.d.ts

@@ -2,6 +2,7 @@ import { EventEmitter } from "../../stencil-public-runtime";
 import { IcAutocompleteTypes, IcAutocorrectStates, IcInformationStatusOrEmpty, IcValueEventDetail, IcSizesNoLarge, IcThemeMode } from "../../utils/types";
 import { IcAriaAutocompleteTypes, IcTextFieldInputModes, IcTextFieldTypes } from "./ic-text-field.types";
 /**
+ * @slot helper-text - Content is set as the helper text for the text field.
  * @slot icon - Content will be placed to the left of the text input.
  */
 export declare class TextField {
@@ -16,6 +17,7 @@ export declare class TextField {
     minCharactersUnattained: boolean;
     maxValueExceeded: boolean;
     minValueUnattained: boolean;
+    isFocussed: boolean;
     /**
      * @slot clear-button - an ic-button clear component will render as an end adornment to the input.
      * @slot search-submit-button - an ic-button search submit component will render as an end adornment to the input.
@@ -32,7 +34,7 @@ export declare class TextField {
     /**
      * @internal Used to identify if the slotted menu is rendered
      */
-    ariaExpanded: string | undefined;
+    ariaExpanded: string | null;
     /**
      * @internal Used to identify any related child component
      */
@@ -149,7 +151,7 @@ export declare class TextField {
     /**
      * @internal Used to set the role if not default textbox;
      */
-    role: string | undefined;
+    role: string | null;
     /**
      * The number of rows to transform the text field into a text area with a specific height.
      */

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

@@ -13,20 +13,20 @@ export declare class ToggleButton {
     /**
      * If `true`, the toggle button will be in a checked state.
      */
-    checked?: boolean;
+    checked: boolean;
     /**
      * If `true`, the toggle button will be in disabled state.
      */
-    disabled?: boolean;
+    disabled: boolean;
     watchDisabledHandler(): void;
     /**
      * If `true`, the toggle button will fill the width of the container.
      */
-    fullWidth?: boolean;
+    fullWidth: boolean;
     /**
      * The placement of the icon in relation to the toggle button label.
      */
-    iconPlacement?: IcIconPlacementOptions;
+    iconPlacement: IcIconPlacementOptions;
     /**
      * The label to display in the toggle button. This is required for the default variant of toggle buttons.
      */
@@ -34,27 +34,27 @@ export declare class ToggleButton {
     /**
      * If `true`, the toggle button will be in loading state.
      */
-    loading?: boolean;
+    loading: boolean;
     /**
      * If `true`, the toggle button will display as black in the light theme, and white in dark theme.
      */
-    monochrome?: boolean;
+    monochrome: boolean;
     /**
      * The size of the toggle button to be displayed.
      */
-    size?: IcSizes;
+    size: IcSizes;
     /**
      * 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;
+    theme: IcThemeMode;
     /**
      * The position of the tooltip in relation to the toggle button.
      */
-    tooltipPlacement?: IcButtonTooltipPlacement;
+    tooltipPlacement: IcButtonTooltipPlacement;
     /**
      * The variant of the toggle button.
      */
-    variant?: "default" | "icon";
+    variant: "default" | "icon";
     /**
      * Emitted when the user clicks a toggle button.
      */
@@ -64,7 +64,6 @@ export declare class ToggleButton {
     componentWillLoad(): void;
     componentDidLoad(): void;
     handleHostClick(e: Event): void;
-    private loopAttributes;
     private handleFocus;
     private handleClick;
     render(): any;

package/dist/types/components/ic-toggle-button-group/ic-toggle-button-group.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcSizes, IcSelectTypes, IcSelectMethodTypes, IcThemeMode, IcButtonTooltipPlacement } from "../../utils/types";
+import { IcSizes, IcSelectTypes, IcSelectMethodTypes, IcThemeMode, IcButtonTooltipPlacement, IcIconPlacementOptions } from "../../utils/types";
 import { IcChangeEventDetail } from "./ic-toggle-button-group.types";
 interface lastKey {
     key: string | null;
@@ -11,7 +11,7 @@ export declare class ToggleButtonGroup {
     /**
      * The accessible label of the toggle button group component to provide context for screen reader users.
      */
-    accessibleLabel?: string;
+    accessibleLabel: string;
     /**
      * If `true`, the toggle button group will be set to the disabled state.
      */
@@ -20,39 +20,39 @@ export declare class ToggleButtonGroup {
     /**
      * If `true`, the toggle button group will fill the width of the container.
      */
-    fullWidth?: boolean;
+    fullWidth: boolean;
     watchFullWidthHandler(): void;
     /**
      * The placement of the icons in relation to the toggle button labels.
      */
-    iconPlacement?: "left" | "right" | "top";
+    iconPlacement?: IcIconPlacementOptions;
     /**
      * If `true`, the toggle button group will be in loading state.
      */
-    loading?: boolean;
+    loading: boolean;
     watchLoadingHandler(): void;
     /**
      * If `true`, the toggle button group will display as black in the light theme, and white in dark theme.
      */
-    monochrome?: boolean;
+    monochrome: boolean;
     watchMonochromeHandler(): void;
     /**
      * If `auto`, controls are toggled automatically when navigated to. If `manual`, the controls must be actioned to change their toggled state. The value of this prop is ignored if `selectType` is set to`multi`.
      */
-    selectMethod?: IcSelectMethodTypes;
+    selectMethod: IcSelectMethodTypes;
     /**
      * Sets whether single or multiple options can be toggled. If `multi`, then the `selectMethod` is always `manual`.
      */
-    selectType?: IcSelectTypes;
+    selectType: IcSelectTypes;
     /**
      * The size of the toggle buttons to be displayed. This does not affect the font size of the accessible label.
      */
-    size?: IcSizes;
+    size: IcSizes;
     watchSizeHandler(): 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;
+    theme: IcThemeMode;
     watchThemeHandler(): void;
     /**
      * The position of the tooltip in relation to the toggle buttons.
@@ -73,9 +73,7 @@ export declare class ToggleButtonGroup {
     componentDidLoad(): void;
     disconnectedCallback(): void;
     private keyListener;
-    private setSlottedAria;
     private handleHostFocus;
-    private proxySelectHandler;
     private handleKeyDown;
     private getNextItemToSelect;
     private getAllToggleButtons;

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

@@ -12,12 +12,14 @@ import { IcSearchBarBlurEventDetail } from "../ic-search-bar/ic-search-bar.types
  */
 export declare class TopNavigation {
     private hasAppIcon;
+    private hasAppTitleSlot;
     private hasIconButtons;
     private hasNavigation;
     private hasSearchSlotContent;
     private mobileSearchButtonEl?;
     private resizeObserver;
     private searchBar;
+    private menuButtonEl?;
     el: HTMLIcTopNavigationElement;
     deviceSize: number;
     foregroundColor: IcBrandForeground;
@@ -30,36 +32,36 @@ export declare class TopNavigation {
     /**
      * The alignment of the top navigation content.
      */
-    contentAligned?: IcAlignment;
+    contentAligned: IcAlignment;
     /**
      * Can set a custom breakpoint for the top navigation to switch to mobile mode.
      * Must be one of our specified breakpoints in px: `0`, `576`, `768`, `992`, `1200`.
      */
-    customMobileBreakpoint?: IcDeviceSizes;
+    customMobileBreakpoint: IcDeviceSizes;
     /**
      *  The URL to navigate to when the app title is clicked.
      */
-    href?: string;
+    href: string;
     /**
      * If `true`, the flyout navigation menu on small devices will be contained by the parent element.
      */
-    inline?: boolean;
+    inline: boolean;
     /**
      * The short title of the app to be displayed at small screen sizes in place of the app title.
      */
-    shortAppTitle?: string;
+    shortAppTitle: string;
     /**
      * The status info to be displayed.
      */
-    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;
+    theme: IcThemeMode;
     /**
      * The version info to be displayed.
      */
-    version?: string;
+    version: string;
     /**
      * The app title to be displayed. This is required, unless a slotted app title link is used.
      */