@ukic/web-components 2.1.0-beta.9 → 2.3.0

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

@@ -0,0 +1,123 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+export declare class Dialog {
+  private DATA_OVERFLOW;
+  private DATA_GETS_FOCUS;
+  private DATA_GETS_FOCUS_SELECTOR;
+  private DIALOG_CONTROLS;
+  private dialogEl;
+  private dialogHeight;
+  private focusedElementIndex;
+  private IC_TEXT_FIELD;
+  private interactiveElementList;
+  private resizeObserver;
+  private resizeTimeout;
+  private sourceElement;
+  private buttonOnclick0;
+  private buttonOnclick1;
+  private buttonOnclick2;
+  el: HTMLIcDialogElement;
+  dialogRendered: boolean;
+  fadeIn: boolean;
+  /**
+   * @slot dialog-controls - Content will be place at the bottom of the dialog.
+   * @slot heading - Content will be placed at the top of the dialog.
+   * @slot label - Content will be placed above the dialog heading.
+   */
+  /**
+   * If a status is set, sets the heading for the displayed alert.
+   */
+  alertHeading?: string;
+  /**
+   * If a status is set, sets the message for the displayed alert.
+   */
+  alertMessage?: string;
+  /**
+   * If set to `false`, dialog controls will not be displayed overriding buttonProps or slotted dialog controls.
+   */
+  buttons?: boolean;
+  /**
+   * If set to `true`, the dialog will not close when the backdrop is clicked.
+   */
+  closeOnBackdropClick?: boolean;
+  /**
+   * If default buttons are displayed, sets the 'primary' or rightmost button to the destructive variant. Stops initial focus being set on the 'primary' or rightmost default or slotted button.
+   */
+  destructive?: boolean;
+  /**
+   * Sets the dismiss label tooltip and aria label.
+   */
+  dismissLabel?: string;
+  /**
+   * Sets the heading for the dialog.
+   */
+  heading: string;
+  /**
+   * Sets the optional label for the dialog which appears above the heading.
+   */
+  label?: string;
+  /**
+   * Sets the maximum and minimum height and width for the dialog.
+   */
+  size?: "small" | "medium" | "large";
+  /**
+   * If set, displays an alert of the corresponding variant below the heading.
+   */
+  status?: "neutral" | "info" | "warning" | "error" | "success";
+  /**
+   * Sets the label and onclick functions for default buttons.
+   */
+  buttonProps?: {
+    label: string;
+    onclick: string;
+  }[];
+  watchPropHandler(): void;
+  /**
+   * Cancelation event emitted when default 'Cancel' button clicked or 'cancelDialog' method is called.
+   */
+  icDialogCancelled: EventEmitter<void>;
+  /**
+   * Emitted when dialog has closed.
+   */
+  icDialogClosed: EventEmitter<void>;
+  /**
+   * Confirmation event emitted when default 'Confirm' primary button clicked or 'confirmDialog' method is called.
+   */
+  icDialogConfirmed: EventEmitter<void>;
+  /**
+   * Emitted when dialog has opened.
+   */
+  icDialogOpened: EventEmitter<void>;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  handleKeyboard(ev: KeyboardEvent): void;
+  handleClick(ev: MouseEvent): void;
+  /**
+   * Use to show the dialog.
+   */
+  showDialog(): Promise<void>;
+  /**
+   * Use to hide the dialog.
+   */
+  hideDialog(): Promise<void>;
+  /**
+   * Cancels the dialog. Used by the default 'Cancel' button or can be called manually to trigger cancelling of dialog.
+   */
+  cancelDialog(): Promise<void>;
+  /**
+   * Confirms the dialog. Used by the default 'Confirm' button or can be called manually to trigger confirming of dialog.
+   */
+  confirmDialog(): Promise<void>;
+  private setContentOverflow;
+  private runResizeObserver;
+  private resizeObserverCallback;
+  private setInitialFocus;
+  private getFocusedElementIndex;
+  private setAlertVariant;
+  private closeIconClick;
+  private getInteractiveElements;
+  private focusNextInteractiveElement;
+  private setButtonOnClick;
+  private getButtonOnclick;
+  private getButtonVariant;
+  render(): any;
+}

package/dist/types/components/ic-empty-state/ic-empty-state.d.ts

@@ -0,0 +1,35 @@
+import { IcEmptyStateAlignment } from "./ic-empty-state.types";
+import { IcSizes } from "../../utils/types";
+/**
+ * @slot image - Content is placed at the top above all other content.
+ * @slot actions - Content is placed at the bottom below all other content.
+ */
+export declare class EmptyState {
+  el: HTMLIcEmptyStateElement;
+  /**
+   * The alignment of the empty state container.
+   */
+  aligned?: IcEmptyStateAlignment;
+  /**
+   * The body text rendered in the empty state container.
+   */
+  body?: string;
+  /**
+   * The number of lines of body text to display before truncating.
+   */
+  bodyMaxLines?: number;
+  /**
+   * The title rendered in the empty state container.
+   */
+  heading: string;
+  /**
+   * The size of the image or icon used in the image slot.
+   */
+  imageSize?: IcSizes;
+  /**
+   * The subtitle rendered in the empty state container.
+   */
+  subheading?: string;
+  componentDidLoad(): void;
+  render(): any;
+}

package/dist/types/components/ic-empty-state/ic-empty-state.types.d.ts

@@ -0,0 +1 @@
+export type IcEmptyStateAlignment = "left" | "center" | "right";

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

@@ -8,15 +8,11 @@ import { IcFooterBreakpoints } from "./ic-footer.types";
  * @slot caption - Content will be rendered above Crown Copyright.
  */
 export declare class Footer {
+  private footerEl;
+  private resizeObserver;
   el: HTMLIcFooterElement;
-  /**
-   *  @internal Triggers on page resize and triggers style changes in footer links and link groups
-   */
-  footerResized: EventEmitter<void>;
-  /**
-   * The description displayed at the top of the footer.
-   */
-  description: string;
+  deviceSize: number;
+  foregroundColor: IcThemeForeground;
   /**
    * The alignment of the section containers used within the footer.
    */
@@ -25,10 +21,6 @@ export declare class Footer {
    * The screen size breakpoint at which to switch to the small layout.
    */
   breakpoint?: IcFooterBreakpoints;
-  /**
-   * If `true`, the footer will be set up to handle link groups instead of standalone links.
-   */
-  groupLinks?: boolean;
   /**
    * The caption displayed at the bottom of the footer.
    */
@@ -37,16 +29,24 @@ export declare class Footer {
    * If `true`, the footer will display the crown copyright at the bottom.
    */
   copyright: boolean;
-  deviceSize: number;
-  foregroundColor: IcThemeForeground;
-  private isSmall;
+  /**
+   * The description displayed at the top of the footer.
+   */
+  description: string;
+  /**
+   * If `true`, the footer will be set up to handle link groups instead of standalone links.
+   */
+  groupLinks?: boolean;
+  /**
+   *  @internal Triggers on page resize and triggers style changes in footer links and link groups
+   */
+  footerResized: EventEmitter<void>;
+  disconnectedCallback(): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
   themeChangeHandler(ev: CustomEvent): void;
-  private resizeObserver;
-  private footerEl;
+  private isSmall;
   private resizeObserverCallback;
   private runResizeObserver;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  disconnectedCallback(): void;
   render(): any;
 }

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

@@ -1 +1 @@
-export declare type IcFooterBreakpoints = "extra small" | "small" | "medium" | "large" | "extra large";
+export type IcFooterBreakpoints = "extra small" | "small" | "medium" | "large" | "extra large";

package/dist/types/components/ic-footer-link/ic-footer-link.d.ts

@@ -1,21 +1,41 @@
 import { IcThemeForeground } from "../../utils/types";
-declare type FooterConfig = {
+type FooterConfig = {
   small: boolean;
   grouped: boolean;
 };
 export declare class FooterLink {
   el: HTMLIcFooterLinkElement;
+  deviceSize: number;
+  footerConfig: FooterConfig;
+  foregroundColor: IcThemeForeground;
+  /**
+   * If `true`, the user can save the linked URL instead of navigating to it.
+   */
+  download?: string | boolean;
   /**
    * The URL that the link points to.
    */
   href?: string;
-  footerConfig: FooterConfig;
-  deviceSize: number;
-  foregroundColor: IcThemeForeground;
-  private inferConfig;
+  /**
+   * The human language of the linked URL.
+   */
+  hreflang?: string;
+  /**
+   * 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 place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
+   */
+  target?: string;
+  componentWillLoad(): void;
   footerResizeHandler(): void;
   footerThemeChangeHandler(ev: CustomEvent): void;
-  componentWillLoad(): void;
+  private inferConfig;
   render(): any;
 }
 export {};

package/dist/types/components/ic-footer-link-group/ic-footer-link-group.d.ts

@@ -1,19 +1,19 @@
 export declare class FooterLinkGroup {
   el: HTMLIcFooterLinkGroupElement;
+  expanded: boolean;
+  deviceSize: number;
+  dropdownIconStyle: import("../../utils/types").IcThemeForeground;
+  small: boolean;
   /**
    * The title of the link group to be displayed.
    */
   groupTitle: string;
-  small: boolean;
-  expanded: boolean;
-  dropdownIconStyle: import("../../utils/types").IcThemeForeground;
-  deviceSize: number;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  footerResizeHandler(): void;
+  footerThemeChangeHandler(ev: CustomEvent): void;
   private isSmall;
   private handleKeydown;
   private toggleExpanded;
-  footerResizeHandler(): void;
-  footerThemeChangeHandler(ev: CustomEvent): void;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
   render(): any;
 }

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

@@ -8,50 +8,50 @@ import { IcHeroContentAlignments } from "./ic-hero.types";
  */
 export declare class Hero {
   el: HTMLIcHeroElement;
+  foregroundColor: IcThemeForeground;
+  rightContent: boolean;
+  leftContentFullWidth: boolean;
+  scrollFactor: string;
   /**
-   * The heading of the hero.
-   */
-  heading: string;
-  /**
-   * The description for the hero.
-   */
-  subheading?: string;
-  /**
-   * The optional secondary heading, replaced by slotted right content.
-   */
-  secondaryHeading?: string;
-  /**
-   * The optional secondary subheading, replaced by slotted right content.
+   * The alignment of the hero.
    */
-  secondarySubheading?: string;
+  aligned: IcAlignment;
   /**
    * The optional background image.
    */
   backgroundImage?: string;
+  /**
+   * The alignment of the hero content.
+   */
+  contentAligned: IcHeroContentAlignments;
   /**
    * If `true`, the background image (if set) will not scroll using a parallax effect.
    */
   disableBackgroundParallax?: boolean;
   /**
-   * The alignment of the hero.
+   * The heading of the hero.
    */
-  aligned: IcAlignment;
+  heading: string;
   /**
-   * The alignment of the hero content.
+   * The optional secondary heading, replaced by slotted right content.
    */
-  contentAligned: IcHeroContentAlignments;
+  secondaryHeading?: string;
+  /**
+   * The optional secondary subheading, replaced by slotted right content.
+   */
+  secondarySubheading?: string;
   /**
    * If `true`, the small styling will be applied to the hero.
    */
   small: boolean;
-  rightContent: boolean;
-  scrollFactor: string;
-  leftContentFullWidth: boolean;
-  foregroundColor: IcThemeForeground;
-  themeChangeHandler(ev: CustomEvent): void;
-  doScroll(): void;
+  /**
+   * The description for the hero.
+   */
+  subheading?: string;
   componentWillLoad(): void;
   componentDidLoad(): void;
   componentWillRender(): void;
+  themeChangeHandler(ev: CustomEvent): void;
+  doScroll(): void;
   render(): any;
 }

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

@@ -1 +1 @@
-export declare type IcHeroContentAlignments = "left" | "center";
+export type IcHeroContentAlignments = "left" | "center";

package/dist/types/components/ic-horizontal-scroll/ic-horizontal-scroll.d.ts

@@ -1,25 +1,29 @@
 import { IcThemeForeground } from "../../utils/types";
 export declare class HorizontalScroll {
+  private buttonStateSet;
+  private isScrolling;
+  private itemOffsets;
+  private items;
+  private itemsContainerEl;
+  private resizeObserver;
+  private scrollDelay;
   el: HTMLIcHorizontalScrollElement;
+  firstItemVisible: boolean;
+  itemOverflow: boolean;
+  lastItemVisible: boolean;
   /**
    * The appearance of the horizontal scroll, e.g. dark, light or the default.
    */
   appearance?: IcThemeForeground;
-  firstItemVisible: boolean;
-  lastItemVisible: boolean;
-  itemOverflow: boolean;
-  private itemOffsets;
-  private itemsContainerEl;
-  private items;
-  private resizeObserver;
-  private isScrolling;
-  private scrollDelay;
-  private buttonStateSet;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  disconnectedCallback(): void;
   /**
    * @internal if side scrolling enabled, scrolls the specified item into view.
    */
   scrollItemIntoView(itemPosition: number): Promise<void>;
-  itemFocusHandler(itemPosition: number): void;
+  private focusHandler;
+  private itemFocusHandler;
   private resizeObserverCallback;
   private runResizeObserver;
   private scrollLeft;
@@ -32,8 +36,5 @@ export declare class HorizontalScroll {
   private getCurrentLeftItem;
   private scrollHandler;
   private scrollStopped;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  disconnectedCallback(): void;
   render(): any;
 }

package/dist/types/components/ic-input-component-container/ic-input-component-container.d.ts

@@ -3,38 +3,38 @@ import { IcInformationStatusOrEmpty } from "../../utils/types";
  * @slot left-icon - Content will be placed to the left of the input.
  */
 export declare class InputComponentContainer {
+  host: HTMLIcInputComponentContainerElement;
+  /**
+   *  If `true`, the dark variant of the input component container will be displayed.
+   */
+  dark?: boolean;
   /**
    *  If `true`, the disabled state will be set.
    */
   disabled: boolean;
   /**
-   *  If `true`, the readonly state will be set.
+   *  If `true`, the input component container will fill the width of the container it is in.
    */
-  readonly: boolean;
+  fullWidth: boolean;
   /**
-   * The validation status of the input component container - e.g. 'error' | 'warning' | 'success'.
+   *  If `true`, the input component container will allow for multiple lines.
    */
-  validationStatus: IcInformationStatusOrEmpty;
+  multiLine: boolean;
   /**
-   *  If `true`, the small styling will be applied to the input component container.
+   *  If `true`, the readonly state will be set.
    */
-  small: boolean;
+  readonly: boolean;
   /**
-   *  If `true`, the input component container will allow for multiple lines.
+   *  If `true`, the small styling will be applied to the input component container.
    */
-  multiLine: boolean;
+  small: boolean;
   /**
    *  If `true`, the validation will display inline.
    */
   validationInline: boolean;
   /**
-   *  If `true`, the dark variant of the input component container will be displayed.
-   */
-  dark?: boolean;
-  /**
-   *  If `true`, the input component container will fill the width of the container it is in.
+   * The validation status of the input component container - e.g. 'error' | 'warning' | 'success'.
    */
-  fullWidth: boolean;
-  host: HTMLIcInputComponentContainerElement;
+  validationStatus: IcInformationStatusOrEmpty;
   render(): any;
 }

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

@@ -1,12 +1,20 @@
 export declare class InputLabel {
   /**
-   * The ID of the form element the label is bound to.
+   * If `true`, the dark variant of the input label will be displayed.
    */
-  for: string;
+  dark?: boolean;
   /**
-   * If `true`, the input label will require a value.
+   * If `true`, the disabled state will be set.
    */
-  required: boolean;
+  disabled: boolean;
+  /**
+   * If `true`, the input label will display with error styling.
+   */
+  error?: boolean;
+  /**
+   * The ID of the form element the label is bound to.
+   */
+  for: string;
   /**
    * The helper text that will be displayed.
    */
@@ -15,22 +23,14 @@ export declare class InputLabel {
    * The text content of the label.
    */
   label: string;
-  /**
-   * If `true`, the disabled state will be set.
-   */
-  disabled: boolean;
   /**
    * If `true`, the readonly state will be set.
    */
   readonly: boolean;
   /**
-   * If `true`, the input label will display with error styling.
-   */
-  error?: boolean;
-  /**
-   * If `true`, the dark variant of the input label will be displayed.
+   * If `true`, the input label will require a value.
    */
-  dark?: boolean;
+  required: boolean;
   componentDidLoad(): void;
   render(): any;
 }

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

@@ -6,25 +6,25 @@ import { IcAriaLiveModeVariants } from "./ic-input-validation.types";
 export declare class InputValidation {
   el: HTMLIcInputValidationElement;
   /**
-   * The validation message to display.
+   *  The ARIA live mode to apply to the message.
    */
-  message: string;
+  ariaLiveMode: IcAriaLiveModeVariants;
   /**
    * The ID of the form element the validation is bound to.
    */
   for: string;
-  /**
-   * The status of the validation - e.g. 'error' | 'warning' | 'success'.
-   */
-  status: IcInformationStatusOrEmpty;
   /**
    *  If `true`, the input validation will fill the width of the container.
    */
   fullWidth: boolean;
   /**
-   *  The ARIA live mode to apply to the message.
+   * The validation message to display.
    */
-  ariaLiveMode: IcAriaLiveModeVariants;
+  message: string;
+  /**
+   * The status of the validation - e.g. 'error' | 'warning' | 'success'.
+   */
+  status: IcInformationStatusOrEmpty;
   componentDidLoad(): void;
   render(): any;
 }

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

@@ -1 +1 @@
-export declare type IcAriaLiveModeVariants = "polite" | "assertive";
+export type IcAriaLiveModeVariants = "polite" | "assertive";

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

@@ -6,6 +6,10 @@ export declare class Link {
   private inheritedAttributes;
   private routerSlot;
   el: HTMLIcLinkElement;
+  /**
+   * The appearance of the link, e.g. dark, light, or default.
+   */
+  appearance?: IcThemeForeground;
   /**
    * If `true`, the user can save the linked URL instead of navigating to it.
    */
@@ -27,24 +31,20 @@ export declare class Link {
    */
   rel?: string;
   /**
-   * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
-   */
-  target?: string;
-  /**
-   * If `true`, the 'open in new tab/window' icon will be displayed.
+   * @deprecated This prop should not be used anymore. The 'open in new tab/window' icon will display automatically if target="_blank".
    */
   showIcon?: boolean;
   /**
-   * The appearance of the link, e.g. dark, light, or default.
+   * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
    */
-  appearance?: IcThemeForeground;
+  target?: string;
+  componentWillLoad(): void;
   themeChangeHandler(ev: CustomEvent): void;
-  private updateTheme;
   /**
    * Sets focus on the link.
    */
   setFocus(): Promise<void>;
-  componentWillLoad(): void;
+  private updateTheme;
   private hasRouterSlot;
   render(): any;
 }