@ukic/canary-web-components 3.0.0-canary.21 → 3.0.0-canary.23

package/dist/types/components/ic-time-input/ic-time-input.d.ts

@@ -0,0 +1,229 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { IcDisableTimeSelection, IcInformationStatusOrEmpty, IcSizes, IcThemeMode, IcTimeFormat } from "../../utils/types";
+/**
+ * @slot helper-text - Content is set as the helper text for the time input.
+ */
+export declare class TimeInput {
+    private DEFAULT_TIME_FORMAT;
+    private ARIA_INVALID;
+    private ARIA_LABEL;
+    private ARIA_LABELLED_BY;
+    private assistiveHintId;
+    private hourInputEl?;
+    private minuteInputEl?;
+    private secondInputEl?;
+    private defaultHelperText;
+    private EVENT_OBJECT_STRING;
+    private FIT_TO_VALUE;
+    private initialValue;
+    private inputCompContainerEl;
+    private inputsInOrder;
+    private isValidHour;
+    private isValidMinute;
+    private isValidSecond;
+    private isValidTime;
+    private isTimeSetFromKeyboardEvent;
+    private preventAutoFormatting;
+    private preventHourInput;
+    private preventMinuteInput;
+    private preventSecondInput;
+    private previousSelectedTime;
+    private selectedTime;
+    private selectedTimeInfoEl?;
+    private screenReaderInfoId;
+    private selectedTimeInfoId;
+    private externalSetTime;
+    private clearInput;
+    private maxTime;
+    private minTime;
+    el: HTMLIcTimeInputElement;
+    invalidTimeText: string;
+    clockFocused: boolean;
+    clearButtonFocused: boolean;
+    removeLabelledBy: boolean;
+    hour: string;
+    minute: string;
+    second: string;
+    watchInputHandler(): void;
+    /**
+     * If `true`, the disabled state will be set.
+     */
+    disabled: boolean;
+    watchDisabledHandler(): void;
+    /**
+     * An array of times that will be disabled in the time input. The times can be in any format supported as `timeFormat`, in ISO 8601 time string format (`HH:MM:SS`) or as a JavaScript `Date` object.
+     */
+    disableTimes: IcDisableTimeSelection[];
+    /**
+     * If `true`, every individual input field completed will emit an icChange event.
+     */
+    emitTimePartChange?: boolean;
+    /**
+     * The helper text that will be displayed for additional field guidance. This will default to the text "Use format" along with the `timeFormat` value.
+     */
+    helperText: string | null;
+    /**
+     * If `true`, the helper text will be visually hidden, but still read out by screenreaders.
+     */
+    hideHelperText: boolean;
+    /**
+     * If `true`, the label will be visually hidden, but will still be read out by screen readers.
+     */
+    hideLabel?: boolean;
+    /**
+     * The ID for the input.
+     */
+    inputId: string;
+    /**
+     * The text to display as the validation message when an invalid time is entered.
+     */
+    invalidTimeMessage: string;
+    /**
+     * The label for the time input.
+     */
+    label: string;
+    /**
+     * The latest time that will be allowed. The value can be in any format supported as `timeFormat`, in ISO 8601 time string format (`HH:MM:SS`) or as a JavaScript `Date` object.
+     */
+    max: string | Date;
+    watchMaxHandler(): void;
+    /**
+     * The earliest time that will be allowed. The value can be in any format supported as `timeFormat`, in ISO 8601 time string format (`HH:MM:SS`) or as a JavaScript `Date` object.
+     */
+    min: string | Date;
+    watchMinHandler(): void;
+    /**
+     * The name of the control, which is submitted with the form data.
+     */
+    name: string;
+    /**
+     * If `true`, the input will require a value.
+     */
+    required: boolean;
+    watchRequiredHandler(): void;
+    /**
+     * If `true`, a button which clears the time input when clicked will be displayed.
+     */
+    showClearButton?: boolean;
+    /**
+     * @internal If `true`, a button which displays the clock view when clicked will be displayed.
+     */
+    showClockButton?: boolean;
+    /**
+     * The size of the time input to be displayed.
+     */
+    size: IcSizes;
+    /**
+     * Sets the time picker to the dark or light theme colors. "inherit" will set the color based on the system settings or ic-theme component.
+     */
+    theme?: IcThemeMode;
+    /**
+     * The format in which the time will be displayed.
+     */
+    timeFormat: IcTimeFormat;
+    /**
+     * The time period format: "12" for 12-hour, "24" for 24-hour. Defaults to "24".
+     */
+    timePeriod: "12" | "24";
+    /**
+     * The value of the time input. The value can be in any format supported as `timeFormat`, in ISO 8601 time string format (`HH:MM:SS`) or as a JavaScript `Date` object.
+     */
+    value?: string | Date | null | undefined;
+    /**
+     * The validation status - e.g. 'error' | 'warning' | 'success'. This will override the built-in time validation.
+     */
+    validationStatus: IcInformationStatusOrEmpty;
+    /**
+     * The text to display as the validation message. This will override the built-in time validation.
+     */
+    validationText?: string;
+    /**
+     * @internal Emitted when the clock is opened.
+     */
+    clockButtonClicked: EventEmitter<{
+        value: Date | null;
+    }>;
+    /**
+     * Emitted when the input loses focus.
+     */
+    icBlur: EventEmitter<{
+        value: Date | null;
+    }>;
+    /**
+     * Emitted when the value has changed.
+     */
+    icChange: EventEmitter<{
+        value: Date | null;
+        timeObject: {
+            hour: string | null;
+            minute: string | null;
+            second: string | null;
+        };
+    }>;
+    /**
+     * Emitted when the input gains focus.
+     */
+    icFocus: EventEmitter<{
+        value: Date | null;
+    }>;
+    disconnectedCallback(): void;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentWillUpdate(): void;
+    componentDidRender(): void;
+    /**
+     * Returns the value as a Date object
+     * @returns Date
+     */
+    getTime(): Promise<Date | null>;
+    /**
+     * @internal Used to enable other components to invoke an IcChange event from the input.
+     */
+    triggerIcChange(t: Date | null): Promise<void>;
+    private setInputPasteValue;
+    private parseTime;
+    private isHHMMFormat;
+    private isKeyboardOrEvent;
+    private setTimeValidity;
+    private setInputValue;
+    private setPreventInput;
+    private setValidationMessage;
+    private formatTime;
+    private handleInput;
+    private handleKeyDown;
+    private handleFocus;
+    private handleBlur;
+    private handleUpDownArrowKeyPress;
+    private handleTimeChange;
+    private setValueAndEmitChange;
+    private emitIcChange;
+    private setTime;
+    private setAriaInvalid;
+    private handleClear;
+    private notifyScreenReaderSelectedTime;
+    private setFitToValueStyling;
+    private handleHostBlur;
+    private handleHostFocus;
+    private handleFormReset;
+    private preventInput;
+    private moveToNextInput;
+    private moveToPreviousInput;
+    private autocompleteInput;
+    private convertToTime;
+    private setInputsInOrder;
+    private updateInputValues;
+    private removeAriaLabelledBy;
+    private setAriaLabelledBy;
+    private getInputsInOrder;
+    private getDescOfInputsOrder;
+    private getScreenReaderInfo;
+    private notifyScreenReader;
+    private handlePaste;
+    private handleClearFocus;
+    private handleClearBlur;
+    private handleClockFocus;
+    private handleClockBlur;
+    private isPastedStringTimeValid;
+    private setPastedValueAndValidation;
+    render(): any;
+}

package/dist/types/components/ic-time-input/ic-time-input.stories.d.ts

@@ -0,0 +1,121 @@
+declare namespace _default {
+    let title: string;
+    let component: string;
+    namespace parameters {
+        namespace componentAPI {
+            export { readme as data };
+        }
+    }
+}
+export default _default;
+export namespace Default {
+    function render(): import("lit-html").TemplateResult<1>;
+    let name: string;
+}
+export namespace IcChangeEvent {
+    export function render_1(): import("lit-html").TemplateResult<1>;
+    export { render_1 as render };
+    let name_1: string;
+    export { name_1 as name };
+}
+export namespace WithValue {
+    export function render_2(): import("lit-html").TemplateResult<1>;
+    export { render_2 as render };
+    let name_2: string;
+    export { name_2 as name };
+}
+export namespace DateObject {
+    export function render_3(): import("lit-html").TemplateResult<1>;
+    export { render_3 as render };
+    let name_3: string;
+    export { name_3 as name };
+}
+export namespace ZuluTime {
+    export function render_4(): import("lit-html").TemplateResult<1>;
+    export { render_4 as render };
+    let name_4: string;
+    export { name_4 as name };
+}
+export namespace Required {
+    export function render_5(): import("lit-html").TemplateResult<1>;
+    export { render_5 as render };
+    let name_5: string;
+    export { name_5 as name };
+}
+export namespace HideLabel {
+    export function render_6(): import("lit-html").TemplateResult<1>;
+    export { render_6 as render };
+    let name_6: string;
+    export { name_6 as name };
+}
+export namespace Disabled {
+    export function render_7(): import("lit-html").TemplateResult<1>;
+    export { render_7 as render };
+}
+export namespace Sizes {
+    export function render_8(): import("lit-html").TemplateResult<1>;
+    export { render_8 as render };
+    let name_7: string;
+    export { name_7 as name };
+}
+export namespace CustomHelperText {
+    export function render_9(): import("lit-html").TemplateResult<1>;
+    export { render_9 as render };
+    let name_8: string;
+    export { name_8 as name };
+}
+export namespace HideHelperText {
+    export function render_10(): import("lit-html").TemplateResult<1>;
+    export { render_10 as render };
+    let name_9: string;
+    export { name_9 as name };
+}
+export namespace Validation {
+    export function render_11(): import("lit-html").TemplateResult<1>;
+    export { render_11 as render };
+    let name_10: string;
+    export { name_10 as name };
+}
+export namespace IcChangeEmitTimePartChanges {
+    export function render_12(): import("lit-html").TemplateResult<1>;
+    export { render_12 as render };
+    let name_11: string;
+    export { name_11 as name };
+}
+export namespace TimePeriod {
+    export function render_13(): import("lit-html").TemplateResult<1>;
+    export { render_13 as render };
+    let name_12: string;
+    export { name_12 as name };
+}
+export namespace HHMM {
+    export function render_14(): import("lit-html").TemplateResult<1>;
+    export { render_14 as render };
+    let name_13: string;
+    export { name_13 as name };
+}
+export namespace MinTime {
+    export function render_15(): import("lit-html").TemplateResult<1>;
+    export { render_15 as render };
+    let name_14: string;
+    export { name_14 as name };
+}
+export namespace MaxTime {
+    export function render_16(): import("lit-html").TemplateResult<1>;
+    export { render_16 as render };
+    let name_15: string;
+    export { name_15 as name };
+}
+export namespace DisableTimes {
+    export function render_17(): import("lit-html").TemplateResult<1>;
+    export { render_17 as render };
+    let name_16: string;
+    export { name_16 as name };
+}
+export namespace WithClearingValue {
+    export function render_18(): import("lit-html").TemplateResult<1>;
+    export { render_18 as render };
+    let name_17: string;
+    export { name_17 as name };
+}
+import readme from "./readme.md";

package/dist/types/components/ic-time-input/test/helpers/ic-time-input.d.ts

@@ -0,0 +1,23 @@
+import { SpecPage } from "@stencil/core/testing";
+interface EventType {
+    inputType: string;
+    target: HTMLInputElement;
+    data: string;
+}
+interface KeyboardEvent {
+    key: string;
+    preventDefault: () => void;
+}
+interface TimeInputType {
+    page: SpecPage;
+    component: HTMLIcTimeInputElement;
+    componentInstance: any;
+    hourInput: HTMLInputElement;
+    minuteInput: HTMLInputElement;
+    secondInput: HTMLInputElement;
+}
+export declare const createTimeInput: (format?: string) => Promise<SpecPage>;
+export declare const handleEvent: (input: HTMLInputElement) => EventType;
+export declare const keyboardEvent: (keyboardKey: string) => KeyboardEvent;
+export declare const createTimeInputEnv: (format?: string) => Promise<TimeInputType>;
+export {};

package/dist/types/components/ic-tree-item/ic-tree-item.d.ts

@@ -115,5 +115,7 @@ export declare class TreeItem {
     private removeTreeItemTruncation;
     private hasRouterSlot;
     private handleDisplayTooltip;
+    private setChildTreeItems;
+    private hostMutationCallback;
     render(): any;
 }

package/dist/types/components/ic-tree-view/ic-tree-view.d.ts

@@ -52,6 +52,8 @@ export declare class TreeView {
     componentDidRender(): void;
     componentDidLoad(): void;
     handleTreeItemSelected(event: CustomEvent): void;
+    private hostMutationCallback;
+    private createMutationObserver;
     private runResizeObserver;
     private removeTruncation;
     private handleKeyDown;
@@ -59,7 +61,6 @@ export declare class TreeView {
     private linkTreeItems;
     private setTreeItems;
     private getAllTreeItems;
-    private addSlotChangeListener;
     private truncateTreeViewHeading;
     private removeHeadingTruncation;
     private isHeadingDefined;