@ukic/canary-web-components 2.0.0-canary.0

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

@@ -0,0 +1,59 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { IcTabClickEventDetail } from "./ic-tab.types";
+import { IcThemeForegroundNoDefault } from "../../utils/types";
+/**
+ * @slot icon - Content will be rendered next to the tab label.
+ */
+export declare class Tab {
+  private focusFromClick;
+  private focusTabId;
+  private isInitialRender;
+  host: HTMLIcTabElement;
+  /** @internal Determines whether the light or dark variant of the tabs should be displayed. */
+  appearance?: IcThemeForegroundNoDefault;
+  /** @internal The unique context needed if using multiple tabs inside one another i.e. rendering another tabs inside a tab panel. */
+  contextId?: string;
+  /**
+   * If `true`, the disabled state will be set.
+   */
+  disabled?: boolean;
+  /** @internal If `true`, the tab will display with a selected indicator and tabIndex will be set. */
+  selected?: boolean;
+  /** @internal The shared ID between panel and tab. */
+  tabId?: string;
+  /** @internal The position of the tab inside the tabs array in context. */
+  tabPosition?: number;
+  disabledWatchHandler(): void;
+  /**
+   * @internal Emitted when a tab is selected.
+   */
+  tabClick: EventEmitter<IcTabClickEventDetail>;
+  /**
+   * @internal Emitted when a tab is dynamically created.
+   */
+  tabCreated: EventEmitter<HTMLIcTabElement>;
+  /**
+   * @internal Emitted when a tab's disabled prop changes
+   */
+  tabEnabled: EventEmitter<void>;
+  /**
+   * @internal Emitted when a tab is focussed.
+   */
+  tabFocus: EventEmitter<IcTabClickEventDetail>;
+  /**
+   * @internal Emitted when a tab is unmounted.
+   */
+  tabRemoved: EventEmitter<void>;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  componentWillLoad(): void;
+  componentDidUpdate(): void;
+  /**
+   * Sets focus on the tab.
+   */
+  setFocus(): Promise<void>;
+  private handleClick;
+  private handleFocus;
+  private handleMouseDown;
+  render(): any;
+}

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

@@ -0,0 +1,8 @@
+export interface IcTabClickEventDetail {
+  tabId: string;
+  contextId: string;
+  position: number;
+}
+export interface IcTabSelectEventDetail {
+  tabIndex: number;
+}

package/dist/types/components/ic-tab-context/ic-tab-context.d.ts

@@ -0,0 +1,64 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { IcActivationTypes, IcThemeForegroundNoDefault } from "../../utils/types";
+import { IcTabClickEventDetail, IcTabSelectEventDetail } from "../ic-tab/ic-tab.types";
+export declare class TabContext {
+  private controlledMode;
+  private enabledTabs;
+  private focusedTabIndex;
+  private newTabPanels;
+  private newTabs;
+  private tabs;
+  private tabGroup;
+  private tabPanels;
+  host: HTMLIcTabContextElement;
+  selectedTab: number | null;
+  /**
+   * Determines whether tabs have to be manually activated (by pressing 'Enter' or 'Space') when they receive focus using keyboard navigation.
+   */
+  activationType?: IcActivationTypes;
+  /**
+   * The appearance of the tab context, e.g dark, or light.
+   */
+  appearance?: IcThemeForegroundNoDefault;
+  /**
+   * The unique context needed if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.
+   */
+  contextId?: string;
+  /**
+   * The selected tab to be controlled by the user. Must be used alongside the icTabSelect event to manage tab selection.
+   */
+  selectedTabIndex?: number;
+  updateSelectedTab(newValue: number): void;
+  /**
+   * Emitted when a user selects a tab.
+   */
+  icTabSelect: EventEmitter<IcTabSelectEventDetail>;
+  /**
+   * @deprecated This event should not be used anymore. Use icTabSelect instead.
+   */
+  tabSelect: EventEmitter<IcTabSelectEventDetail>;
+  componentDidLoad(): void;
+  componentWillUpdate(): void;
+  disconnectedCallback(): void;
+  tabClickHandler(event: CustomEvent<IcTabClickEventDetail>): void;
+  tabCreatedHandler(ev: CustomEvent): void;
+  tabEnabledHandler(): void;
+  /**
+   * @internal Used to set tab/tab panel IDs when a tab/tab panel has been removed
+   */
+  tabRemovedHandler(hadFocus?: boolean): Promise<void>;
+  private linkTabs;
+  private getChildren;
+  private keydownHandler;
+  private attatchEventListeners;
+  private setControlledMode;
+  private setInitialTab;
+  private configureTabs;
+  private getEnabledTabs;
+  private getIndexOfEnabledTab;
+  private keyboardSelectTab;
+  private keyboardFocusTab;
+  private handleKeyBoardNavAutomatic;
+  private handleKeyBoardNavManual;
+  render(): any;
+}

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

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

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

@@ -0,0 +1,23 @@
+import { IcThemeForegroundNoDefault } from "../../utils/types";
+export declare class TabGroup {
+  host: HTMLIcTabGroupElement;
+  /**
+   * @internal The appearance of the tab group, e.g dark, or light.
+   */
+  appearance?: IcThemeForegroundNoDefault;
+  /**
+   * @deprecated This is no longer required.
+   * The context id is passed down from `ic-tab-context`
+   */
+  contextId?: string;
+  /**
+   * If `true`, the tabs and tab panels will be positioned separately.
+   */
+  inline?: boolean;
+  /**
+   * The label to describe the purpose of the set of tabs to screen reader users.
+   */
+  label: string;
+  componentDidLoad(): void;
+  render(): any;
+}

package/dist/types/components/ic-tab-panel/ic-tab-panel.d.ts

@@ -0,0 +1,37 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { IcThemeForegroundNoDefault } from "../../utils/types";
+export declare class TabPanel {
+  host: HTMLIcTabPanelElement;
+  /**
+   * @internal The appearance of the tabs, e.g dark, or light.
+   */
+  appearance?: IcThemeForegroundNoDefault;
+  /**
+   * @deprecated This is no longer required.
+   * The context id is passed down from `ic-tab-context`
+   */
+  contextId?: string;
+  /**
+   * @internal The shared ID that links the panel and tab.
+   */
+  panelId?: string;
+  /**
+   * @internal The shared ID of the currently selected tab.
+   */
+  selectedTab?: string;
+  /**
+   * @internal The position of the tab panel inside the tabs array in context.
+   */
+  tabPosition?: number;
+  /**
+   * @internal Emitted when a tab panel is dynamically created.
+   */
+  tabPanelCreated: EventEmitter<HTMLIcTabPanelElement>;
+  /**
+   * @internal Emitted when a tab panel is unmounted.
+   */
+  tabPanelRemoved: EventEmitter<void>;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  render(): any;
+}

package/dist/types/components/ic-text-field/ic-text-field.d.ts

@@ -0,0 +1,217 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { IcAutocompleteTypes, IcAutocorrectStates, IcInformationStatusOrEmpty, IcValueEventDetail } from "../../utils/types";
+import { IcAriaAutocompleteTypes, IcTextFieldInputModes, IcTextFieldTypes } from "./ic-text-field.types";
+/**
+ * @slot icon - Content will be placed to the left of the text input.
+ */
+export declare class TextField {
+  private inheritedAttributes;
+  private inputEl;
+  private showLeftIcon;
+  el: HTMLIcTextFieldElement;
+  numChars: number;
+  maxLengthExceeded: boolean;
+  maxValueExceeded: boolean;
+  minValueUnattained: boolean;
+  /**
+   * @slot clear-button - an ic-button clear component will render as an end adornment to the input.
+   * @slot search-submit-button - an ic-button search submit component will render as an end adornment to the input.
+   * @slot menu - an ic-menu component will appear below the input.
+   */
+  /**
+   * @internal The active element when focus is on the ic-menu items.
+   */
+  ariaActiveDescendant?: string;
+  /**
+   * @internal Used to identify whether inputting any text triggers more predictions
+   */
+  ariaAutocomplete: IcAriaAutocompleteTypes;
+  /**
+   * @internal Used to identify if the slotted menu is rendered
+   */
+  ariaExpanded: string;
+  /**
+   * @internal Used to identify any related child component
+   */
+  ariaOwns: string;
+  /**
+   * 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;
+  /**
+   * The state of autocompletion the browser can apply on the text value.
+   */
+  autocomplete: IcAutocompleteTypes;
+  /**
+   * The state of autocorrection the browser can apply when the user is entering/editing the text value.
+   */
+  autocorrect: IcAutocorrectStates;
+  /**
+   * If `true`, the form control will have input focus when the page loads.
+   */
+  autoFocus: boolean;
+  /**
+   * If `true`, the disabled state will be set.
+   */
+  disabled: boolean;
+  /**
+   * Specify whether the text field fills the full width of the container.
+   * If `true`, this overrides the --input-width CSS variable.
+   */
+  fullWidth: boolean;
+  /**
+   * The helper text that will be displayed for additional field guidance.
+   */
+  helperText: string;
+  /**
+   * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
+   */
+  hideLabel: boolean;
+  /**
+   * @internal If `true`, the hidden form input will stop rendering for form submission.
+   */
+  hiddenInput: boolean;
+  /**
+   * The ID for the input.
+   */
+  inputId?: string;
+  /**
+   * A hint to the browser for which keyboard to display.
+   * Possible values: `"none"`, `"text"`, `"tel"`, `"url"`,
+   * `"email"`, `"numeric"`, `"decimal"`, and `"search"`.
+   */
+  inputmode: IcTextFieldInputModes;
+  /**
+   * The label for the input.
+   */
+  label: string;
+  /**
+   * The maximum number that can be accepted as a value, when `type` is `number` and `rows` is `1`. (NOTE: Ensure to include visual indication of max value in `helperText` or `label`)
+   */
+  max: string | number;
+  /**
+   * The maximum number of characters that can be entered in the field.
+   */
+  maxLength: number;
+  /**
+   * The minimum number that can be accepted as a value, when `type` is `number` and `rows` is `1`. (NOTE: Ensure to include visual indication of min value in `helperText` or `label`)
+   */
+  min: string | number;
+  /**
+   * The name of the control, which is submitted with the form data.
+   */
+  name: string;
+  /**
+   * The placeholder value to be displayed.
+   */
+  placeholder: string;
+  /**
+   * If `true`, the read only state will be set.
+   */
+  readonly: boolean;
+  /**
+   * If `true`, the input will require a value.
+   */
+  required: boolean;
+  /**
+   * If `true`, the multiline text area will be resizeable.
+   */
+  resize: boolean;
+  /**
+   * @internal Used to set the role if not default textbox;
+   */
+  role: string;
+  /**
+   * The number of rows to transform the text field into a text area with a specific height.
+   */
+  rows: number;
+  /**
+   * If `true`, the small styling will be applied to the text field.
+   */
+  small: boolean;
+  /**
+   * If `true`, the value of the text field will have its spelling and grammar checked.
+   */
+  spellcheck: boolean;
+  /**
+   * @internal If `true`, an ellipsis will be displayed at the end of the value if the value is longer than the container.
+   */
+  truncateValue?: boolean;
+  /**
+   * The type of control to display. The default type is text.
+   */
+  type: IcTextFieldTypes;
+  /**
+   * If `true`, the icon in input control will be displayed - only applies when validationStatus ='success'.
+   */
+  validationInline: boolean;
+  /**
+   *  @internal If `true`, the validation will display inline.
+   */
+  validationInlineInternal: boolean;
+  /**
+   * The validation state - e.g. 'error' | 'warning' | 'success'.
+   */
+  validationStatus: IcInformationStatusOrEmpty;
+  /**
+   * The validation state - e.g. 'error' | 'warning' | 'success'.
+   */
+  validationText: string;
+  /**
+   * The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
+   */
+  debounce: number;
+  private debounceChanged;
+  /**
+   * The value of the text field.
+   */
+  value: string;
+  initialValue: string;
+  private watchValueHandler;
+  /**
+   * @internal Emitted when the validationInlineInternal is `true`
+   */
+  getValidationText: EventEmitter<IcValueEventDetail>;
+  /**
+   * Emitted when input loses focus.
+   */
+  icBlur: EventEmitter<IcValueEventDetail>;
+  /**
+   * Emitted when the value has changed.
+   */
+  icChange: EventEmitter<IcValueEventDetail>;
+  /**
+   * Emitted when input gains focus.
+   */
+  icFocus: EventEmitter<IcValueEventDetail>;
+  /**
+   * Emitted when a keyboard input occurred.
+   */
+  icInput: EventEmitter<IcValueEventDetail>;
+  /**
+   * Emitted when a keydown event occurred.
+   */
+  icKeydown: EventEmitter<{
+    event: KeyboardEvent;
+  }>;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  handleKeyDown(ev: KeyboardEvent): void;
+  /**
+   * Sets focus on the native `input`.
+   */
+  setFocus(): Promise<void>;
+  private onInput;
+  private onBlur;
+  private onFocus;
+  private isTextArea;
+  private getInlineValidationText;
+  private hasLeftIconSlot;
+  private hasStatus;
+  private showStatusText;
+  private handleFormReset;
+  render(): any;
+}

package/dist/types/components/ic-text-field/ic-text-field.types.d.ts

@@ -0,0 +1,3 @@
+export type IcTextFieldTypes = "email" | "password" | "tel" | "text" | "url" | "number" | "search";
+export type IcTextFieldInputModes = "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search";
+export type IcAriaAutocompleteTypes = "inline" | "list" | undefined;

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

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

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

@@ -0,0 +1,18 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { IcTheme } from "../../utils/types";
+export declare class Theme {
+  /**
+   * The theme colour. Can be a hex value e.g. "#ff0000", RGB e.g. "rgb(255, 0, 0)", or RGBA e.g. "rgba(255, 0, 0, 1)".
+   */
+  color?: string;
+  watchColorPropHandler(): void;
+  /**
+   * @internal Emitted when the theme is changed.
+   */
+  themeChange: EventEmitter<IcTheme>;
+  componentWillLoad(): void;
+  private checkThemeColorContrast;
+  private setThemeColor;
+  private setThemeRGBA;
+  render(): any;
+}

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";
+/**
+ * @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 {
+  private dismissTimeout;
+  private interactiveElements;
+  private isManual;
+  private neutralVariantLabel;
+  private timerRefreshInterval;
+  el: HTMLIcToastElement;
+  timerProgress: number;
+  visible: boolean;
+  /**
+   * 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;
+  /**
+   * If toast can be manually dismissed, this prop sets a custom aria-label for the ic-button component
+   */
+  dismissButtonAriaLabel?: string;
+  /**
+   * How the toast will be dismissed. If manual will display a dismiss button.
+   */
+  dismissMode?: IcActivationTypes;
+  /**
+   * The title to display at the start of the toast. (NOTE: Should be no more than `70` characters)
+   */
+  heading: string;
+  /**
+   * The main body message of the toast. (NOTE: Should be no more than `140` characters)
+   */
+  message?: string;
+  /**
+   * Provides a custom alt-text to be announced to screen readers, if slotting a custom neutral icon
+   */
+  neutralIconAriaLabel?: string;
+  /**
+   * The variant of the toast being rendered
+   */
+  variant?: IcStatusVariants;
+  /**
+   * Is emitted when the user dismisses the toast
+   */
+  icDismiss: EventEmitter<void>;
+  disconnectedCallback(): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  handleDismiss(): void;
+  handleKeyboard(ev: KeyboardEvent): void;
+  handleTimer(ev: MouseEvent): void;
+  /**
+   * Used to display the individual toast
+   * @returns The element that previously had focus before the toast appeared
+   */
+  setVisible(): Promise<HTMLElement>;
+  private dismissAction;
+  private handleProgressChange;
+  private handleLongText;
+  private findNextInteractiveElement;
+  private isActive;
+  render(): any;
+}

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

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

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

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

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

@@ -0,0 +1,12 @@
+export declare class ToastRegion {
+  private pendingVisibility;
+  private previouslyFocused;
+  el: HTMLIcToastRegionElement;
+  handleDismissedToast(): void;
+  /**
+   * 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>;
+  render(): any;
+}

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

@@ -0,0 +1,50 @@
+import { IcTooltipPlacements } from "./ic-tooltip.types";
+export declare class Tooltip {
+  private arrow;
+  private delayedHideEvents;
+  private instantHideEvents;
+  private mouseOverTool;
+  private persistTooltip;
+  private popperInstance;
+  private screenReaderOnlyStyles;
+  private showEvents;
+  private toolTip;
+  el: HTMLIcTooltipElement;
+  /**
+   * If `true`, the tooltip will not be displayed on click, it will require hover or using the display method.
+   */
+  disableClick?: boolean;
+  /**
+   * If `true`, the tooltip will not be displayed on hover, it will require a click or using the display method.
+   */
+  disableHover?: boolean;
+  /**
+   * The position of the tool-tip in relation to the parent element.
+   */
+  placement?: IcTooltipPlacements;
+  /**
+   * The ID of the element the tooltip is describing - for when aria-labelledby or aria-describedby is used.
+   */
+  target?: string;
+  /**
+   * The text to display on the tooltip.
+   */
+  label: string;
+  updateLabel(newValue: string): void;
+  disconnectedCallback(): void;
+  private show;
+  private hide;
+  private checkCloseTooltip;
+  private mouseEnterTooltip;
+  private mouseLeaveTooltip;
+  private handleKeyDown;
+  private manageEventListeners;
+  componentDidLoad(): void;
+  /**
+   * Method to programmatically show/hide the tooltip without needing to interact with an anchor element
+   * @param show Whether to show or hide the tooltip
+   * @param persistTooltip Whether the tooltip should stay on the screen when actions are performed that would previously dismiss the tooltip, such as on hover
+   */
+  displayTooltip(show: boolean, persistTooltip?: boolean): Promise<void>;
+  render(): any;
+}

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

@@ -0,0 +1 @@
+export type IcTooltipPlacements = "top-start" | "top" | "top-end" | "right-start" | "right" | "right-end" | "bottom-end" | "bottom" | "bottom-start" | "left-end" | "left" | "left-start";

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

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

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

@@ -0,0 +1,84 @@
+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.
+ * @slot buttons - Content will be rendered to right of search bar.
+ */
+export declare class TopNavigation {
+  private hasAppIcon;
+  private hasIconButtons;
+  private hasNavigation;
+  private hasSearchSlotContent;
+  private mobileSearchButtonEl;
+  private resizeObserver;
+  private searchBar;
+  el: HTMLIcTopNavigationElement;
+  deviceSize: number;
+  foregroundColor: IcThemeForeground;
+  hasFullWidthSearchBar: boolean;
+  menuOpen: boolean;
+  mobileSearchBarVisible: boolean;
+  mobileSearchHiddenOnBlur: boolean;
+  navMenuVisible: boolean;
+  searchButtonClick: boolean;
+  searchValue: string;
+  /**
+   * The alignment of the top navigation content.
+   */
+  contentAligned: IcAlignment;
+  /**
+   *  The URL to navigate to when the app title is clicked.
+   */
+  href: string;
+  /**
+   * If `true`, the flyout navigation menu on small devices will be contained by the parent element.
+   */
+  inline: boolean;
+  /**
+   * The short title of the app to be displayed at small screen sizes in place of the app title.
+   */
+  shortAppTitle: string;
+  /**
+   * The status info to be displayed.
+   */
+  status: string;
+  /**
+   * The version info to be displayed.
+   */
+  version: string;
+  /**
+   * The app title to be displayed. This is required, unless a slotted app title link is used.
+   */
+  appTitle: string;
+  watchPropHandler(newValue: string, oldValue: string): void;
+  /**
+   * @internal - Emitted when the menu is closed.
+   */
+  icNavigationMenuClosed: EventEmitter<void>;
+  /**
+   * @internal - Emitted when the menu is opened.
+   */
+  icNavigationMenuOpened: EventEmitter<void>;
+  disconnectedCallback(): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  navBarMenuCloseHandler(): void;
+  searchInputBlurHandler(ev: CustomEvent): void;
+  searchValueChangeHandler(ev: CustomEvent): void;
+  themeChangeHandler(ev: CustomEvent): void;
+  private initialiseSearchBar;
+  private toggleSearchBar;
+  private emitTopNavResized;
+  private menuButtonClick;
+  private showNavMenu;
+  private searchButtonMouseDownHandler;
+  private searchButtonClickHandler;
+  private resizeObserverCallback;
+  private runResizeObserver;
+  render(): any;
+}

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

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