@ukic/web-components 2.1.0-beta.15 → 2.1.0-beta.17

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

@@ -1,42 +1,44 @@
 export declare class PopoverMenu {
+  private anchorEl;
+  private ARIA_LABEL;
+  private backButton;
+  private currentFocus;
+  private popoverMenuEls;
   host: HTMLIcPopoverMenuElement;
+  openingFromChild: boolean;
+  openingFromParent: boolean;
   /**
    * The ID of the element the popover menu will anchor itself to. This is required unless the popover is a submenu.
    */
   anchor: string;
   /**
-   * The unique identifier for a popover submenu.
-   */
-  submenuId?: string;
-  /**
-   * If `true`, the popover menu will be displayed.
+   * @internal The parent popover menu of a child popover menu.
    */
-  open: boolean;
+  parentLabel?: string;
   /**
    * @internal The parent popover menu of a child popover menu.
    */
   parentPopover?: HTMLIcPopoverMenuElement;
+  /**
+   * The unique identifier for a popover submenu.
+   */
+  submenuId?: string;
   /**
    * @internal The level of menu being displayed.
    */
   submenuLevel: number;
   /**
-   * @internal The parent popover menu of a child popover menu.
+   * If `true`, the popover menu will be displayed.
    */
-  parentLabel?: string;
-  openingFromChild: boolean;
-  openingFromParent: boolean;
+  open: boolean;
+  watchOpenHandler(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  componentDidRender(): void;
   handleMenuItemClick(ev: CustomEvent): void;
   handleSubmenuChange(ev: Event): void;
-  watchOpenHandler(): void;
-  private setButtonFocus;
-  private popoverMenuEls;
-  private anchorEl;
-  private currentFocus;
-  private backButton;
-  private ARIA_LABEL;
-  private findAnchorEl;
   handleClick(ev: Event): void;
+  handleKeyDown(ev: KeyboardEvent): void;
   /**
    * @internal Opens the menu from the child menu.
    */
@@ -45,15 +47,13 @@ export declare class PopoverMenu {
    * @internal Opens the menu from the parent menu.
    */
   openFromParent(): Promise<void>;
+  private setButtonFocus;
+  private findAnchorEl;
   private isNotPopoverMenuEl;
   private closeMenu;
   private getNextItemToSelect;
-  handleKeyDown(ev: KeyboardEvent): void;
   private addMenuItems;
   private getMenuAriaLabel;
   private handleBackButtonClick;
-  componentDidRender(): void;
-  componentWillRender(): void;
-  componentDidLoad(): void;
   render(): any;
 }

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

@@ -1,37 +1,39 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcInformationStatusOrEmpty, IcOrientation } from "../../utils/types";
-import { IcValueEventDetail } from "../../interface";
+import { IcInformationStatusOrEmpty, IcOrientation, IcValueEventDetail } from "../../utils/types";
+import { IcChangeEventDetail } from "./ic-radio-group.types";
 export declare class RadioGroup {
   private radioOptions;
   host: HTMLIcRadioGroupElement;
+  checkedValue: string;
+  selectedChild: number;
   /**
-   * The label for the radio group to be displayed.
+   * If `true`, the disabled state will be set.
    */
-  label: string;
+  disabled: boolean;
   /**
-   * The name for the radio group to differentiate from other groups.
+   * The helper text that will be displayed for additional field guidance.
    */
-  name: string;
+  helperText: string;
   /**
-   * If `true`, the radio group will require a value.
+   * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
    */
-  required: boolean;
+  hideLabel: boolean;
   /**
-   * The orientation of the radio buttons in the radio group. If there are more than two radio buttons in a radio group or either of the radio buttons use the `additional-field` slot, then the orientation will always be vertical.
+   * The label for the radio group to be displayed.
    */
-  orientation: IcOrientation;
+  label: string;
   /**
-   * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
+   * The name for the radio group to differentiate from other groups.
    */
-  hideLabel: boolean;
+  name: string;
   /**
-   * If `true`, the disabled state will be set.
+   * The orientation of the radio buttons in the radio group. If there are more than two radio buttons in a radio group or either of the radio buttons use the `additional-field` slot, then the orientation will always be vertical.
    */
-  disabled: boolean;
+  orientation: IcOrientation;
   /**
-   * The helper text that will be displayed for additional field guidance.
+   * If `true`, the radio group will require a value.
    */
-  helperText: string;
+  required: boolean;
   /**
    * If `true`, the small styling will be applied to the radio group.
    */
@@ -44,18 +46,15 @@ export declare class RadioGroup {
    * The validation text - e.g. 'error' | 'warning' | 'success'.
    */
   validationText: string;
-  /**
-   * The checked state.
-   */
-  checkedValue: string;
-  selectedChild: number;
   /**
    * Emitted when a user selects a radio.
    */
-  icChange: EventEmitter<IcValueEventDetail>;
+  icChange: EventEmitter<IcChangeEventDetail>;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
   selectHandler(event: CustomEvent<IcValueEventDetail>): void;
+  changeHandler(): void;
   private handleKeyDown;
   private getNextItemToSelect;
-  componentDidLoad(): void;
   render(): any;
 }

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

@@ -0,0 +1,7 @@
+export interface IcChangeEventDetail {
+  value: string;
+  selectedOption: {
+    radio: HTMLIcRadioOptionElement;
+    textFieldValue?: string;
+  };
+}

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

@@ -1,67 +1,70 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcAdditionalFieldTypes } from "../../utils/types";
-import { IcValueEventDetail } from "../../interface";
+import { IcAdditionalFieldTypes, IcValueEventDetail } from "../../utils/types";
 export declare class RadioOption {
+  private defaultRadioValue;
+  private hasAdditionalField;
   private radioElement;
+  private skipFocus;
+  host: HTMLIcRadioOptionElement;
   /**
-   * If `true`, the radio option will be displayed in a selected state.
+   * The style of additionalField that will be displayed if used.
    */
-  selected?: boolean;
+  additionalFieldDisplay: IcAdditionalFieldTypes;
   /**
    * If `true`, the disabled state will be set.
    */
   disabled?: boolean;
   /**
-   * The label for the radio option.
+   * The text to be displayed when dynamic.
    */
-  label?: string;
+  dynamicText: string;
   /**
-   * The value for the radio option.
+   * The group label for the radio option.
    */
-  value: string;
+  groupLabel: string;
+  /**
+   * The label for the radio option.
+   */
+  label?: string;
   /**
    * The name for the radio option.
    */
   name: string;
   /**
-   * The group label for the radio option.
+   * The value for the radio option.
    */
-  groupLabel: string;
+  value: string;
   /**
-   * The text to be displayed when dynamic.
+   * If `true`, the radio option will be displayed in a selected state.
    */
-  dynamicText: string;
+  selected?: boolean;
+  initiallySelected: boolean;
+  watchSelectedHandler(): void;
   /**
-   * The style of additionalField that will be displayed if used.
+   * Emitted when the radio option is selected.
    */
-  additionalFieldDisplay: IcAdditionalFieldTypes;
-  initiallySelected: boolean;
-  host: HTMLIcRadioOptionElement;
+  icCheck: EventEmitter<IcValueEventDetail>;
   /**
    * @deprecated This event should not be used anymore. Use icCheck instead.
    */
   radioOptionSelect: EventEmitter<IcValueEventDetail>;
   /**
-   * Emitted when a radio is selected.
+   * Emitted when the radio option is selected or deselected.
    */
-  icCheck: EventEmitter<IcValueEventDetail>;
-  selectedChangeHandler(selected: boolean): void;
+  icSelectedChange: EventEmitter<void>;
+  disconnectedCallback(): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentDidRender(): void;
+  textfieldValueHandler(event: CustomEvent<{
+    value: string;
+  }>): void;
   /**
    * Sets focus on the radio option.
    */
   setFocus(): Promise<void>;
-  private defaultRadioValue;
-  private skipFocus;
   private handleClick;
   private swallowClick;
-  private hasAdditionalField;
-  componentWillLoad(): void;
   private handleFormReset;
-  textfieldValueHandler(event: CustomEvent<{
-    value: string;
-  }>): void;
-  componentDidLoad(): void;
-  componentDidRender(): void;
-  disconnectedCallback(): void;
   render(): any;
 }

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

@@ -1,158 +1,163 @@
 import { EventEmitter } from "../../stencil-public-runtime";
 import { IcAutocompleteTypes, IcAutocorrectStates, IcMenuOption } from "../../utils/types";
 import { IcSearchBarBlurEventDetail } from "./ic-search-bar.types";
-import { IcValueEventDetail, IcBlurEventDetail } from "../../interface";
+import { IcValueEventDetail, IcBlurEventDetail } from "../../utils/types";
 import { IcMenuChangeEventDetail, IcOptionSelectEventDetail } from "../ic-menu/ic-menu.types";
 export declare class SearchBar {
-  el: HTMLIcSearchBarElement;
-  private inputId;
-  private inputEl;
-  private menuId;
-  private searchSubmitButton;
-  private menu;
-  private menuCloseFromMenuChangeEvent;
   private anchorEl;
-  private truncateValue;
   private assistiveHintEl;
-  private preventSubmit;
   private debounceAriaLive;
-  private timeoutTimer;
-  private prevNoOption;
   private hasTimedOut;
+  private inputEl;
+  private inputId;
+  private menu;
+  private menuCloseFromMenuChangeEvent;
+  private menuId;
   private preLoad;
-  private retryViaKeyPress;
+  private preventSubmit;
+  private prevNoOption;
   private retryButtonClick;
+  private retryViaKeyPress;
+  private timeoutTimer;
+  private truncateValue;
+  private searchSubmitButton;
+  el: HTMLIcSearchBarElement;
+  ariaActiveDescendant: string;
+  clearButtonFocused: boolean;
+  highlightedValue: string;
+  open: boolean;
+  searchSubmitFocused: boolean;
+  showClearButton: boolean;
   /**
-   * The label for the search bar.
+   * The automatic capitalisation of the text value as it is entered/edited by the user.
+   * Available options: "off", "none", "on", "sentences", "words", "characters".
    */
-  label: string;
+  autocapitalize: string;
   /**
-   * If `true`, the search bar will require a value.
+   * The state of autocompletion the browser can apply on the text value.
    */
-  required?: boolean;
+  autocomplete?: IcAutocompleteTypes;
   /**
-   * If `true`, the disabled state will be set.
+   * The state of autocorrection the browser can apply when the user is entering/editing the text value.
    */
-  disabled?: boolean;
+  autocorrect?: IcAutocorrectStates;
   /**
-   * If `true`, the readonly state will be set.
+   * If `true`, the form control will have input focus when the page loads.
    */
-  readonly?: boolean;
+  autofocus: boolean;
   /**
-   * The placeholder value to display.
+   * The number of characters until suggestions appear.
    */
-  placeholder?: string;
+  charactersUntilSuggestion: number;
   /**
-   * Specify whether the search bar fills the full width of the container.
-   * If `true`, this overrides the --input-width CSS variable.
+   * If `true`, the disabled state will be set.
    */
-  fullWidth?: boolean;
+  disabled?: boolean;
   /**
    * Specify whether to disable the built in filtering. For example, if options will already be filtered from external source.
    * If `true`, all options provided will be displayed.
    */
   disableFilter?: boolean;
   /**
-   * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
+   * The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
    */
-  hideLabel?: boolean;
+  debounce?: number;
   /**
-   * The helper text that will be displayed for additional field guidance.
+   * The text displayed when there are no options in the option list.
    */
-  helperText?: string;
+  emptyOptionListText: string;
   /**
-   * If `true`, the small styling will be applied to the search bar.
+   * If `true`, the search bar will be focused when component loaded.
    */
-  small?: boolean;
+  focusOnLoad?: boolean;
   /**
-   * The value of the search input.
+   * Specify whether the search bar fills the full width of the container.
+   * If `true`, this overrides the --input-width CSS variable.
    */
-  value: string;
+  fullWidth?: boolean;
   /**
-   * The automatic capitalisation of the text value as it is entered/edited by the user.
-   * Available options: "off", "none", "on", "sentences", "words", "characters".
+   * The helper text that will be displayed for additional field guidance.
    */
-  autocapitalize: string;
+  helperText?: string;
   /**
-   * The state of autocompletion the browser can apply on the text value.
+   * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
    */
-  autocomplete?: IcAutocompleteTypes;
+  hideLabel?: boolean;
   /**
-   * The state of autocorrection the browser can apply when the user is entering/editing the text value.
+   * The hint text for the hidden assistive description element.
    */
-  autocorrect?: IcAutocorrectStates;
+  hintText?: string;
   /**
-   * If `true`, the form control will have input focus when the page loads.
+   * The label for the search bar.
    */
-  autofocus: boolean;
+  label: string;
   /**
-   * The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
+   * Trigger loading state when fetching options asyncronously
    */
-  debounce?: number;
+  loading?: boolean;
+  /**
+   * Change the message displayed when external loading times out.
+   */
+  loadingErrorLabel?: string;
+  /**
+   * Change the message displayed whilst the options are being loaded externally.
+   */
+  loadingLabel?: string;
   /**
    * The name of the control, which is submitted with the form data.
    */
   name: string;
   /**
-   * If `true`, the value of the search will have its spelling and grammar checked.
+   * The placeholder value to display.
    */
-  spellcheck: boolean;
+  placeholder?: string;
   /**
-   * The suggested search options.
+   * If `true`, the readonly state will be set.
    */
-  options?: IcMenuOption[];
+  readonly?: boolean;
   /**
-   * If using external filtering, set a timeout for when loading takes too long.
+   * If `true`, the search bar will require a value.
    */
-  timeout?: number;
+  required?: boolean;
   /**
-   * Change the message displayed whilst the options are being loaded externally.
+   * If `true`, the small styling will be applied to the search bar.
    */
-  loadingLabel?: string;
+  small?: boolean;
   /**
-   * Change the message displayed when external loading times out.
+   * If `true`, the value of the search will have its spelling and grammar checked.
    */
-  loadingErrorLabel?: string;
+  spellcheck: boolean;
   /**
-   * Trigger loading state when fetching options asyncronously
+   * If using external filtering, set a timeout for when loading takes too long.
    */
-  loading?: boolean;
+  timeout?: number;
   loadingHandler(newValue: boolean): void;
+  filteredOptions: IcMenuOption[];
   filteredOptionsHandler(newOptions: IcMenuOption[]): void;
-  watchOptionsHandler(newOptions: IcMenuOption[]): void;
-  /**
-   * If `true`, the search bar will be focused when component loaded.
-   */
-  focusOnLoad?: boolean;
   /**
-   * The hint text for the hidden assistive description element.
+   * The suggested search options.
    */
-  hintText?: string;
+  options?: IcMenuOption[];
+  watchOptionsHandler(newOptions: IcMenuOption[]): void;
   /**
-   * The text displayed when there are no options in the option list.
+   * The value of the search input.
    */
-  emptyOptionListText: string;
+  value: string;
+  watchValueHandler(newValue: string): void;
   /**
-   * The number of characters until suggestions appear.
+   * Emitted when the value has changed.
    */
-  charactersUntilSuggestion: number;
-  watchValueHandler(newValue: string): void;
+  icChange: EventEmitter<IcValueEventDetail>;
   /**
-   * Sets focus on the native `input`.
+   * Emitted when value is cleared with clear button
    */
-  setFocus(): Promise<void>;
-  handleKeyDown(ev: CustomEvent): void;
-  handleKeyUp(ev: KeyboardEvent): void;
-  private handleSubmitSearch;
-  private handleSubmitSearchKeyDown;
-  private handleRetry;
-  private triggerLoading;
+  icClear: EventEmitter<void>;
+  private handleClear;
   /**
    * Emitted when a keyboard input occurred.
    */
   icInput: EventEmitter<IcValueEventDetail>;
   private onInput;
-  private debounceAriaLiveUpdate;
   /**
    * @deprecated This event should not be used anymore. Use icSearchBarBlur instead.
    */
@@ -163,20 +168,6 @@ export declare class SearchBar {
    */
   icInputFocus: EventEmitter<IcValueEventDetail>;
   private onInputFocus;
-  /**
-   * Emitted when the value has changed.
-   */
-  icChange: EventEmitter<IcValueEventDetail>;
-  /**
-   * Emitted when value is cleared with clear button
-   */
-  icClear: EventEmitter<void>;
-  private handleClear;
-  private handleMouseDown;
-  /**
-   * Emitted when the search value has been submitted
-   */
-  icSubmitSearch: EventEmitter<IcValueEventDetail>;
   /**
    * Emitted when option is highlighted within the menu
    */
@@ -190,12 +181,19 @@ export declare class SearchBar {
    */
   icClearBlur: EventEmitter<IcBlurEventDetail>;
   private handleClearBlur;
+  /**
+   * Emitted when the 'retry loading' button is clicked
+   */
+  icRetryLoad: EventEmitter<IcValueEventDetail>;
+  /**
+   * Emitted when the search value has been submitted
+   */
+  icSubmitSearch: EventEmitter<IcValueEventDetail>;
   /**
    * @internal - Emitted when blur is invoked from search submit button
    */
   icSubmitSearchBlur: EventEmitter<IcBlurEventDetail>;
   private handleSubmitSearchBlur;
-  private handleSubmitSearchFocus;
   /**
    * Emitted when blur is invoked from ic-search-bar
    */
@@ -204,17 +202,23 @@ export declare class SearchBar {
    * Emitted when focus is invoked from ic-search-bar
    */
   icSearchBarFocus: EventEmitter<void>;
+  disconnectedCallback(): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  handleKeyDown(ev: CustomEvent): void;
+  handleKeyUp(ev: KeyboardEvent): void;
   /**
-   * Emitted when the 'retry loading' button is clicked
+   * Sets focus on the native `input`.
    */
-  icRetryLoad: EventEmitter<IcValueEventDetail>;
-  open: boolean;
-  filteredOptions: IcMenuOption[];
-  ariaActiveDescendant: string;
-  showClearButton: boolean;
-  clearButtonFocused: boolean;
-  searchSubmitFocused: boolean;
-  highlightedValue: string;
+  setFocus(): Promise<void>;
+  private handleMouseDown;
+  private handleSubmitSearchFocus;
+  private handleSubmitSearch;
+  private debounceAriaLiveUpdate;
+  private handleSubmitSearchKeyDown;
+  private handleRetry;
+  private triggerLoading;
   private handleOptionSelect;
   private handleMenuOptionHighlight;
   private handleMenuChange;
@@ -231,9 +235,5 @@ export declare class SearchBar {
   private hadNoOptions;
   private isSubmitDisabled;
   private highlightFirstOptionAfterNoResults;
-  componentWillRender(): void;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  disconnectedCallback(): void;
   render(): any;
 }

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

@@ -1,4 +1,4 @@
-import { IcValueEventDetail, IcRelatedTarget } from "../../interface";
+import { IcValueEventDetail, IcRelatedTarget } from "../../utils/types";
 export interface IcSearchBarBlurEventDetail extends IcValueEventDetail {
   relatedTarget: IcRelatedTarget;
 }