@ukic/canary-web-components 2.0.0-canary.11 → 2.0.0-canary.12

package/dist/types/utils/constants.d.ts

@@ -1,38 +1 @@
-export declare const VARIANT_ICONS: {
-    neutral: {
-        icon: string;
-        ariaLabel: string;
-    };
-    info: {
-        icon: string;
-        ariaLabel: string;
-    };
-    warning: {
-        icon: string;
-        ariaLabel: string;
-    };
-    error: {
-        icon: string;
-        ariaLabel: string;
-    };
-    success: {
-        icon: string;
-        ariaLabel: string;
-    };
-};
 export declare const IC_INHERITED_ARIA: string[];
-export declare const IC_DEVICE_SIZES: {
-    XS: number;
-    S: number;
-    M: number;
-    L: number;
-    XL: number;
-};
-export declare const IC_BLOCK_COLOR_COMPONENTS: string[];
-export declare const IC_FIXED_COLOR_COMPONENTS: string[];
-export interface IcColorExceptions {
-    [details: string]: string[];
-}
-export declare const IC_BLOCK_COLOR_EXCEPTIONS: IcColorExceptions;
-export declare const BLACK_MIN_COLOR_BRIGHTNESS = 136.701;
-export declare const WHITE_MAX_COLOR_BRIGHTNESS = 130;

package/dist/types/utils/helpers.d.ts

@@ -1,15 +1,4 @@
-/**
- * To investigate:
- * IcColorRGBA works via @ukic/web-components but IcThemeForeground does not even though they are exported
- * from @ukic/web-components in the same file. Why?
- */
-import { IcCallbackFunctionNoReturn, IcInformationStatusOrEmpty, IcNavParentDetails, IcPropObject, IcSearchMatchPositions, IcColorRGBA } from "@ukic/web-components";
-import { IcMenuOption, IcThemeForeground } from "./types";
-import { EventEmitter } from "../stencil-public-runtime";
-/**
- * converts an enum of strings into an array of strings
- */
-export declare const stringEnumToArray: (theEnum: Record<string, string | number>) => string[];
+import { IcCallbackFunctionNoReturn, IcInformationStatusOrEmpty, IcPropObject, IcSearchMatchPositions, IcMenuOption } from "@ukic/web-components";
 /**
  * Used to inherit global attributes set on the host. Called in componentWillLoad and assigned
  * to a variable that is later used in the render function.
@@ -20,8 +9,6 @@ export declare const stringEnumToArray: (theEnum: Record<string, string | number
 export declare const inheritAttributes: (element: HTMLElement, attributes?: string[]) => {
     [key: string]: unknown;
 };
-export declare const debounceEvent: (event: EventEmitter, wait: number) => EventEmitter;
-export declare const debounce: (func: (...args: unknown[]) => void, wait?: number) => unknown;
 /**
  * This method is used to add a hidden input to a host element that contains
  * a Shadow DOM. It does not add the input inside of the Shadow root which
@@ -34,62 +21,7 @@ export declare const debounce: (func: (...args: unknown[]) => void, wait?: numbe
  * @param value The value of the input
  * @param disabled If true, the input is disabled
  */
-export declare const renderHiddenInput: (always: boolean, container: HTMLElement, name: string, value: string | Date | undefined | null, disabled: boolean) => void;
-export declare const removeHiddenInput: (container: HTMLElement) => void;
-/**
- * This method helps to understand the context in which a component exists,
- * to assist with choosing appropriate foreground colours to use. For example,
- * this method will help you use the 'white' version of a button if it's within
- * a block colour element using white foreground text.
- *
- * This only works for components/elements passed via <slot> and not if they
- * are part of an IC component.
- *
- * ""
- * @returns IcThemeForeground depending on the context
- */
-export declare const getThemeFromContext: (el: Element, themeFromEvent?: IcThemeForeground) => IcThemeForeground;
-/**
- * Will create a button within the lightDOM which interacts with the parent form.
- * This is required as buttons within the shadowDOM will not invoke a submit or reset
- *
- * @param form - parent form element which contains shadowDom button
- * @param button - shadowDOM button
- */
-export declare const handleHiddenFormButtonClick: (form: HTMLFormElement, button: HTMLIcButtonElement | HTMLButtonElement) => void;
-export declare const isEmptyString: (value: string) => boolean;
-export declare const isPropDefined: (prop: string) => string | null;
-export declare const deviceSizeMatches: (size: number) => boolean;
-export declare const getCurrentDeviceSize: () => number;
-export declare const getCssProperty: (cssVar: string) => string;
-/**
- * Returns the brightness of the theme colour, calculated by using the theme RGB CSS values by:
- * - Multiplying each RGB value by a set number: https://www.w3.org/TR/AERT/#color-contrast
- * - Adding them together and dividing by 1000
- * This is a similar calculation to its CSS counterpart: "--ic-theme-text"
- * @returns number representing the brightness of the theme colour
- */
-export declare const getThemeColorBrightness: () => number;
-/**
- * Returns if dark or light foreground colors should be used for color contrast reasons
- * @returns "dark" or "light"
- */
-export declare const getThemeForegroundColor: () => IcThemeForeground;
-export declare const getSlot: (element: HTMLElement, name: string) => Element | null;
-export declare const slotHasContent: (element: HTMLElement, name: string) => boolean;
-export declare const getSlotContent: (element: HTMLElement, name: string) => Element[] | NodeListOf<ChildNode> | null;
-export declare const getSlotElements: (slot: Element) => NodeListOf<ChildNode> | Element[];
-export declare const getNavItemParentDetails: (el: HTMLElement) => IcNavParentDetails;
-export declare const DEVICE_SIZES: {
-    XS: number;
-    S: number;
-    M: number;
-    L: number;
-    XL: number;
-    UNDEFINED: number;
-};
-export declare const isSlotUsed: (element: HTMLElement, slotName: string) => boolean;
-export declare const onComponentPropUndefinedChange: (oldValue: string | undefined, newValue: string | undefined, callback: IcCallbackFunctionNoReturn) => void;
+export declare const renderHiddenInput: (always: boolean, container: HTMLElement, name: string, value: string | undefined | null, disabled: boolean) => void;
 export declare const hasShadowDom: (el: HTMLElement) => boolean;
 export declare const getInputHelperTextID: (id: string) => string;
 export declare const getInputValidationTextID: (id: string) => string;
@@ -118,19 +50,15 @@ export declare const getFilteredMenuOptions: (options: IcMenuOption[], includeDe
  * @returns number of options not including group titles
  */
 export declare const getOptionsWithoutGroupTitlesCount: (options: IcMenuOption[]) => number;
-export declare const hexToRgba: (hex: string) => IcColorRGBA;
-export declare const rgbaStrToObj: (rgbaStr: string) => IcColorRGBA;
-export declare const elementOverflowsX: (element: HTMLElement) => boolean;
-/**
- *
- * @param child - The child element
- * @returns string
- */
-export declare const getParentElementType: (child: HTMLElement) => string;
-export declare const getParentElement: (child: HTMLElement) => HTMLElement;
-export declare const hasClassificationBanner: () => boolean;
-export declare const pxToRem: (px: string, base?: number) => string;
-export declare const isNumeric: (value: string) => boolean;
+export declare const getCssProperty: (cssVar: string) => string;
+export declare const DEVICE_SIZES: {
+    XS: number;
+    S: number;
+    M: number;
+    L: number;
+    XL: number;
+    UNDEFINED: number;
+};
 export declare const hasValidationStatus: (status: IcInformationStatusOrEmpty, disabled: boolean) => boolean;
 export declare const onComponentRequiredPropUndefined: (props: IcPropObject[], component: string) => void;
 export declare const kebabToCamelCase: (kebabCase: string) => string;
@@ -140,4 +68,8 @@ export declare const addFormResetListener: (el: HTMLElement, callbackFn: IcCallb
 export declare const removeFormResetListener: (el: HTMLElement, callbackFn: IcCallbackFunctionNoReturn) => void;
 export declare const removeDisabledFalse: (disabled: boolean, element: HTMLElement) => void;
 export declare const isMacDevice: () => boolean;
-export declare function waitForHydration(): Promise<boolean>;
+export declare const isSlotUsed: (element: HTMLElement, slotName: string) => boolean;
+export declare const getSlot: (element: HTMLElement, name: string) => Element | null;
+export declare const getSlotElements: (slot: Element) => NodeListOf<ChildNode> | Element[];
+export declare const getSlotContent: (element: HTMLElement, name: string) => Element[] | NodeListOf<ChildNode> | null;
+export declare const pxToRem: (px: string, base?: number) => string;

package/dist/types/utils/types.d.ts

@@ -1,17 +1,10 @@
-export type IcFocusableComponents = HTMLIcBreadcrumbElement | HTMLIcButtonElement | HTMLIcCardElement | HTMLIcCheckboxElement | HTMLIcChipElement | HTMLIcLinkElement | HTMLIcNavigationButtonElement | HTMLIcNavigationGroupElement | HTMLIcNavigationItemElement | HTMLIcRadioOptionElement | HTMLIcSearchBarElement | HTMLIcSelectElement | HTMLIcSwitchElement | HTMLIcTabElement | HTMLIcTextFieldElement;
-export type IcStatusVariants = "neutral" | "info" | "warning" | "error" | "success";
 export declare enum IcInformationStatus {
     Warning = "warning",
     Error = "error",
     Success = "success"
 }
-export type IcSearchMatchPositions = "start" | "anywhere";
-export type IcSizes = "default" | "large" | "small";
-export type IcSizesNoLarge = "default" | "small";
 export type IcInformationStatusOrEmpty = "warning" | "error" | "success" | "";
-export type IcNavType = "side" | "top" | "page-header";
-export type IcAutocompleteTypes = "on" | "off" | "name" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "email" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "url" | "photo";
-export type IcAlignment = "left" | "center" | "full-width";
+export type IcSearchMatchPositions = "start" | "anywhere";
 export declare enum IcThemeForegroundEnum {
     Default = "default",
     Dark = "dark",
@@ -21,87 +14,3 @@ export interface IcValueEventDetail {
     value: string | string[];
     keyPressed?: string;
 }
-export type IcThemeForeground = "default" | "dark" | "light";
-export type IcThemeForegroundNoDefault = "dark" | "light";
-export type IcTheme = {
-    mode: IcThemeForeground;
-    color: IcColorRGB;
-};
-export type IcAdditionalFieldTypes = "static" | "dynamic";
-export type IcColorRGB = {
-    r: number;
-    g: number;
-    b: number;
-};
-export type IcColorRGBA = IcColorRGB & {
-    a: number;
-};
-export type IcActivationTypes = "automatic" | "manual";
-export type IcAutocorrectStates = "on" | "off";
-export type IcNavParentDetails = {
-    navType: IcNavType | "";
-    parent: HTMLElement;
-};
-export type IcTypographyVariants = "h1" | "h2" | "h3" | "h4" | "subtitle-large" | "subtitle-small" | "body" | "label" | "label-uppercase" | "caption" | "caption-uppercase" | "code-large" | "code-small" | "code-extra-small" | "badge" | "badge-small";
-/**
- * @interface IcMenuOption
- * @field {string} A label field to options. Defaults to "label", but can have any custom name.
- * @field {string} A value field to options. Defaults to "value", but can have any custom name.
- */
-export interface IcMenuOption {
-    description?: string;
-    disabled?: boolean;
-    recommended?: boolean;
-    children?: IcMenuOption[];
-    loading?: boolean;
-    timedOut?: boolean;
-    [key: string]: any;
-    element?: {
-        component: any;
-        ariaLabel: string;
-    };
-    icon?: any;
-}
-export type IcCallbackFunctionNoReturn = (...args: unknown[]) => void;
-export type IcDateFormat = "DD/MM/YYYY" | "MM/DD/YYYY" | "YYYY/MM/DD";
-export declare enum IcDateInputMonths {
-    "January" = 0,
-    "February" = 1,
-    "March" = 2,
-    "April" = 3,
-    "May" = 4,
-    "June" = 5,
-    "July" = 6,
-    "August" = 7,
-    "September" = 8,
-    "October" = 9,
-    "November" = 10,
-    "December" = 11
-}
-export declare enum IcShortDayNames {
-    "Sun" = 0,
-    "Mon" = 1,
-    "Tue" = 2,
-    "Wed" = 3,
-    "Thu" = 4,
-    "Fri" = 5,
-    "Sat" = 6
-}
-export declare enum IcDayNames {
-    "Sunday" = 0,
-    "Monday" = 1,
-    "Tuesday" = 2,
-    "Wednesday" = 3,
-    "Thursday" = 4,
-    "Friday" = 5,
-    "Saturday" = 6
-}
-export declare enum IcWeekDays {
-    Sunday = 0,
-    Monday = 1,
-    Tuesday = 2,
-    Wednesday = 3,
-    Thursday = 4,
-    Friday = 5,
-    Saturday = 6
-}