@ukic/web-components 2.1.0-beta.15 → 2.1.0-beta.17

package/dist/types/components.d.ts

@@ -5,7 +5,7 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { IcActivationTypes, IcAdditionalFieldTypes, IcAlignment, IcAutocompleteTypes, IcAutocorrectStates, IcInformationStatusOrEmpty, IcMenuOption, IcOrientation, IcSearchMatchPositions, IcStatusVariants, IcTheme, IcThemeForeground, IcThemeForegroundNoDefault, IcTypographyVariants, IcValueEventDetail } from "./utils/types";
+import { IcActivationTypes, IcAdditionalFieldTypes, IcAlignment, IcAutocompleteTypes, IcAutocorrectStates, IcBlurEventDetail, IcInformationStatusOrEmpty, IcMenuOption, IcOrientation, IcSearchMatchPositions, IcStatusVariants, IcTheme, IcThemeForeground, IcThemeForegroundNoDefault, IcTypographyVariants, IcValueEventDetail } from "./utils/types";
 import { IcButtonSizes, IcButtonTooltipPlacement, IcButtonTypes, IcButtonVariants } from "./components/ic-button/ic-button.types";
 import { IcChangeEventDetail } from "./components/ic-checkbox-group/ic-checkbox-group.types";
 import { IcChipAppearance, IcChipSizes } from "./components/ic-chip/ic-chip.types";
@@ -17,8 +17,8 @@ import { IcLoadingSizes, IcLoadingTypes } from "./components/ic-loading-indicato
 import { IcMenuChangeEventDetail, IcMenuOptionIdEventDetail, IcOptionSelectEventDetail } from "./components/ic-menu/ic-menu.types";
 import { IcMenuItemVariants } from "./components/ic-menu-item/ic-menu-item.types";
 import { IcChangeEventDetail as IcChangeEventDetail1, IcPaginationTypes } from "./components/ic-pagination/ic-pagination.types";
-import { IcAutocompleteTypes as IcAutocompleteTypes1, IcAutocorrectStates as IcAutocorrectStates1, IcBlurEventDetail, IcInformationStatusOrEmpty as IcInformationStatusOrEmpty1, IcThemeForeground as IcThemeForeground1, IcValueEventDetail as IcValueEventDetail1 } from "./interface";
 import { IcPaginationItemType } from "./components/ic-pagination-item/ic-pagination-item.types";
+import { IcChangeEventDetail as IcChangeEventDetail2 } from "./components/ic-radio-group/ic-radio-group.types";
 import { IcSearchBarBlurEventDetail } from "./components/ic-search-bar/ic-search-bar.types";
 import { IcSkeletonVariants } from "./components/ic-skeleton/ic-skeleton.types";
 import { IcStatusTagAppearance, IcStatusTagStatuses } from "./components/ic-status-tag/ic-status-tag.types";
@@ -28,6 +28,29 @@ import { IcSwitchChangeEventDetail } from "./components/ic-switch/ic-switch.type
 import { IcTabClickEventDetail, IcTabSelectEventDetail } from "./components/ic-tab/ic-tab.types";
 import { IcAriaAutocompleteTypes, IcTextFieldInputModes, IcTextFieldTypes } from "./components/ic-text-field/ic-text-field.types";
 import { IcTooltipPlacements } from "./components/ic-tooltip/ic-tooltip.types";
+export { IcActivationTypes, IcAdditionalFieldTypes, IcAlignment, IcAutocompleteTypes, IcAutocorrectStates, IcBlurEventDetail, IcInformationStatusOrEmpty, IcMenuOption, IcOrientation, IcSearchMatchPositions, IcStatusVariants, IcTheme, IcThemeForeground, IcThemeForegroundNoDefault, IcTypographyVariants, IcValueEventDetail } from "./utils/types";
+export { IcButtonSizes, IcButtonTooltipPlacement, IcButtonTypes, IcButtonVariants } from "./components/ic-button/ic-button.types";
+export { IcChangeEventDetail } from "./components/ic-checkbox-group/ic-checkbox-group.types";
+export { IcChipAppearance, IcChipSizes } from "./components/ic-chip/ic-chip.types";
+export { IcProtectiveMarkings } from "./components/ic-classification-banner/ic-classification-banner.types";
+export { IcFooterBreakpoints } from "./components/ic-footer/ic-footer.types";
+export { IcHeroContentAlignments } from "./components/ic-hero/ic-hero.types";
+export { IcAriaLiveModeVariants } from "./components/ic-input-validation/ic-input-validation.types";
+export { IcLoadingSizes, IcLoadingTypes } from "./components/ic-loading-indicator/ic-loading-indicator.types";
+export { IcMenuChangeEventDetail, IcMenuOptionIdEventDetail, IcOptionSelectEventDetail } from "./components/ic-menu/ic-menu.types";
+export { IcMenuItemVariants } from "./components/ic-menu-item/ic-menu-item.types";
+export { IcChangeEventDetail as IcChangeEventDetail1, IcPaginationTypes } from "./components/ic-pagination/ic-pagination.types";
+export { IcPaginationItemType } from "./components/ic-pagination-item/ic-pagination-item.types";
+export { IcChangeEventDetail as IcChangeEventDetail2 } from "./components/ic-radio-group/ic-radio-group.types";
+export { IcSearchBarBlurEventDetail } from "./components/ic-search-bar/ic-search-bar.types";
+export { IcSkeletonVariants } from "./components/ic-skeleton/ic-skeleton.types";
+export { IcStatusTagAppearance, IcStatusTagStatuses } from "./components/ic-status-tag/ic-status-tag.types";
+export { IcStepStatuses, IcStepTypes, IcStepVariants } from "./components/ic-step/ic-step.types";
+export { IcStepperAlignment } from "./components/ic-stepper/ic-stepper.types";
+export { IcSwitchChangeEventDetail } from "./components/ic-switch/ic-switch.types";
+export { IcTabClickEventDetail, IcTabSelectEventDetail } from "./components/ic-tab/ic-tab.types";
+export { IcAriaAutocompleteTypes, IcTextFieldInputModes, IcTextFieldTypes } from "./components/ic-text-field/ic-text-field.types";
+export { IcTooltipPlacements } from "./components/ic-tooltip/ic-tooltip.types";
 export namespace Components {
     interface IcAlert {
         /**
@@ -391,6 +414,68 @@ export namespace Components {
          */
         "value": string;
     }
+    interface IcDialog {
+        /**
+          * 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;
+        /**
+          * Sets the label and onclick functions for default buttons.
+         */
+        "buttonProps"?: { label: string; onclick: string }[];
+        /**
+          * If set to `false`, dialog controls will not be displayed overriding buttonProps or slotted dialog controls.
+         */
+        "buttons"?: boolean;
+        /**
+          * Cancels the dialog. Used by the default 'Cancel' button or can be called manually to trigger cancelling of dialog.
+         */
+        "cancelDialog": () => Promise<void>;
+        /**
+          * If set to `true`, the dialog will not close when the backdrop is clicked.
+         */
+        "closeOnBackdropClick"?: boolean;
+        /**
+          * Confirms the dialog. Used by the default 'Confirm' button or can be called manually to trigger confirming of dialog.
+         */
+        "confirmDialog": () => Promise<void>;
+        /**
+          * 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;
+        /**
+          * Use to hide the dialog.
+         */
+        "hideDialog": () => Promise<void>;
+        /**
+          * Sets the optional label for the dialog which appears above the heading.
+         */
+        "label"?: string;
+        /**
+          * Use to show the dialog.
+         */
+        "showDialog": () => Promise<void>;
+        /**
+          * 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";
+    }
     interface IcDivider {
     }
     interface IcFooter {
@@ -921,7 +1006,7 @@ export namespace Components {
         /**
           * The appearance of the pagination, e.g. dark, light or the default.
          */
-        "appearance": IcThemeForeground1;
+        "appearance": IcThemeForeground;
         /**
           * The number of pages displayed as boundary items to the current page when using 'complex' type pagination. Accepted values are 0, 1 & 2.
          */
@@ -967,7 +1052,7 @@ export namespace Components {
         /**
           * The appearance of the pagination, e.g. dark, light or the default.
          */
-        "appearance": IcThemeForeground1;
+        "appearance": IcThemeForeground;
         /**
           * If true the aria-label will be set to `Page X of Y`, where X is the current page and Y is the page count.
          */
@@ -1562,11 +1647,11 @@ export namespace Components {
         /**
           * The state of autocompletion the browser can apply on the text value.
          */
-        "autocomplete": IcAutocompleteTypes1;
+        "autocomplete": IcAutocompleteTypes;
         /**
           * The state of autocorrection the browser can apply when the user is entering/editing the text value.
          */
-        "autocorrect": IcAutocorrectStates1;
+        "autocorrect": IcAutocorrectStates;
         /**
           * The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
          */
@@ -1662,7 +1747,7 @@ export namespace Components {
         /**
           * The validation state - e.g. 'error' | 'warning' | 'success'.
          */
-        "validationStatus": IcInformationStatusOrEmpty1;
+        "validationStatus": IcInformationStatusOrEmpty;
         /**
           * The validation state - e.g. 'error' | 'warning' | 'success'.
          */
@@ -1805,6 +1890,10 @@ export interface IcChipCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLIcChipElement;
 }
+export interface IcDialogCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLIcDialogElement;
+}
 export interface IcFooterCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLIcFooterElement;
@@ -1954,6 +2043,12 @@ declare global {
         prototype: HTMLIcDataRowElement;
         new (): HTMLIcDataRowElement;
     };
+    interface HTMLIcDialogElement extends Components.IcDialog, HTMLStencilElement {
+    }
+    var HTMLIcDialogElement: {
+        prototype: HTMLIcDialogElement;
+        new (): HTMLIcDialogElement;
+    };
     interface HTMLIcDividerElement extends Components.IcDivider, HTMLStencilElement {
     }
     var HTMLIcDividerElement: {
@@ -2237,6 +2332,7 @@ declare global {
         "ic-classification-banner": HTMLIcClassificationBannerElement;
         "ic-data-entity": HTMLIcDataEntityElement;
         "ic-data-row": HTMLIcDataRowElement;
+        "ic-dialog": HTMLIcDialogElement;
         "ic-divider": HTMLIcDividerElement;
         "ic-footer": HTMLIcFooterElement;
         "ic-footer-link": HTMLIcFooterLinkElement;
@@ -2661,6 +2757,68 @@ declare namespace LocalJSX {
          */
         "value"?: string;
     }
+    interface IcDialog {
+        /**
+          * 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;
+        /**
+          * Sets the label and onclick functions for default buttons.
+         */
+        "buttonProps"?: { label: string; onclick: 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;
+        /**
+          * Cancelation event emitted when default 'Cancel' button clicked or 'cancelDialog' method is called.
+         */
+        "onIcDialogCancelled"?: (event: IcDialogCustomEvent<void>) => void;
+        /**
+          * Emitted when dialog has closed.
+         */
+        "onIcDialogClosed"?: (event: IcDialogCustomEvent<void>) => void;
+        /**
+          * Confirmation event emitted when default 'Confirm' primary button clicked or 'confirmDialog' method is called.
+         */
+        "onIcDialogConfirmed"?: (event: IcDialogCustomEvent<void>) => void;
+        /**
+          * Emitted when dialog has opened.
+         */
+        "onIcDialogOpened"?: (event: IcDialogCustomEvent<void>) => void;
+        /**
+          * 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";
+    }
     interface IcDivider {
     }
     interface IcFooter {
@@ -3161,7 +3319,7 @@ declare namespace LocalJSX {
         /**
           * The appearance of the pagination, e.g. dark, light or the default.
          */
-        "appearance"?: IcThemeForeground1;
+        "appearance"?: IcThemeForeground;
         /**
           * The number of pages displayed as boundary items to the current page when using 'complex' type pagination. Accepted values are 0, 1 & 2.
          */
@@ -3207,7 +3365,7 @@ declare namespace LocalJSX {
         /**
           * The appearance of the pagination, e.g. dark, light or the default.
          */
-        "appearance"?: IcThemeForeground1;
+        "appearance"?: IcThemeForeground;
         /**
           * If true the aria-label will be set to `Page X of Y`, where X is the current page and Y is the page count.
          */
@@ -3275,7 +3433,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when a user selects a radio.
          */
-        "onIcChange"?: (event: IcRadioGroupCustomEvent<IcValueEventDetail1>) => void;
+        "onIcChange"?: (event: IcRadioGroupCustomEvent<IcChangeEventDetail2>) => void;
         /**
           * The orientation of the radio buttons in the radio group. If there are more than two radio buttons in a radio group or either of the radio buttons use the `additional-field` slot, then the orientation will always be vertical.
          */
@@ -3323,13 +3481,17 @@ declare namespace LocalJSX {
          */
         "name"?: string;
         /**
-          * Emitted when a radio is selected.
+          * Emitted when the radio option is selected.
          */
-        "onIcCheck"?: (event: IcRadioOptionCustomEvent<IcValueEventDetail1>) => void;
+        "onIcCheck"?: (event: IcRadioOptionCustomEvent<IcValueEventDetail>) => void;
+        /**
+          * Emitted when the radio option is selected or deselected.
+         */
+        "onIcSelectedChange"?: (event: IcRadioOptionCustomEvent<void>) => void;
         /**
           * @deprecated This event should not be used anymore. Use icCheck instead.
          */
-        "onRadioOptionSelect"?: (event: IcRadioOptionCustomEvent<IcValueEventDetail1>) => void;
+        "onRadioOptionSelect"?: (event: IcRadioOptionCustomEvent<IcValueEventDetail>) => void;
         /**
           * If `true`, the radio option will be displayed in a selected state.
          */
@@ -3419,7 +3581,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when the value has changed.
          */
-        "onIcChange"?: (event: IcSearchBarCustomEvent<IcValueEventDetail1>) => void;
+        "onIcChange"?: (event: IcSearchBarCustomEvent<IcValueEventDetail>) => void;
         /**
           * Emitted when value is cleared with clear button
          */
@@ -3427,7 +3589,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when a keyboard input occurred.
          */
-        "onIcInput"?: (event: IcSearchBarCustomEvent<IcValueEventDetail1>) => void;
+        "onIcInput"?: (event: IcSearchBarCustomEvent<IcValueEventDetail>) => void;
         /**
           * @deprecated This event should not be used anymore. Use icSearchBarBlur instead.
          */
@@ -3435,7 +3597,7 @@ declare namespace LocalJSX {
         /**
           * @deprecated This event should not be used anymore. Use icSearchBarFocus instead.
          */
-        "onIcInputFocus"?: (event: IcSearchBarCustomEvent<IcValueEventDetail1>) => void;
+        "onIcInputFocus"?: (event: IcSearchBarCustomEvent<IcValueEventDetail>) => void;
         /**
           * Emitted when the state of the menu changes (i.e. open or close)
          */
@@ -3447,7 +3609,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when the 'retry loading' button is clicked
          */
-        "onIcRetryLoad"?: (event: IcSearchBarCustomEvent<IcValueEventDetail1>) => void;
+        "onIcRetryLoad"?: (event: IcSearchBarCustomEvent<IcValueEventDetail>) => void;
         /**
           * Emitted when blur is invoked from ic-search-bar
          */
@@ -3459,7 +3621,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when the search value has been submitted
          */
-        "onIcSubmitSearch"?: (event: IcSearchBarCustomEvent<IcValueEventDetail1>) => void;
+        "onIcSubmitSearch"?: (event: IcSearchBarCustomEvent<IcValueEventDetail>) => void;
         /**
           * The suggested search options.
          */
@@ -3571,7 +3733,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when the value changes.
          */
-        "onIcChange"?: (event: IcSelectCustomEvent<IcValueEventDetail1>) => void;
+        "onIcChange"?: (event: IcSelectCustomEvent<IcValueEventDetail>) => void;
         /**
           * Emitted when the clear button is clicked.
          */
@@ -3583,7 +3745,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when a keyboard input occurred.
          */
-        "onIcInput"?: (event: IcSelectCustomEvent<IcValueEventDetail1>) => void;
+        "onIcInput"?: (event: IcSelectCustomEvent<IcValueEventDetail>) => void;
         /**
           * Emitted when an option is highlighted within the menu. Highlighting a menu item will also trigger an `icChange/onIcChange` due to the value being updated.
          */
@@ -3591,7 +3753,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when the 'retry loading' button is clicked for a searchable variant.
          */
-        "onIcRetryLoad"?: (event: IcSelectCustomEvent<IcValueEventDetail1>) => void;
+        "onIcRetryLoad"?: (event: IcSelectCustomEvent<IcValueEventDetail>) => void;
         /**
           * The possible selection options.
          */
@@ -3857,11 +4019,11 @@ declare namespace LocalJSX {
         /**
           * The state of autocompletion the browser can apply on the text value.
          */
-        "autocomplete"?: IcAutocompleteTypes1;
+        "autocomplete"?: IcAutocompleteTypes;
         /**
           * The state of autocorrection the browser can apply when the user is entering/editing the text value.
          */
-        "autocorrect"?: IcAutocorrectStates1;
+        "autocorrect"?: IcAutocorrectStates;
         /**
           * The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
          */
@@ -3913,19 +4075,19 @@ declare namespace LocalJSX {
         /**
           * Emitted when input loses focus.
          */
-        "onIcBlur"?: (event: IcTextFieldCustomEvent<IcValueEventDetail1>) => void;
+        "onIcBlur"?: (event: IcTextFieldCustomEvent<IcValueEventDetail>) => void;
         /**
           * Emitted when the value has changed.
          */
-        "onIcChange"?: (event: IcTextFieldCustomEvent<IcValueEventDetail1>) => void;
+        "onIcChange"?: (event: IcTextFieldCustomEvent<IcValueEventDetail>) => void;
         /**
           * Emitted when input gains focus.
          */
-        "onIcFocus"?: (event: IcTextFieldCustomEvent<IcValueEventDetail1>) => void;
+        "onIcFocus"?: (event: IcTextFieldCustomEvent<IcValueEventDetail>) => void;
         /**
           * Emitted when a keyboard input occurred.
          */
-        "onIcInput"?: (event: IcTextFieldCustomEvent<IcValueEventDetail1>) => void;
+        "onIcInput"?: (event: IcTextFieldCustomEvent<IcValueEventDetail>) => void;
         /**
           * Emitted when a keydown event occurred.
          */
@@ -3969,7 +4131,7 @@ declare namespace LocalJSX {
         /**
           * The validation state - e.g. 'error' | 'warning' | 'success'.
          */
-        "validationStatus"?: IcInformationStatusOrEmpty1;
+        "validationStatus"?: IcInformationStatusOrEmpty;
         /**
           * The validation state - e.g. 'error' | 'warning' | 'success'.
          */
@@ -4092,6 +4254,7 @@ declare namespace LocalJSX {
         "ic-classification-banner": IcClassificationBanner;
         "ic-data-entity": IcDataEntity;
         "ic-data-row": IcDataRow;
+        "ic-dialog": IcDialog;
         "ic-divider": IcDivider;
         "ic-footer": IcFooter;
         "ic-footer-link": IcFooterLink;
@@ -4155,6 +4318,7 @@ declare module "@stencil/core" {
             "ic-classification-banner": LocalJSX.IcClassificationBanner & JSXBase.HTMLAttributes<HTMLIcClassificationBannerElement>;
             "ic-data-entity": LocalJSX.IcDataEntity & JSXBase.HTMLAttributes<HTMLIcDataEntityElement>;
             "ic-data-row": LocalJSX.IcDataRow & JSXBase.HTMLAttributes<HTMLIcDataRowElement>;
+            "ic-dialog": LocalJSX.IcDialog & JSXBase.HTMLAttributes<HTMLIcDialogElement>;
             "ic-divider": LocalJSX.IcDivider & JSXBase.HTMLAttributes<HTMLIcDividerElement>;
             "ic-footer": LocalJSX.IcFooter & JSXBase.HTMLAttributes<HTMLIcFooterElement>;
             "ic-footer-link": LocalJSX.IcFooterLink & JSXBase.HTMLAttributes<HTMLIcFooterLinkElement>;

package/dist/types/stencil-public-runtime.d.ts

@@ -133,7 +133,7 @@ export interface ListenOptions {
      */
     passive?: boolean;
 }
-export declare type ListenTargetOptions = 'body' | 'document' | 'window';
+export type ListenTargetOptions = 'body' | 'document' | 'window';
 export interface StateDecorator {
     (): PropertyDecorator;
 }
@@ -214,8 +214,8 @@ export declare const State: StateDecorator;
  * https://stenciljs.com/docs/reactive-data#watch-decorator
  */
 export declare const Watch: WatchDecorator;
-export declare type ResolutionHandler = (elm: HTMLElement) => string | undefined | null;
-export declare type ErrorHandler = (err: any, element?: HTMLElement) => void;
+export type ResolutionHandler = (elm: HTMLElement) => string | undefined | null;
+export type ErrorHandler = (err: any, element?: HTMLElement) => void;
 /**
  * `setMode()` is used for libraries which provide multiple "modes" for styles.
  */
@@ -257,6 +257,15 @@ export declare function getAssetPath(path: string): string;
  * @returns the set path
  */
 export declare function setAssetPath(path: string): string;
+/**
+ * Used to specify a nonce value that corresponds with an application's
+ * [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP).
+ * When set, the nonce will be added to all dynamically created script and style tags at runtime.
+ * Alternatively, the nonce value can be set on a `meta` tag in the DOM head
+ * (<meta name="csp-nonce" content="{ nonce value here }" />) and will result in the same behavior.
+ * @param nonce The value to be used for the nonce attribute.
+ */
+export declare function setNonce(nonce: string): void;
 /**
  * Retrieve a Stencil element for a given reference
  * @param ref the ref to get the Stencil element for
@@ -433,13 +442,57 @@ interface HostAttributes {
     ref?: (el: HTMLElement | null) => void;
     [prop: string]: any;
 }
+/**
+ * Utilities for working with functional Stencil components. An object
+ * conforming to this interface is passed by the Stencil runtime as the third
+ * argument to a functional component, allowing component authors to work with
+ * features like children.
+ *
+ * The children of a functional component will be passed as the second
+ * argument, so a functional component which uses these utils to transform its
+ * children might look like the following:
+ *
+ * ```ts
+ * export const AddClass: FunctionalComponent = (_, children, utils) => (
+ *  utils.map(children, child => ({
+ *    ...child,
+ *    vattrs: {
+ *      ...child.vattrs,
+ *      class: `${child.vattrs.class} add-class`
+ *    }
+ *  }))
+ * );
+ * ```
+ *
+ * For more see the Stencil documentation, here:
+ * https://stenciljs.com/docs/functional-components
+ */
 export interface FunctionalUtilities {
+    /**
+     * Utility for reading the children of a functional component at runtime.
+     * Since the Stencil runtime uses a different interface for children it is
+     * not recommendeded to read the children directly, and is preferable to use
+     * this utility to, for instance, perform a side effect for each child.
+     */
     forEach: (children: VNode[], cb: (vnode: ChildNode, index: number, array: ChildNode[]) => void) => void;
+    /**
+     * Utility for transforming the children of a functional component. Given an
+     * array of children and a callback this will return a list of the results of
+     * passing each child to the supplied callback.
+     */
     map: (children: VNode[], cb: (vnode: ChildNode, index: number, array: ChildNode[]) => ChildNode) => VNode[];
 }
 export interface FunctionalComponent<T = {}> {
     (props: T, children: VNode[], utils: FunctionalUtilities): VNode | VNode[];
 }
+/**
+ * A Child VDOM node
+ *
+ * This has most of the same properties as {@link VNode} but friendlier names
+ * (i.e. `vtag` instead of `$tag$`, `vchildren` instead of `$children$`) in
+ * order to provide a friendlier public interface for users of the
+ * {@link FunctionalUtilities}).
+ */
 export interface ChildNode {
     vtag?: string | number | Function;
     vkey?: string | number;
@@ -486,6 +539,9 @@ export declare function h(sel: any, children: Array<VNode | undefined | null>):
 export declare function h(sel: any, data: VNodeData | null, text: string): VNode;
 export declare function h(sel: any, data: VNodeData | null, children: Array<VNode | undefined | null>): VNode;
 export declare function h(sel: any, data: VNodeData | null, children: VNode): VNode;
+/**
+ * A virtual DOM node
+ */
 export interface VNode {
     $flags$: number;
     $tag$: string | number | Function;
@@ -756,6 +812,7 @@ export declare namespace JSXBase {
         datetime?: string;
     }
     interface DialogHTMLAttributes<T> extends HTMLAttributes<T> {
+        onCancel?: (event: Event) => void;
         onClose?: (event: Event) => void;
         open?: boolean;
         returnValue?: string;
@@ -836,8 +893,8 @@ export declare namespace JSXBase {
         accept?: string;
         allowdirs?: boolean;
         alt?: string;
-        autoCapitalize?: any;
-        autocapitalize?: any;
+        autoCapitalize?: string;
+        autocapitalize?: string;
         autoComplete?: string;
         autocomplete?: string;
         autoFocus?: boolean;
@@ -1161,8 +1218,8 @@ export declare namespace JSXBase {
         resource?: string;
         typeof?: string;
         vocab?: string;
-        autoCapitalize?: any;
-        autocapitalize?: any;
+        autoCapitalize?: string;
+        autocapitalize?: string;
         autoCorrect?: string;
         autocorrect?: string;
         autoSave?: string;
@@ -1453,12 +1510,12 @@ export declare namespace JSXBase {
         onCutCapture?: (event: ClipboardEvent) => void;
         onPaste?: (event: ClipboardEvent) => void;
         onPasteCapture?: (event: ClipboardEvent) => void;
-        onCompositionEnd?: (event: CompositionEvent) => void;
-        onCompositionEndCapture?: (event: CompositionEvent) => void;
-        onCompositionStart?: (event: CompositionEvent) => void;
-        onCompositionStartCapture?: (event: CompositionEvent) => void;
-        onCompositionUpdate?: (event: CompositionEvent) => void;
-        onCompositionUpdateCapture?: (event: CompositionEvent) => void;
+        onCompositionend?: (event: CompositionEvent) => void;
+        onCompositionendCapture?: (event: CompositionEvent) => void;
+        onCompositionstart?: (event: CompositionEvent) => void;
+        onCompositionstartCapture?: (event: CompositionEvent) => void;
+        onCompositionupdate?: (event: CompositionEvent) => void;
+        onCompositionupdateCapture?: (event: CompositionEvent) => void;
         onFocus?: (event: FocusEvent) => void;
         onFocusCapture?: (event: FocusEvent) => void;
         onFocusin?: (event: FocusEvent) => void;
@@ -1469,8 +1526,8 @@ export declare namespace JSXBase {
         onBlurCapture?: (event: FocusEvent) => void;
         onChange?: (event: Event) => void;
         onChangeCapture?: (event: Event) => void;
-        onInput?: (event: Event) => void;
-        onInputCapture?: (event: Event) => void;
+        onInput?: (event: InputEvent) => void;
+        onInputCapture?: (event: InputEvent) => void;
         onReset?: (event: Event) => void;
         onResetCapture?: (event: Event) => void;
         onSubmit?: (event: Event) => void;

package/dist/types/testspec.setup.d.ts

@@ -1,4 +1,15 @@
+type TestKeyboardEvent = {
+  key: string;
+  preventDefault: () => void;
+  stopImmediatePropagation: () => void;
+  shiftKey: boolean;
+  target: {
+    id: string;
+  };
+};
 export declare const waitForTimeout: (ms: number) => Promise<void>;
 export declare const mockDeviceSize: (size: number) => void;
 export declare const waitForNavGroupLoad: () => Promise<void>;
 export declare const resizeTo: (windowObj: typeof window, width: number, height: number) => void;
+export declare const testKeyboardEvent: (keyboardKey: string) => TestKeyboardEvent;
+export {};

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

@@ -120,3 +120,4 @@ export declare const getForm: (el: HTMLElement) => HTMLFormElement | null;
 export declare const addFormResetListener: (el: HTMLElement, callbackFn: IcCallbackFunctionNoReturn) => void;
 export declare const removeFormResetListener: (el: HTMLElement, callbackFn: IcCallbackFunctionNoReturn) => void;
 export declare const pxToRem: (px: string, base?: number) => string;
+export declare const removeDisabledFalse: (disabled: boolean, element: HTMLElement) => void;