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

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

@@ -0,0 +1,66 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { IcActivationTypes, IcStatusVariants } from "../../utils/types";
+import { ActionAreaElementTypes } from "./ic-toast.types";
+/**
+ * @slot action - IcButton or IcLink is placed below header and message. If used will default toast to manual `dismiss` type.
+ * @slot neutral-icon - A custom neutral icon is placed on the left side of the component. If used will default toast to `neutral` variant.
+ */
+export declare class Toast {
+  el: HTMLIcToastElement;
+  /**
+   * The title to display at the start of the toast. (NOTE: Should be no more than `70` characters)
+   */
+  heading: string;
+  /**
+   * The variant of the toast being rendered
+   */
+  variant?: IcStatusVariants;
+  /**
+   * The main body message of the toast. (NOTE: Should be no more than `140` characters)
+   */
+  message?: string;
+  /**
+   * How the toast will be dismissed. If manual will display a dismiss button.
+   */
+  dismissMode?: IcActivationTypes;
+  /**
+   * If toast dismissMode is set to `automatic`, use this prop to define the time before the toast dismisses (in MILLISECONDS)
+   * (NOTE: Has a minimum value of `5000ms`)
+   */
+  autoDismissTimeout?: number;
+  /**
+   * Provides a custom alt-text to be announced to screen readers, if slotting a custom neutral icon
+   */
+  neutralIconAriaLabel?: string;
+  /**
+   * If toast can be manually dismissed, this prop sets a custom aria-label for the ic-button component
+   */
+  dismissButtonAriaLabel?: string;
+  /**
+   * Is emitted when the user dismisses the toast
+   */
+  icDismiss: EventEmitter<void>;
+  visible: boolean;
+  timerProgress: number;
+  dismissTimeout: number;
+  timerRefreshInterval: number;
+  isManual: boolean;
+  interactiveElements: ActionAreaElementTypes[];
+  neutralVariantLabel: string;
+  /**
+   * Used to display the individual toast
+   * @returns The element that previously had focus before the toast appeared
+   */
+  setVisible(): Promise<HTMLElement>;
+  handleDismiss(): void;
+  handleKeyboard(ev: KeyboardEvent): void;
+  handleTimer(ev: MouseEvent): void;
+  private dismissAction;
+  private handleProgressChange;
+  private handleLongText;
+  private findNextInteractiveElement;
+  private isActive;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  render(): any;
+}

package/dist/types/components/ic-toast/ic-toast.test.a11y.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export declare type ActionAreaElementTypes = HTMLIcButtonElement | HTMLIcLinkElement;

package/dist/types/components/ic-toast-region/ic-toast-region.d.ts

@@ -0,0 +1,12 @@
+export declare class ToastRegion {
+  el: HTMLIcToastRegionElement;
+  previouslyFocused: HTMLElement;
+  pendingVisibility: HTMLIcToastElement[];
+  /**
+   * Handles setting the visibility of various toasts based on what is already visible
+   * @param toast The toast element being requested to display
+   */
+  setVisible(toast: HTMLIcToastElement): Promise<void>;
+  handleDismissedToast(): void;
+  render(): any;
+}

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

@@ -13,6 +13,10 @@ export declare class Tooltip {
    * The text to display on the tooltip.
    */
   label: string;
+  /**
+   * If `true`, the tooltip will not be displayed on hover, it will require a click.
+   */
+  disableHover?: boolean;
   updateLabel(newValue: string): void;
   private toolTip;
   private arrow;

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

@@ -2,6 +2,7 @@ import { EventEmitter } from "../../stencil-public-runtime";
 import { IcAlignment, IcThemeForeground } from "../../utils/types";
 /**
  * @slot app-icon - Content will be rendered to left of app title.
+ * @slot app-title - Handle routing by nesting a route in the app title.
  * @slot search - Content will be rendered in search area to left of buttons.
  * @slot toggle-icon - Icon to be displayed on the button to toggle search slot content on smaller devices
  * @slot navigation - Content will be rendered in navigation panel.
@@ -10,27 +11,27 @@ import { IcAlignment, IcThemeForeground } from "../../utils/types";
 export declare class TopNavigation {
   el: HTMLIcTopNavigationElement;
   /**
-   *  Title to display
+   * The app title to be displayed. This is required, unless a slotted app title link is used.
    */
   appTitle: string;
   /**
-   *  The url to navigate to when title is clicked
+   *  The URL to navigate to when the app title is clicked.
    */
   href: string;
   /**
-   *  Version info to display
+   * The version info to be displayed.
    */
   version: string;
   /**
-   *  Status info to display
+   * The status info to be displayed.
    */
   status: string;
   /**
-   * The alignment of the top nav content
+   * The alignment of the top navigation content.
    */
   contentAligned: IcAlignment;
   /**
-   * If true, the flyout navigation menu on small devices will be contained by the parent element
+   * If `true`, the flyout navigation menu on small devices will be contained by the parent element.
    */
   inline: boolean;
   menuOpen: boolean;

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

@@ -6,7 +6,7 @@ export declare class Typography {
    */
   variant?: IcTypographyVariants;
   /**
-   * Adds appropriate margins to the top and bottom of the typography.
+   * If `true`, appropriate top and bottom margins will be applied to the typography.
    */
   applyVerticalMargins?: boolean;
   render(): any;