@ukic/web-components 2.8.0 → 2.10.0

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

@@ -4,61 +4,61 @@ import { IcSizes } from "../../utils/types";
  * @slot badge-icon - Icon will be rendered inside the badge if type is set to icon.
  */
 export declare class Badge {
-  private customColorRGBA;
-  private foregroundColour;
-  el: HTMLIcBadgeElement;
-  /**
-   * The accessible label of the badge component to provide context for screen reader users.
-   */
-  accessibleLabel?: string;
-  /**
-   * The custom badge colour. This will only style the badge component if variant="custom".
-   * Can be a hex value e.g. "#ff0000", RGB e.g. "rgb(255, 0, 0)", or RGBA e.g. "rgba(255, 0, 0, 1)".
-   */
-  customColor?: IcColor;
-  /**
-   * The maximum number shown on the badge appended with a +.
-   * This will only be displayed if type="text" and textLabel is not empty.
-   */
-  maxNumber?: number;
-  /**
-   * The positioning of the badge in reference to the parent element.
-   */
-  position?: IcBadgePositions;
-  /**
-   * The size of the badge to be displayed.
-   */
-  size?: IcSizes;
-  /**
-   * The text displayed in the badge. This will only be displayed if type="text".
-   */
-  textLabel?: string;
-  /**
-   * The type of badge to be displayed.
-   */
-  type?: IcBadgeTypes;
-  /**
-   * The variant of the badge to be displayed.
-   */
-  variant?: IcBadgeVariants;
-  /**
-   * If `true`, the badge will be displayed.
-   */
-  visible: boolean;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  /**
-   * @deprecated This method should not be used anymore. Use visible prop to set badge visibility.
-   */
-  showBadge(): Promise<void>;
-  /**
-   * @deprecated This method should not be used anymore. Use visible prop to set badge visibility.
-   */
-  hideBadge(): Promise<void>;
-  private setBadgeColour;
-  private getBadgeForeground;
-  private getTextLabel;
-  private setAccessibleLabel;
-  private isAccessibleLabelDefined;
-  render(): any;
+    private customColorRGBA;
+    private foregroundColour;
+    el: HTMLIcBadgeElement;
+    /**
+     * The accessible label of the badge component to provide context for screen reader users.
+     */
+    accessibleLabel?: string;
+    /**
+     * The custom badge colour. This will only style the badge component if variant="custom".
+     * Can be a hex value e.g. "#ff0000", RGB e.g. "rgb(255, 0, 0)", or RGBA e.g. "rgba(255, 0, 0, 1)".
+     */
+    customColor?: IcColor;
+    /**
+     * The maximum number shown on the badge appended with a +.
+     * This will only be displayed if type="text" and textLabel is not empty.
+     */
+    maxNumber?: number;
+    /**
+     * The positioning of the badge in reference to the parent element.
+     */
+    position?: IcBadgePositions;
+    /**
+     * The size of the badge to be displayed.
+     */
+    size?: IcSizes;
+    /**
+     * The text displayed in the badge. This will only be displayed if type="text".
+     */
+    textLabel?: string;
+    /**
+     * The type of badge to be displayed.
+     */
+    type?: IcBadgeTypes;
+    /**
+     * The variant of the badge to be displayed.
+     */
+    variant?: IcBadgeVariants;
+    /**
+     * If `true`, the badge will be displayed.
+     */
+    visible: boolean;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    /**
+     * @deprecated This method should not be used anymore. Use visible prop to set badge visibility.
+     */
+    showBadge(): Promise<void>;
+    /**
+     * @deprecated This method should not be used anymore. Use visible prop to set badge visibility.
+     */
+    hideBadge(): Promise<void>;
+    private setBadgeColour;
+    private getBadgeForeground;
+    private getTextLabel;
+    private setAccessibleLabel;
+    private isAccessibleLabelDefined;
+    render(): any;
 }

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

@@ -1,30 +1,35 @@
+import { IcThemeForeground } from "../../utils/types";
 /**
  * @slot icon - Content will be rendered to the left of the breadcrumb page title.
  */
 export declare class Breadcrumb {
-  el: HTMLIcBreadcrumbElement;
-  /**
-   * If `true`, aria-current will be set on the breadcrumb.
-   */
-  current?: boolean;
-  /**
-   * The URL that the breadcrumb link points to.
-   */
-  href?: string;
-  /**
-   * The title of the breadcrumb.
-   */
-  pageTitle: string;
-  /**
-   * @internal If `true`, back icon will be displayed.
-   */
-  showBackIcon: boolean;
-  componentWillRender(): void;
-  /**
-   * Sets focus on the breadcrumb.
-   */
-  setFocus(): Promise<void>;
-  private renderDefaultBreadcrumb;
-  private setSlottedCurrentPageClass;
-  render(): any;
+    el: HTMLIcBreadcrumbElement;
+    /**
+     * @internal The appearance of the breadcrumb.
+     */
+    appearance: IcThemeForeground;
+    /**
+     * If `true`, aria-current will be set on the breadcrumb.
+     */
+    current?: boolean;
+    /**
+     * The URL that the breadcrumb link points to.
+     */
+    href?: string;
+    /**
+     * The title of the breadcrumb.
+     */
+    pageTitle: string;
+    /**
+     * @internal If `true`, back icon will be displayed.
+     */
+    showBackIcon: boolean;
+    componentWillRender(): void;
+    /**
+     * Sets focus on the breadcrumb.
+     */
+    setFocus(): Promise<void>;
+    private renderDefaultBreadcrumb;
+    private setSlottedCurrentPageClass;
+    render(): any;
 }

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

@@ -1,40 +1,45 @@
+import { IcThemeForeground } from "../../utils/types";
 export declare class BreadcrumbGroup {
-  private ADD_CLASS_DELAY;
-  private breadcrumb;
-  private breadcrumbs;
-  private collapsedBreadcrumbEl;
-  private collapsedBreadcrumbs;
-  private collapsedBreadcrumbWrapper;
-  private IC_BREADCRUMB;
-  private resizeObserver;
-  private SHOW_BACK_ICON;
-  el: HTMLIcBreadcrumbGroupElement;
-  deviceSize: number;
-  expandedBreadcrumbs: boolean;
-  /**
-   * If `true`, display only a single breadcrumb for the parent page with a back icon.
-   */
-  backBreadcrumbOnly: boolean;
-  /**
-   * If `true`, all breadcrumbs between the first and last breadcrumb will be collapsed.
-   */
-  collapsed: boolean;
-  componentWillLoad(): void;
-  disconnectedCallback(): void;
-  private setBackBreadcrumb;
-  private setBackBreadcrumbAttr;
-  private getLastParentBreadcrumb;
-  private lastParentBreadcrumb;
-  private setDefaultBreadcrumbs;
-  private setCollapsed;
-  private clickHandler;
-  private renderCollapsedBreadcrumb;
-  private handleHiddenCollapsedBreadcrumbs;
-  private transitionendHandler;
-  private removeVisuallyHiddenClass;
-  private setLastParentCollapsedBackBreadcrumb;
-  private revertLastParentCollapsedBreadcrumb;
-  private resizeObserverCallback;
-  private runResizeObserver;
-  render(): any;
+    private ADD_CLASS_DELAY;
+    private breadcrumb;
+    private breadcrumbs;
+    private collapsedBreadcrumbEl;
+    private collapsedBreadcrumbs;
+    private collapsedBreadcrumbWrapper;
+    private IC_BREADCRUMB;
+    private resizeObserver;
+    private SHOW_BACK_ICON;
+    el: HTMLIcBreadcrumbGroupElement;
+    deviceSize: number;
+    expandedBreadcrumbs: boolean;
+    /**
+     * The appearance of the breadcrumb group.
+     */
+    appearance: IcThemeForeground;
+    /**
+     * If `true`, display only a single breadcrumb for the parent page with a back icon.
+     */
+    backBreadcrumbOnly: boolean;
+    /**
+     * If `true`, all breadcrumbs between the first and last breadcrumb will be collapsed.
+     */
+    collapsed: boolean;
+    componentWillLoad(): void;
+    disconnectedCallback(): void;
+    private setBackBreadcrumb;
+    private setBackBreadcrumbAttr;
+    private getLastParentBreadcrumb;
+    private lastParentBreadcrumb;
+    private setDefaultBreadcrumbs;
+    private setCollapsed;
+    private clickHandler;
+    private renderCollapsedBreadcrumb;
+    private handleHiddenCollapsedBreadcrumbs;
+    private transitionendHandler;
+    private removeVisuallyHiddenClass;
+    private setLastParentCollapsedBackBreadcrumb;
+    private revertLastParentCollapsedBreadcrumb;
+    private resizeObserverCallback;
+    private runResizeObserver;
+    render(): any;
 }

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

@@ -8,141 +8,154 @@ import { IcSizes, IcThemeForeground } from "../../utils/types";
  * @slot badge - Badge component overlaying the top right of the button.
  */
 export declare class Button {
-  private buttonEl;
-  private buttonIdNum;
-  private hasTooltip;
-  private id;
-  private inheritedAttributes;
-  private describedByEl;
-  private describedById;
-  private mutationObserver;
-  private hostMutationObserver;
-  el: HTMLIcButtonElement;
-  ariaLabel: string;
-  describedByContent: string;
-  title: string;
-  /**
-   * The appearance of the button, e.g. dark, light, or the default.
-   */
-  appearance?: IcThemeForeground;
-  /**
-   * @internal Used to identify any related child component
-   */
-  ariaControlsId: string | boolean;
-  /**
-   * @internal Used to identify any related child component
-   */
-  ariaOwnsId: string | boolean;
-  /**
-   * If `true`, the button will be in disabled state.
-   */
-  disabled?: boolean;
-  /**
-   * If `true`, the ic-tooltip which is shown for icon variant will be disabled. Title or aria-label must be set if this prop is not applied.
-   */
-  disableTooltip?: boolean;
-  /**
-   * If `true`, the user can save the linked URL instead of navigating to it.
-   */
-  download?: string | boolean;
-  /**
-   * The <form> element to associate the button with.
-   */
-  form?: string;
-  /**
-   * The URL that processes the information submitted by the button. It overrides the action attribute of the button's form owner. Does nothing if there is no form owner.
-   */
-  formaction?: string;
-  /**
-   * The way the submitted form data is encoded.
-   */
-  formenctype?: string;
-  /**
-   * The HTTP method used to submit the form.
-   */
-  formmethod?: string;
-  /**
-   * If `true`, the form will not be validated when submitted.
-   */
-  formnovalidate?: boolean;
-  /**
-   * The place to display the response from submitting the form. It overrides the target attribute of the button's form owner.
-   */
-  formtarget?: string;
-  /**
-   * If `true`, the button will fill the width of the container.
-   */
-  fullWidth?: boolean;
-  /**
-   * The URL that the link points to. This will render the button as an "a" tag.
-   */
-  href?: string;
-  /**
-   * The human language of the linked URL.
-   */
-  hreflang?: string;
-  /**
-   * If `true`, the button will be in loading state.
-   */
-  loading?: boolean;
-  /**
-   * How much of the referrer to send when following the link.
-   */
-  referrerpolicy?: ReferrerPolicy;
-  /**
-   * The relationship of the linked URL as space-separated link types.
-   */
-  rel?: string;
-  /**
-   * The size of the button to be displayed.
-   */
-  size?: IcSizes;
-  /**
-   * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
-   */
-  target?: string;
-  /**
-   * The position of the tooltip in relation to the button.
-   */
-  tooltipPlacement?: IcButtonTooltipPlacement;
-  /**
-   * The type of the button.
-   */
-  type?: IcButtonTypes;
-  /**
-   * The variant of the button to be displayed.
-   */
-  variant?: IcButtonVariants;
-  /**
-   * Emitted when button has blur
-   */
-  icBlur: EventEmitter<void>;
-  /**
-   * Emitted when button has focus
-   */
-  icFocus: EventEmitter<void>;
-  disconnectedCallback(): void;
-  componentWillUpdate(): void;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  handleHostClick(event: Event): void;
-  themeChangeHandler(ev: CustomEvent): void;
-  /**
-   * Sets focus on the native `button`.
-   */
-  setFocus(): Promise<void>;
-  private hasIconSlot;
-  private hasLeftIconSlot;
-  private hasRightIconSlot;
-  private setViewBox;
-  private handleHiddenFormButtonClick;
-  private handleClick;
-  private onFocus;
-  private onBlur;
-  private updateTheme;
-  private loadingWidth;
-  private mutationCallback;
-  private hostMutationCallback;
-  render(): any;
+    private buttonEl;
+    private buttonIdNum;
+    private hasTooltip;
+    private id;
+    private inheritedAttributes;
+    private describedByEl;
+    private describedById;
+    private mutationObserver;
+    private hostMutationObserver;
+    el: HTMLIcButtonElement;
+    ariaLabel: string;
+    describedByContent: string;
+    title: string;
+    /**
+     * The appearance of the button, e.g. dark, light, or the default.
+     */
+    appearance?: IcThemeForeground;
+    /**
+     * @internal Used to identify any related child component
+     */
+    ariaControlsId: string | boolean;
+    /**
+     * @internal Used to identify any related child component
+     */
+    ariaOwnsId: string | boolean;
+    /**
+     * If `true`, the button will be in disabled state.
+     */
+    disabled?: boolean;
+    /**
+     * If `true`, the ic-tooltip which is shown for icon variant will be disabled. Title or aria-label must be set if this prop is not applied.
+     */
+    disableTooltip?: boolean;
+    /**
+     * If `true`, the user can save the linked URL instead of navigating to it.
+     */
+    download?: string | boolean;
+    /**
+     * If `true`, the button will show a dropdown icon.
+     */
+    dropdown?: boolean;
+    /**
+     * If `true`, the aria-expanded value will be set to true. This is only applied if the dropdown prop is also true.
+     */
+    dropdownExpanded?: boolean;
+    /**
+     * The <form> element to associate the button with.
+     */
+    form?: string;
+    /**
+     * The URL that processes the information submitted by the button. It overrides the action attribute of the button's form owner. Does nothing if there is no form owner.
+     */
+    formaction?: string;
+    /**
+     * The way the submitted form data is encoded.
+     */
+    formenctype?: string;
+    /**
+     * The HTTP method used to submit the form.
+     */
+    formmethod?: string;
+    /**
+     * If `true`, the form will not be validated when submitted.
+     */
+    formnovalidate?: boolean;
+    /**
+     * The place to display the response from submitting the form. It overrides the target attribute of the button's form owner.
+     */
+    formtarget?: string;
+    /**
+     * If `true`, the button will fill the width of the container.
+     */
+    fullWidth?: boolean;
+    /**
+     * The URL that the link points to. This will render the button as an "a" tag.
+     */
+    href?: string;
+    /**
+     * The human language of the linked URL.
+     */
+    hreflang?: string;
+    /**
+     * If `true`, the button will be in loading state.
+     */
+    loading?: boolean;
+    /**
+     * How much of the referrer to send when following the link.
+     */
+    referrerpolicy?: ReferrerPolicy;
+    /**
+     * The relationship of the linked URL as space-separated link types.
+     */
+    rel?: string;
+    /**
+     * The size of the button to be displayed.
+     */
+    size?: IcSizes;
+    /**
+     * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
+     */
+    target?: string;
+    /**
+     * The position of the tooltip in relation to the button.
+     */
+    tooltipPlacement?: IcButtonTooltipPlacement;
+    /**
+     * If `true`, the secondary variant of button will have a transparent background rather than white.
+     */
+    transparentBackground?: boolean;
+    /**
+     * The type of the button.
+     */
+    type?: IcButtonTypes;
+    /**
+     * The variant of the button to be displayed.
+     */
+    variant?: IcButtonVariants;
+    /**
+     * Emitted when button has blur
+     */
+    icBlur: EventEmitter<void>;
+    /**
+     * Emitted when button has focus
+     */
+    icFocus: EventEmitter<void>;
+    disconnectedCallback(): void;
+    componentWillUpdate(): void;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentWillRender(): void;
+    handleHostClick(event: Event): void;
+    themeChangeHandler(ev: CustomEvent): void;
+    /**
+     * Sets focus on the native `button`.
+     */
+    setFocus(): Promise<void>;
+    private hasIconSlot;
+    private hasLeftIconSlot;
+    private hasRightIconSlot;
+    private setViewBox;
+    private handleHiddenFormButtonClick;
+    private handleClick;
+    private onFocus;
+    private onBlur;
+    private updateTheme;
+    private loadingWidth;
+    private mutationCallback;
+    private hostMutationCallback;
+    private setHasTooltip;
+    render(): any;
 }