@ukic/web-components 2.1.0-beta.0 → 2.1.0-beta.10

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

@@ -6,7 +6,7 @@ import { IcNavButtonModes } from "./ic-navigation-button.types";
 export declare class NavigationButton {
   el: HTMLIcNavigationButtonElement;
   /**
-   *  label info to display
+   * The label info to display.
    */
   label: string;
   /**
@@ -14,7 +14,7 @@ export declare class NavigationButton {
    */
   href?: string;
   /**
-   * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
+   * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
    */
   target?: string;
   /**
@@ -22,11 +22,11 @@ export declare class NavigationButton {
    */
   rel?: string;
   /**
-   * Prompts the user to save the linked URL instead of navigating to it.
+   * If `true`, the user can save the linked URL instead of navigating to it.
    */
   download?: string | boolean;
   /**
-   * Hints at the human language of the linked URL.
+   * The human language of the linked URL.
    */
   hreflang?: string;
   /**
@@ -34,7 +34,7 @@ export declare class NavigationButton {
    */
   referrerpolicy?: ReferrerPolicy;
   /**
-   *  display mode
+   * The display mode.
    */
   mode: IcNavButtonModes;
   initialAppearance: IcThemeForeground;
@@ -44,7 +44,7 @@ export declare class NavigationButton {
   navBarMenuCloseHandler(): void;
   themeChangeHandler(ev: CustomEvent): void;
   /**
-   * Sets focus on the native `button`
+   * Sets focus on the native `button`.
    */
   setFocus(): Promise<void>;
   componentWillLoad(): void;

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

@@ -2,11 +2,11 @@ import { IcNavType } from "../../utils/types";
 export declare class NavigationGroup {
   el: HTMLIcNavigationGroupElement;
   /**
-   *  label to display on the group
+   * The label to display on the group.
    */
   label: string;
   /**
-   *  whether the group should be expandable/collapsible in the side menu
+   *  If `true`, the group will be expandable in the side menu.
    */
   expandable: boolean;
   dropdownOpen: boolean;
@@ -23,7 +23,7 @@ export declare class NavigationGroup {
   navItemClickHandler(): void;
   themeChangeHandler(ev: CustomEvent): void;
   /**
-   * Sets focus on the nav item
+   * Sets focus on the nav item.
    */
   setFocus(): Promise<void>;
   private sideNavExpandHandler;

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

@@ -6,27 +6,47 @@ import { IcNavType } from "../../utils/types";
 export declare class NavigationItem {
   el: HTMLIcNavigationItemElement;
   /**
-   *  Label of the navigation item
+   * The label of the navigation item.
    */
   label: string;
   /**
-   *  Destination of the navigation item
+   * The destination of the navigation item.
    */
   href: string;
   /**
-   *  If true, sets the navigation item in a selected state
+   *  The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
+   */
+  target?: string;
+  /**
+   * The relationship of the linked URL as space-separated link types.
+   */
+  rel?: string;
+  /**
+   * The human language of the linked URL.
+   */
+  hreflang?: string;
+  /**
+   * How much of the referrer to send when following the link.
+   */
+  referrerpolicy?: ReferrerPolicy;
+  /**
+   * If `true`, the user can save the linked URL instead of navigating to it.
+   */
+  download?: string | boolean;
+  /**
+   *  If `true`, the navigation item will be set in a selected state.
    */
   selected: boolean;
   /**
-   *  @internal Whether the navigation item is expandable
+   *  @internal If `true`, the navigation item will be expandable.
    */
   expandable: boolean;
   /**
-   * @internal display navigation item within tooltip
+   * @internal If `true`, the navigation item will be displayed within a tooltip.
    */
   displayNavigationTooltip: boolean;
   /**
-   * @internal display icon and label when side navigation is collapsed
+   * @internal If `true`, the icon and label will be displayed when side navigation is collapsed.
    */
   collapsedIconLabel: boolean;
   isTopNavChild: boolean;
@@ -46,12 +66,12 @@ export declare class NavigationItem {
   /**
    * @internal - Emitted when navigation item clicked.
    */
-  icNavItemClicked: EventEmitter<void>;
+  navItemClicked: EventEmitter<void>;
   themeChangeHandler(ev: CustomEvent): void;
   private topNavResizedHandler;
   private sideNavExpandHandler;
   /**
-   * Sets focus on the nav item
+   * Sets focus on the nav item.
    */
   setFocus(): Promise<void>;
   private handleBlur;

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

@@ -6,11 +6,11 @@ import { EventEmitter } from "../../stencil-public-runtime";
 export declare class NavigationMenu {
   el: HTMLIcNavigationMenuElement;
   /**
-   *  Version info to display
+   * The version info to display.
    */
   version: string;
   /**
-   *  Status info to display
+   * The status info to display.
    */
   status: string;
   /**

package/dist/types/components/ic-page-header/ic-page-header.d.ts

@@ -12,33 +12,35 @@ import { IcAlignment } from "../../utils/types";
 export declare class PageHeader {
   el: HTMLIcPageHeaderElement;
   /**
-   * The title to render on the component.
+   * The title to render on the page header.
    */
   heading?: string;
   /**
-   * The subtitle to render on the component.
+   * The subtitle to render on the page header.
    */
   subheading?: string;
   /**
-   * How the component should be aligned.
+   * The alignment of the page header.
    */
   aligned?: IcAlignment;
   /**
-   * Whether the component uses small styling.
+   * If `true`, the small styling will be applied to the page header.
    */
   small?: boolean;
   /**
-   * Set whether the bottom border is used
+   * If `true`, a border will be displayed along the bottom of the page header.
    */
   border?: boolean;
   /**
-   * Set whether the header is sticky at all breakpoints
+   * If `true`, the page header will be sticky at all breakpoints.
    */
   sticky?: boolean;
-  /** Set whether the header is only sticky for viewport widths of 992px and above
+  /**
+   *  If `true`, the page header will only be sticky for viewport widths of 992px and above.
    */
   stickyDesktopOnly?: boolean;
-  /** Set whether the reading pattern and tab order change in the action area for viewport widths of above 576px and when actions have not wrapped
+  /**
+   * If `true`, the reading pattern and tab order will change in the action area for viewport widths of above 576px and when actions have not wrapped.
    */
   reverseOrder?: boolean;
   deviceSize: number;

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

@@ -1,47 +1,51 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcInformationStatusOrEmpty } from "../../utils/types";
+import { IcInformationStatusOrEmpty, IcOrientation } from "../../utils/types";
 import { IcValueEventDetail } from "../../interface";
 export declare class RadioGroup {
   private radioOptions;
   host: HTMLIcRadioGroupElement;
   /**
-   * Provide a label for the input.
+   * The label for the radio group to be displayed.
    */
   label: string;
   /**
-   * Provide a name for the input.
+   * The name for the radio group to differentiate from other groups.
    */
   name: string;
   /**
-   * Specify if the input requires a value.
+   * If `true`, the radio group will require a value.
    */
   required: boolean;
   /**
-   * Hides the label and applies the required label value as an aria-label.
+   * 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.
+   */
+  orientation: IcOrientation;
+  /**
+   * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
    */
   hideLabel: boolean;
   /**
-   * Specify whether the input is disabled.
+   * If `true`, the disabled state will be set.
    */
   disabled: boolean;
   /**
-   * Provide helper text to display additional field guidance.
+   * The helper text that will be displayed for additional field guidance.
    */
   helperText: string;
   /**
-   * Specify whether small styling is to be applied to the element.
+   * If `true`, the small styling will be applied to the radio group.
    */
   small: boolean;
   /**
-   * Provide validation status - 'error'
+   * The validation status - e.g. 'error' | 'warning' | 'success'.
    */
   validationStatus: IcInformationStatusOrEmpty;
   /**
-   * Provide validation text - 'error'
+   * The validation text - e.g. 'error' | 'warning' | 'success'.
    */
   validationText: string;
   /**
-   * Provide checked state
+   * The checked state.
    */
   checkedValue: string;
   selectedChild: number;

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

@@ -4,46 +4,52 @@ import { IcValueEventDetail } from "../../interface";
 export declare class RadioOption {
   private radioElement;
   /**
-   * Determines whether the radio should be in selected state.
+   * If `true`, the radio option will be displayed in a selected state.
    */
   selected?: boolean;
   /**
-   * Determines whether the radio should be in disabled state.
+   * If `true`, the disabled state will be set.
    */
   disabled?: boolean;
   /**
-   * Provide a label for the input.
+   * The label for the radio option.
    */
   label?: string;
   /**
-   * Provide a value for the input.
+   * The value for the radio option.
    */
   value: string;
   /**
-   * Provide a name for the input.
+   * The name for the radio option.
    */
   name: string;
   /**
-   * Provide a group label for the input.
+   * The group label for the radio option.
    */
   groupLabel: string;
   /**
-   * Provide a text prop for the dynamic text.
+   * The text to be displayed when dynamic.
    */
   dynamicText: string;
-  /** Determines type of additional text field in relation to radio option */
+  /**
+   * The style of additionalField that will be displayed if used.
+   */
   additionalFieldDisplay: IcAdditionalFieldTypes;
   initiallySelected: boolean;
   host: HTMLIcRadioOptionElement;
   /**
-   * Emitted when radio is checked
+   * @deprecated This event should not be used anymore. Use icCheck instead.
    */
-  icCheck: EventEmitter<void>;
+  radioOptionSelect: EventEmitter<IcValueEventDetail>;
   /**
    * Emitted when a radio is selected.
    */
-  radioOptionSelect: EventEmitter<IcValueEventDetail>;
+  icCheck: EventEmitter<IcValueEventDetail>;
   selectedChangeHandler(selected: boolean): void;
+  /**
+   * Sets focus on the radio option.
+   */
+  setFocus(): Promise<void>;
   private defaultRadioValue;
   private skipFocus;
   private handleClick;

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

@@ -15,111 +15,112 @@ export declare class SearchBar {
   private truncateValue;
   private assistiveHintEl;
   private preventSubmit;
+  private debounceAriaLive;
   /**
-   * Provide a label for the input.
+   * The label for the search bar.
    */
   label: string;
   /**
-   * Specify if the input requires a value.
+   * If `true`, the search bar will require a value.
    */
   required?: boolean;
   /**
-   * Specify whether the input is disabled.
+   * If `true`, the disabled state will be set.
    */
   disabled?: boolean;
   /**
-   * Specify whether the input is read only.
+   * If `true`, the readonly state will be set.
    */
   readonly?: boolean;
   /**
-   * Provide a placeholder value to display.
+   * The placeholder value to display.
    */
   placeholder?: string;
   /**
-   * Specify whether the component fills the full width of the container.
-   * If true, this overrides the --input-width css prop.
+   * Specify whether the search bar fills the full width of the container.
+   * If `true`, this overrides the --input-width CSS variable.
    */
   fullWidth?: 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.
+   * If `true`, all options provided will be displayed.
    */
   disableFilter?: boolean;
   /**
-   * Hides the label and applies the required label value as an aria-label.
+   * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
    */
   hideLabel?: boolean;
   /**
-   * Provide helper text to display additional field guidance.
+   * The helper text that will be displayed for additional field guidance.
    */
   helperText?: string;
   /**
-   * Specify whether small styling is to be applied to the element.
+   * If `true`, the small styling will be applied to the search bar.
    */
   small?: boolean;
   /**
-   * Value of Search input.
+   * The value of the search input.
    */
   value: string;
   /**
-   * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.
+   * The automatic capitalisation of the text value as it is entered/edited by the user.
    * Available options: "off", "none", "on", "sentences", "words", "characters".
    */
   autocapitalize: string;
   /**
-   * Indicates whether the value of the control can be automatically completed by the browser.
+   * The state of autocompletion the browser can apply on the text value.
    */
   autocomplete?: IcAutocompleteTypes;
   /**
-   * Whether auto correction should be enabled when the user is entering/editing the text value.
+   * The state of autocorrection the browser can apply when the user is entering/editing the text value.
    */
   autocorrect?: IcAutocorrectStates;
   /**
-   * This Boolean attribute lets you specify that a form control should have input focus when the page loads.
+   * If `true`, the form control will have input focus when the page loads.
    */
   autofocus: boolean;
   /**
-   * Set the amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
+   * The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
    */
   debounce?: number;
-  private debounceChanged;
   /**
    * The name of the control, which is submitted with the form data.
    */
   name: string;
   /**
-   * If `true`, the element will have its spelling and grammar checked.
+   * If `true`, the value of the search will have its spelling and grammar checked.
    */
   spellcheck: boolean;
   /**
-   * Provide the suggested search options
+   * The suggested search options.
    */
   options?: IcMenuOption[];
   watchOptionsHandler(newOptions: IcMenuOption[]): void;
   /**
-   * Specify whether the input should be focussed when component loaded.
+   * If `true`, the search bar will be focused when component loaded.
    */
   focusOnLoad?: boolean;
   /**
-   * Provide hint text for hidden assistive description element.
+   * The hint text for the hidden assistive description element.
    */
   hintText?: string;
   /**
-   * Provide text for empty results list
+   * The text displayed when there are no options in the option list.
    */
   emptyOptionListText: string;
   /**
-   * Number of characters until suggestions appear
+   * The number of characters until suggestions appear.
    */
   charactersUntilSuggestion: number;
   watchValueHandler(newValue: string): void;
   /**
-   * Sets focus on the native `input`
+   * Sets focus on the native `input`.
    */
   setFocus(): Promise<void>;
   handleKeyDown(ev: CustomEvent): void;
   handleKeyUp(ev: KeyboardEvent): void;
   private handleSubmitSearch;
+  private handleSubmitSearchKeyDown;
   /**
    * Emitted when a keyboard input occurred.
    */
@@ -127,12 +128,12 @@ export declare class SearchBar {
   private onInput;
   private debounceAriaLiveUpdate;
   /**
-   * Emitted when input loses focus.
+   * @deprecated This event should not be used anymore. Use icSearchBarBlur instead.
    */
   icInputBlur: EventEmitter<IcSearchBarBlurEventDetail>;
   private onInputBlur;
   /**
-   * Emitted when input gains focus.
+   * @deprecated This event should not be used anymore. Use icSearchBarFocus instead.
    */
   icInputFocus: EventEmitter<IcValueEventDetail>;
   private onInputFocus;
@@ -145,6 +146,7 @@ export declare class SearchBar {
    */
   icClear: EventEmitter<void>;
   private handleClear;
+  private handleMouseDown;
   /**
    * Emitted when the search value has been submitted
    */
@@ -183,13 +185,13 @@ export declare class SearchBar {
   clearButtonFocused: boolean;
   searchSubmitFocused: boolean;
   prevNoOption: boolean;
+  highlightedValue: string;
   private handleOptionSelect;
+  private handleMenuOptionHighlight;
   private handleMenuChange;
   private setMenuChange;
   private handleHostFocus;
   private handleHostBlur;
-  onMenuClose(ev: CustomEvent): void;
-  onMenuOptionHighlighted(ev: CustomEvent): void;
   private handleShowClearButton;
   private handleFocusClearButton;
   private handleMenuCloseFromMenuChange;
@@ -200,7 +202,6 @@ export declare class SearchBar {
   private hadNoOptions;
   private isSubmitDisabled;
   private highlightFirstOptionAfterNoResults;
-  connectedCallback(): void;
   componentWillRender(): void;
   componentWillLoad(): void;
   componentDidLoad(): void;

package/dist/types/components/ic-section-container/ic-section-container.d.ts

@@ -1,11 +1,11 @@
 import { IcAlignment } from "../../utils/types";
 export declare class SectionContainer {
   /**
-   * How the container should be aligned.
+   * The alignment of the container.
    */
   aligned?: IcAlignment;
   /**
-   * Removes the standard vertical padding from the container.
+   * If `true`, the standard vertical padding from the container will be removed.
    */
   fullHeight?: boolean;
   render(): any;