@ukic/canary-web-components 3.0.0-canary.26 → 3.0.0-canary.28

package/dist/types/components.d.ts

@@ -8,16 +8,16 @@ import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
 import { IcCardSizes } from "./components/ic-card-horizontal/ic-card-horizontal.types";
 import { IcThemeMode } from "@ukic/web-components";
 import { IcDataTableColumnObject, IcDataTableDataType, IcDataTableDensityOptions, IcDataTableRowHeights, IcDataTableSortOrderOptions, IcDataTableTruncationTypes, IcDensityUpdateEventDetail, IcSortEventDetail } from "./components/ic-data-table/ic-data-table.types";
-import { IcDateFormat, IcDisableTimeSelection, IcInformationStatusOrEmpty, IcPaginationBarOptions, IcPositionTopOrRight, IcSizes, IcThemeMode as IcThemeMode1, IcTimeFormat, IcWeekDays } from "./utils/types";
+import { IcAriaLive, IcDateFormat, IcDisableTimeSelection, IcInformationStatusOrEmpty, IcPaginationBarOptions, IcPositionTopOrRight, IcSizes, IcThemeMode as IcThemeMode1, IcTimeFormat, IcWeekDays } from "./utils/types";
 import { IcPaginationAlignmentOptions, IcPaginationLabelTypes, IcPaginationTypes } from "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types";
-import { IcPageChangeEventDetail } from "./components/ic-pagination-bar/ic-pagination-bar.types";
+import { IcItemsPerPageChangeEventDetail, IcPageChangeEventDetail } from "./components/ic-pagination-bar/ic-pagination-bar.types";
 import { IcTreeItemOptions } from "./components/ic-tree-view/ic-tree-view.types";
 export { IcCardSizes } from "./components/ic-card-horizontal/ic-card-horizontal.types";
 export { IcThemeMode } from "@ukic/web-components";
 export { IcDataTableColumnObject, IcDataTableDataType, IcDataTableDensityOptions, IcDataTableRowHeights, IcDataTableSortOrderOptions, IcDataTableTruncationTypes, IcDensityUpdateEventDetail, IcSortEventDetail } from "./components/ic-data-table/ic-data-table.types";
-export { IcDateFormat, IcDisableTimeSelection, IcInformationStatusOrEmpty, IcPaginationBarOptions, IcPositionTopOrRight, IcSizes, IcThemeMode as IcThemeMode1, IcTimeFormat, IcWeekDays } from "./utils/types";
+export { IcAriaLive, IcDateFormat, IcDisableTimeSelection, IcInformationStatusOrEmpty, IcPaginationBarOptions, IcPositionTopOrRight, IcSizes, IcThemeMode as IcThemeMode1, IcTimeFormat, IcWeekDays } from "./utils/types";
 export { IcPaginationAlignmentOptions, IcPaginationLabelTypes, IcPaginationTypes } from "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types";
-export { IcPageChangeEventDetail } from "./components/ic-pagination-bar/ic-pagination-bar.types";
+export { IcItemsPerPageChangeEventDetail, IcPageChangeEventDetail } from "./components/ic-pagination-bar/ic-pagination-bar.types";
 export { IcTreeItemOptions } from "./components/ic-tree-view/ic-tree-view.types";
 export namespace Components {
     interface IcCardHorizontal {
@@ -329,6 +329,10 @@ export namespace Components {
          */
         "theme"?: IcThemeMode1;
         "triggerIcChange": (d: Date | null) => Promise<void>;
+        /**
+          * The value of the `aria-live` attribute on the validation message.
+         */
+        "validationAriaLive": IcAriaLive;
         /**
           * The validation status - e.g. 'error' | 'warning' | 'success'. This will override the built-in date validation.
          */
@@ -451,6 +455,10 @@ export namespace Components {
           * Sets the date picker to the dark or light theme colors. "inherit" will set the color based on the system settings or ic-theme component.
          */
         "theme"?: IcThemeMode1;
+        /**
+          * The value of the `aria-live` attribute on the validation message.
+         */
+        "validationAriaLive": IcAriaLive;
         /**
           * The validation status - e.g. 'error' | 'warning' | 'success'. This will override the built-in date validation.
          */
@@ -651,6 +659,10 @@ export namespace Components {
          */
         "timePeriod": "12" | "24";
         "triggerIcChange": (t: Date | null) => Promise<void>;
+        /**
+          * The value of the `aria-live` attribute on the validation message.
+         */
+        "validationAriaLive": IcAriaLive;
         /**
           * The validation status - e.g. 'error' | 'warning' | 'success'. This will override the built-in time validation.
          */
@@ -874,7 +886,7 @@ declare global {
     };
     interface HTMLIcPaginationBarElementEventMap {
         "icPageChange": IcPageChangeEventDetail;
-        "icItemsPerPageChange": { value: number };
+        "icItemsPerPageChange": IcItemsPerPageChangeEventDetail;
     }
     interface HTMLIcPaginationBarElement extends Components.IcPaginationBar, HTMLStencilElement {
         addEventListener<K extends keyof HTMLIcPaginationBarElementEventMap>(type: K, listener: (this: HTMLIcPaginationBarElement, ev: IcPaginationBarCustomEvent<HTMLIcPaginationBarElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -1307,6 +1319,10 @@ declare namespace LocalJSX {
           * Sets the date picker to the dark or light theme colors. "inherit" will set the color based on the system settings or ic-theme component.
          */
         "theme"?: IcThemeMode1;
+        /**
+          * The value of the `aria-live` attribute on the validation message.
+         */
+        "validationAriaLive"?: IcAriaLive;
         /**
           * The validation status - e.g. 'error' | 'warning' | 'success'. This will override the built-in date validation.
          */
@@ -1433,6 +1449,10 @@ declare namespace LocalJSX {
           * Sets the date picker to the dark or light theme colors. "inherit" will set the color based on the system settings or ic-theme component.
          */
         "theme"?: IcThemeMode1;
+        /**
+          * The value of the `aria-live` attribute on the validation message.
+         */
+        "validationAriaLive"?: IcAriaLive;
         /**
           * The validation status - e.g. 'error' | 'warning' | 'success'. This will override the built-in date validation.
          */
@@ -1481,7 +1501,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when the items per page option is changed.
          */
-        "onIcItemsPerPageChange"?: (event: IcPaginationBarCustomEvent<{ value: number }>) => void;
+        "onIcItemsPerPageChange"?: (event: IcPaginationBarCustomEvent<IcItemsPerPageChangeEventDetail>) => void;
         /**
           * Emitted when a page is navigated to via the 'go to' input. The `detail` property contains `value` (i.e. the page number) and a `fromItemsPerPage` flag to indicate if the event was triggered by the `icItemsPerPageChange` event also occurring.
          */
@@ -1653,6 +1673,10 @@ declare namespace LocalJSX {
           * The time period format: "12" for 12-hour, "24" for 24-hour. Defaults to "24".
          */
         "timePeriod"?: "12" | "24";
+        /**
+          * The value of the `aria-live` attribute on the validation message.
+         */
+        "validationAriaLive"?: IcAriaLive;
         /**
           * The validation status - e.g. 'error' | 'warning' | 'success'. This will override the built-in time validation.
          */

package/dist/types/home/runner/work/ic-ui-kit/ic-ui-kit/packages/canary-web-components/.stencil/web-components/src/utils/common-helpers.d.ts

@@ -0,0 +1,2 @@
+export declare const sanitizeHTMLString: (html: string) => string;
+export declare const sanitizeHTMLIconString: (html: string) => string;

package/dist/types/home/runner/work/ic-ui-kit/ic-ui-kit/packages/canary-web-components/.stencil/web-components/src/utils/constants.d.ts

@@ -0,0 +1,44 @@
+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;
+    };
+    ai: {
+        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;
+export declare const IGNORED_KEYBOARD_CHARACTERS: string[];
+export declare const IC_CUSTOM_ALLOWED_COMPONENTS: string[];

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

@@ -42,8 +42,10 @@ export type IcNavParentDetails = {
 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.
+ * Set "label" and "value" props to use as the option's label and value.
+ * Alternatively, custom names for these props can be used e.g. by setting the "labelField" and "valueField" props on the relevant component.
+ *
+ * Any props supplied to the "htmlProps" object will be spread onto the option's underlying <li> element.
  */
 export interface IcMenuOption {
     description?: string;
@@ -58,6 +60,7 @@ export interface IcMenuOption {
         ariaLabel: string;
     };
     icon?: any;
+    htmlProps?: Record<string, any>;
 }
 export type IcSearchMatchPositions = "start" | "anywhere";
 export type IcCallbackFunctionNoReturn = (...args: unknown[]) => void;
@@ -158,4 +161,5 @@ export declare enum IcWeekDays {
     Saturday = 6
 }
 export type IcPositionTopOrRight = "top" | "right";
+export type IcAriaLive = "polite" | "assertive" | "off";
 export {};