@ukic/canary-web-components 3.0.0-canary.34 → 3.0.0-canary.35

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

@@ -0,0 +1,74 @@
+import { IcBadgePositions, IcBadgeTypes, IcBadgeVariants } from "./ic-badge.types";
+import { IcSizes, IcColor, IcThemeMode } from "../../utils/types";
+/**
+ * @slot badge-icon - Icon will be rendered inside the badge if type is set to icon.
+ */
+export declare class Badge {
+    private ariaLabel;
+    private foregroundColour;
+    private parentAriaLabel;
+    private initialPosition;
+    el: HTMLIcBadgeElement;
+    /**
+     * The accessible label of the badge component to provide context for screen reader users.
+     */
+    accessibleLabel?: string;
+    accessibleLabelHandler(): void;
+    /**
+     * The custom badge colour. This will only style the badge component if variant="custom".
+     * Can be a hex value e.g. "#ff0000", RGB e.g. "rgb(255, 0, 0)", or RGBA e.g. "rgba(255, 0, 0, 1)".
+     */
+    customColor?: IcColor;
+    customColorHandler(): void;
+    /**
+     * The maximum number shown on the badge appended with a +.
+     * This will only be displayed if type="text" and label is not empty.
+     */
+    maxNumber?: number;
+    /**
+     * The positioning of the badge in reference to the parent element.
+     */
+    position?: IcBadgePositions;
+    /**
+     * The size of the badge to be displayed.
+     */
+    size?: IcSizes;
+    /**
+     * The text displayed in the badge. This will only be displayed if type="text".
+     */
+    label?: string;
+    /**
+     * Sets the theme color to the dark or light theme color. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme?: IcThemeMode;
+    /**
+     * The type of badge to be displayed.
+     */
+    type?: IcBadgeTypes;
+    /**
+     * The variant of the badge to be displayed.
+     */
+    variant?: IcBadgeVariants;
+    variantHandler(): void;
+    /**
+     * If `true`, the badge will be displayed.
+     */
+    visible?: boolean;
+    visibleHandler(): void;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentWillRender(): void;
+    navBarMenuOpenHandler(): void;
+    navBarMenuCloseHandler(): void;
+    private setBadgeColour;
+    private getLabel;
+    private setAccessibleLabel;
+    private setPositionInTopNavigation;
+    private setPositionInSideNavigation;
+    private isInTopNav;
+    private isInSideNav;
+    private isInMobileMode;
+    private isInNavigationItem;
+    private isAccessibleLabelDefined;
+    render(): any;
+}

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

@@ -0,0 +1,4 @@
+import { IcStatusVariants } from "../../utils/types";
+export type IcBadgeTypes = "dot" | "text" | "icon";
+export type IcBadgePositions = "far" | "near" | "inline";
+export type IcBadgeVariants = IcStatusVariants | "light" | "custom";

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

@@ -0,0 +1,210 @@
+import { EventEmitter } from "../../../../../../../../../../../../stencil-public-runtime";
+import { IcButtonTypes, IcButtonVariants } from "./ic-button.types";
+import { IcSizes, IcBrand, IcThemeMode, IcButtonTooltipPlacement } from "../../utils/types";
+/**
+ * @slot left-icon - Content will be placed to the left of the button label.
+ * @slot right-icon - Content will be placed to the right of the button label.
+ * @slot top-icon - Content will be placed above the button label.
+ * @slot badge - Badge component overlaying the top right of the button.
+ * @slot router-item - Handle routing by nesting your routes in this slot. Setting loading to true will have no impact on this slot.
+ */
+export declare class Button {
+    private buttonEl?;
+    private buttonIdNum;
+    private hasTooltip;
+    private id;
+    private inheritedAttributes;
+    private describedbyEl;
+    private describedById?;
+    private mutationObserver;
+    private hostMutationObserver;
+    private routerSlot;
+    el: HTMLIcButtonElement;
+    ariaLabel: string;
+    describedbyNode: Node | null;
+    watchDescribedbyNodeHandler(): void;
+    title: string;
+    /**
+     * If `fileUpload` is set to `true`, this is the accepted list of file types.
+     */
+    accept: string;
+    /**
+     * @internal Used to identify any related child component
+     */
+    ariaControlsId?: string | boolean;
+    /**
+     * @internal Used to identify any related child component
+     */
+    ariaOwnsId?: string | boolean;
+    /**
+     * If `true`, the button will be in disabled state.
+     */
+    disabled: boolean;
+    watchDisabledHandler(): void;
+    /**
+     * If `true`, the ic-tooltip which is shown for icon variant will be disabled. Title or aria-label must be set if this prop is not applied.
+     */
+    disableTooltip: boolean;
+    /**
+     * If `true`, the user can save the linked URL instead of navigating to it.
+     */
+    download: string | boolean;
+    /**
+     * If `true`, the button will show a dropdown icon.
+     */
+    dropdown: boolean;
+    /**
+     * If `true`, the aria-expanded value will be set to true. This is only applied if the dropdown prop is also true.
+     */
+    dropdownExpanded: boolean;
+    /**
+     * If `true`, when the button is clicked the native file explorer will be launched.
+     */
+    fileUpload: boolean;
+    /**
+     * The name of the control for the file input, which is submitted with the form data.
+     */
+    fileInputName: string;
+    /**
+     * The <form> element to associate the button with.
+     */
+    form?: string;
+    /**
+     * The URL that processes the information submitted by the button. It overrides the action attribute of the button's form owner. Does nothing if there is no form owner.
+     */
+    formaction?: string;
+    /**
+     * The way the submitted form data is encoded.
+     */
+    formenctype?: string;
+    /**
+     * The HTTP method used to submit the form.
+     */
+    formmethod?: string;
+    /**
+     * If `true`, the form will not be validated when submitted.
+     */
+    formnovalidate?: boolean;
+    /**
+     * The place to display the response from submitting the form. It overrides the target attribute of the button's form owner.
+     */
+    formtarget?: string;
+    /**
+     * If `true`, the button will fill the width of the container.
+     */
+    fullWidth: boolean;
+    /**
+     * The URL that the link points to. This will render the button as an "a" tag.
+     */
+    href?: string;
+    /**
+     * The human language of the linked URL.
+     */
+    hreflang?: string;
+    /**
+     * If `true`, the button will be in loading state.
+     */
+    loading: boolean;
+    /**
+     * If `true`, the button will display as monochromatic in either `light` or `dark` theme.
+     */
+    monochrome: boolean;
+    /**
+     * If `fileUpload` is set to `true`, this boolean determines whether multiple files are accepted.
+     */
+    multiple: boolean;
+    /**
+     * How much of the referrer to send when following the link.
+     */
+    referrerpolicy?: ReferrerPolicy;
+    /**
+     * The relationship of the linked URL as space-separated link types.
+     */
+    rel?: string;
+    /**
+     * The list of the files that have been selected by a user.
+     */
+    selectedFiles?: FileList;
+    /**
+     * The size of the button to be displayed.
+     */
+    size: IcSizes;
+    /**
+     * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
+     */
+    target?: string;
+    /**
+     * Sets the theme color to the dark or light theme color. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme: IcThemeMode;
+    /**
+     * Setting to `true` can help in situations where tooltip content is clipped by a parent element.
+     */
+    tooltipFixedPositioning: boolean;
+    /**
+     * The position of the tooltip in relation to the button.
+     */
+    tooltipPlacement: IcButtonTooltipPlacement;
+    /**
+     * If `true`, the secondary & tertiary variants of button will have a transparent background when not hovered, pressed or loading.
+     */
+    transparentBackground: boolean;
+    /**
+     * The type of the button.
+     */
+    type: IcButtonTypes;
+    /**
+     * The variant of the button to be displayed.
+     */
+    variant: IcButtonVariants;
+    watchVariantHandler(newVariant: IcButtonVariants): void;
+    /**
+     * Emitted when button has blur
+     */
+    icBlur: EventEmitter<void>;
+    /**
+     * If `fileUpload` is set to `true`, this will be emitted when a file is selected in the native explorer.
+     */
+    icFileSelection: EventEmitter<FileList>;
+    /**
+     * Emitted when button has focus
+     */
+    icFocus: EventEmitter<void>;
+    disconnectedCallback(): void;
+    componentWillUpdate(): void;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentWillRender(): void;
+    handleHostClick(event: Event): void;
+    brandChangeHandler({ detail }: CustomEvent<IcBrand>): void;
+    /**
+     * Sets focus on the native `button`.
+     */
+    setFocus(): Promise<void>;
+    private closeButtonTooltip;
+    private getSlottedIcon;
+    private hasRouterSlot;
+    private handleClick;
+    private handleKeyDown;
+    private onFocus;
+    private onBlur;
+    private updateTheme;
+    /**
+     * Creates/updates clone of aria-describedby element node tree in shadow dom
+     * Required due to ids being scoped to the shadow dom
+     */
+    private updateAriaDescribedbyClone;
+    /**
+     * Triggered when light dom aria-describedby element updates
+     */
+    private mutationCallback;
+    /**
+     * Triggered when attributes of host element change
+     * @param mutationList the list of changes made to the host element
+     */
+    private hostMutationCallback;
+    private setHasTooltip;
+    private isIconVariant;
+    private arrangeRouterItem;
+    render(): any;
+}

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

@@ -0,0 +1,2 @@
+export type IcButtonTypes = "reset" | "submit" | "button";
+export type IcButtonVariants = "primary" | "secondary" | "tertiary" | "destructive" | "icon" | "icon-primary" | "icon-secondary" | "icon-tertiary" | "icon-destructive";

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

@@ -0,0 +1,90 @@
+import { EventEmitter } from "../../../../../../../../../../../../stencil-public-runtime";
+import { IcAdditionalFieldTypes, IcSizes, IcThemeMode } from "../../utils/types";
+/**
+ * @slot additional-field - Content to be displayed alongside a checkbox.
+ * @slot label - Label for the checkbox.
+ */
+export declare class Checkbox {
+    private additionalFieldContainer?;
+    private checkboxEl?;
+    private labelSlot;
+    el: HTMLIcCheckboxElement;
+    /**
+     * The style of additionalField that will be displayed if used.
+     */
+    additionalFieldDisplay: IcAdditionalFieldTypes;
+    /**
+     * If `true`, the checkbox will be set to the checked state. This is only the initial state and will be updated to unchecked if the checkbox is clicked.
+     */
+    checked: boolean;
+    initiallyChecked: boolean;
+    /**
+     * If `true`, the checkbox will be set to the disabled state.
+     */
+    disabled: boolean;
+    watchDisabledHandler(): void;
+    /**
+     * The text to be displayed when dynamic.
+     */
+    dynamicText: string;
+    /**
+     * The <form> element to associate the checkbox with.
+     */
+    form?: string;
+    /**
+     * The group label for the checkbox.
+     */
+    groupLabel?: string;
+    /**
+     * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
+     */
+    hideLabel: boolean;
+    /**
+     * If `true`, the indeterminate state will be displayed when checked.
+     */
+    indeterminate: boolean;
+    displayIndeterminate: boolean;
+    watchIndeterminateHandler(): void;
+    /**
+     * The label for the checkbox.
+     */
+    label: string;
+    /**
+     * The name for the checkbox. If not set when used in a checkbox group, the name will be based on the group name.
+     */
+    name?: string;
+    /**
+     * If `true`, the checkbox will behave like a native checkbox where the `indeterminate` prop sets the indeterminate visual styling, independent of the `checked` state.
+     */
+    nativeIndeterminateBehaviour: boolean;
+    /**
+     * The size of the checkbox to be displayed. This does not affect the font size of the label. If a checkbox is contained in a checkbox group, this will override the size set on checkbox group.
+     */
+    size?: IcSizes;
+    /**
+     * Sets the theme color to the dark or light theme color. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme: IcThemeMode;
+    /**
+     * The value for the checkbox.
+     */
+    value: string;
+    /**
+     * Emitted when a checkbox has been checked.
+     */
+    icCheck: EventEmitter<void>;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentDidRender(): void;
+    disconnectedCallback(): void;
+    /**
+     * Sets focus on the checkbox.
+     */
+    setFocus(): Promise<void>;
+    private getCheckboxGroupId;
+    private hasLabelSlot;
+    private arrangeLabel;
+    private handleClick;
+    private handleFormReset;
+    render(): any;
+}

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

@@ -0,0 +1,75 @@
+import { EventEmitter } from "../../../../../../../../../../../../stencil-public-runtime";
+import { IcBrandForegroundNoDefault, IcColor, IcEmphasisType, IcSizes, IcThemeMode } from "../../utils/types";
+/**
+ * @slot icon - Content will be rendered at the start of the chip.
+ * @slot badge - Badge component overlaying the top right of the chip.
+ */
+export declare class Chip {
+    private buttonEl?;
+    private hostMutationObserver?;
+    el: HTMLIcChipElement;
+    foregroundColor: IcBrandForegroundNoDefault | null;
+    hovered: boolean;
+    visible: boolean;
+    /**
+     * The custom chip colour. This will override 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)".
+     */
+    customColor?: IcColor;
+    customColorHandler(): void;
+    /**
+     * If `true`, the chip will appear disabled.
+     */
+    disabled: boolean;
+    watchDisabledHandler(): void;
+    /**
+     * If `true`, the chip will have a close button at the end to dismiss it.
+     */
+    dismissible: boolean;
+    /**
+     * The text in the dismiss button tooltip and aria label. Makes the user aware of the action resulting from clicking the 'Dismiss chip' button.
+     */
+    dismissLabel: string;
+    /**
+     * Specify whether the chip fills the full width of the container.
+     * If `true`, this overrides the --input-width CSS variable.
+     */
+    fullWidth: boolean;
+    /**
+     * The text rendered within the chip.
+     */
+    label: string;
+    /**
+     * The size of the chip.
+     */
+    size: IcSizes;
+    /**
+     * Sets the chip to the dark or light theme colors. "inherit" will set the color based on the system settings or ic-theme component.
+     * Setting the "customColor" prop will override this.
+     */
+    theme: IcThemeMode;
+    /**
+     * If `true`, the outlined variant of chip will have a transparent background rather than the theme defined color.
+     */
+    transparentBackground: boolean;
+    /**
+     * The emphasis of the chip.
+     */
+    variant: IcEmphasisType;
+    /**
+     * Is emitted when the user dismisses the chip.
+     */
+    icDismiss: EventEmitter<void>;
+    disconnectedCallback(): void;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    handleClick(): void;
+    /**
+     * Sets focus on the chip.
+     */
+    setFocus(): Promise<void>;
+    private dismissAction;
+    private mouseEnterHandler;
+    private mouseLeaveHandler;
+    render(): any;
+}

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

@@ -0,0 +1,44 @@
+import { IcEmptyStateAlignment } from "./ic-empty-state.types";
+import { IcSizes, IcThemeMode } from "../../utils/types";
+/**
+ * @slot image - Content is placed at the top above all other content.
+ * @slot actions - Content is placed at the bottom below all other content.
+ * @slot heading - Content will be rendered in place of the heading prop.
+ * @slot subheading - Content will be rendered in place of the subheading prop.
+ * @slot body - Content will be rendered in place of the body prop.
+ */
+export declare class EmptyState {
+    private hostMutationObserver;
+    el: HTMLIcEmptyStateElement;
+    /**
+     * The alignment of the empty state container.
+     */
+    aligned?: IcEmptyStateAlignment;
+    /**
+     * The body text rendered in the empty state container.
+     */
+    body?: string;
+    /**
+     * The number of lines of body text to display before truncating.
+     */
+    maxLines?: number;
+    /**
+     * The title rendered in the empty state container.
+     */
+    heading?: string;
+    /**
+     * The size of the image or icon used in the image slot.
+     */
+    imageSize?: IcSizes;
+    /**
+     * The subtitle rendered in the empty state container.
+     */
+    subheading?: string;
+    /**
+     * Sets the theme color to the dark or light theme color. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme?: IcThemeMode;
+    disconnectedCallback(): void;
+    componentDidLoad(): void;
+    render(): any;
+}

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

@@ -0,0 +1 @@
+export type IcEmptyStateAlignment = "left" | "center" | "right";

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

@@ -0,0 +1,40 @@
+import { IcInformationStatusOrEmpty, IcSizes } from "../../utils/types";
+/**
+ * @slot left-icon - Content will be placed to the left of the input.
+ */
+export declare class InputComponentContainer {
+    private hostMutationObserver;
+    el: HTMLIcInputComponentContainerElement;
+    /**
+     *  If `true`, the disabled state will be set.
+     */
+    disabled?: boolean;
+    watchDisabledHandler(): void;
+    /**
+     *  If `true`, the input component container will fill the width of the container it is in.
+     */
+    fullWidth?: boolean;
+    /**
+     *  If `true`, the input component container will allow for multiple lines.
+     */
+    multiLine?: boolean;
+    /**
+     *  If `true`, the readonly state will be set.
+     */
+    readonly?: boolean;
+    /**
+     * The size of the input component container component.
+     */
+    size?: IcSizes;
+    /**
+     *  If `true`, the validation will display inline.
+     */
+    validationInline?: boolean;
+    /**
+     * The validation status of the input component container - e.g. 'error' | 'warning' | 'success'.
+     */
+    validationStatus?: IcInformationStatusOrEmpty;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    render(): any;
+}

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

@@ -0,0 +1,11 @@
+export declare class InputContainer {
+    /**
+     * If `true`, the disabled state will be set.
+     */
+    disabled?: boolean;
+    /**
+     * If `true`, the readonly state will be set.
+     */
+    readonly?: boolean;
+    render(): any;
+}

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

@@ -0,0 +1,42 @@
+export declare class InputLabel {
+    el: HTMLIcInputLabelElement;
+    /**
+     * If `true`, the disabled state will be set.
+     */
+    disabled?: boolean;
+    /**
+     * The ID of the form element the label is bound to.
+     */
+    for?: string;
+    /**
+     * The helper text that will be displayed.
+     */
+    helperText: string;
+    /**
+     * The label will be visually hidden.
+     */
+    hideLabel: boolean;
+    /**
+     * The text content of the label.
+     */
+    label: string;
+    /**
+     * If `true`, the readonly state will be set.
+     */
+    readonly: boolean;
+    /**
+     * If `true`, the input label will require a value.
+     */
+    required: boolean;
+    /**
+     * The status of the label - e.g. 'error'.
+     */
+    status: "error" | "";
+    /**
+     * @internal If `true`, wraps label text in label tag
+     */
+    useLabelTag: boolean;
+    componentDidLoad(): void;
+    private isHelperTextSlotUsed;
+    render(): any;
+}

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

@@ -0,0 +1,32 @@
+import { IcAriaLive, IcInformationStatusOrEmpty } from "../../utils/types";
+/**
+ * @slot validation-message-adornment - Content will be placed to the right of the validation message.
+ * @slot validation-message - Content will be placed as the validation message.
+ */
+export declare class InputValidation {
+    private messageEl;
+    el: HTMLIcInputValidationElement;
+    /**
+     *  The ARIA live mode to apply to the message.
+     */
+    ariaLiveMode?: IcAriaLive;
+    /**
+     * The ID of the form element the validation is bound to.
+     */
+    for?: string;
+    /**
+     *  If `true`, the input validation will fill the width of the container.
+     */
+    fullWidth?: boolean;
+    /**
+     * The validation message to display.
+     */
+    message?: string;
+    watchMessageHandler(newValue: string): void;
+    /**
+     * The status of the validation - e.g. 'error' | 'warning' | 'success'.
+     */
+    status?: IcInformationStatusOrEmpty;
+    componentDidLoad(): void;
+    render(): any;
+}