@haiilo/catalyst 10.2.0 → 10.3.1

package/dist/types/components/cat-time/cat-time.d.ts

@@ -0,0 +1,168 @@
+import { Placement } from '@floating-ui/dom';
+import { EventEmitter } from '../../stencil-public-runtime';
+import { ErrorMap } from '../cat-form-hint/cat-form-hint';
+export declare class CatTime {
+    private readonly language;
+    private readonly locale;
+    private input?;
+    hostElement: HTMLElement;
+    hasSlottedLabel: boolean;
+    hasSlottedHint: boolean;
+    selectionTime: Date | null;
+    isAm: boolean;
+    /**
+     * Whether the label need a marker to shown if the input is required or optional.
+     */
+    requiredMarker?: 'none' | 'required' | 'optional' | 'none!' | 'optional!' | 'required!';
+    /**
+     * Whether the label is on top or left.
+     */
+    horizontal: boolean;
+    /**
+     * Hint for form autofill feature.
+     */
+    autoComplete?: string;
+    /**
+     * Whether the input should show a clear button.
+     */
+    clearable: boolean;
+    /**
+     * Whether the input is disabled.
+     */
+    disabled: boolean;
+    /**
+     * Optional hint text(s) to be displayed with the input.
+     */
+    hint?: string | string[];
+    /**
+     * The name of an icon to be displayed in the input.
+     */
+    icon?: string;
+    /**
+     * Display the icon on the right.
+     */
+    iconRight: boolean;
+    /**
+     * A unique identifier for the input.
+     */
+    identifier?: string;
+    /**
+     * The label for the input.
+     */
+    label: string;
+    /**
+     * Visually hide the label, but still show it to assistive technologies like screen readers.
+     */
+    labelHidden: boolean;
+    /**
+     * A maximum time value given in HH:mm format.
+     */
+    max?: string;
+    /**
+     * A minimum value given in HH:mm format.
+     */
+    min?: string;
+    /**
+     * The name of the form control. Submitted with the form as part of a name/value pair.
+     */
+    name?: string;
+    /**
+     * The placeholder text to display within the input.
+     */
+    placeholder?: string;
+    /**
+     * A textual prefix to be displayed in the input.
+     */
+    textPrefix?: string;
+    /**
+     * A textual suffix to be displayed in the input.
+     */
+    textSuffix?: string;
+    /**
+     * The value is not editable.
+     */
+    readonly: boolean;
+    /**
+     * A value is required or must be check for the form to be submittable.
+     */
+    required: boolean;
+    /**
+     * The value of the control given in HH:mm format
+     */
+    value?: string;
+    /**
+     * The validation errors for this input. Will render a hint under the input
+     * with the translated error message(s) `error.${key}`. If an object is
+     * passed, the keys will be used as error keys and the values translation
+     * parameters.
+     * If the value is `true`, the input will be marked as invalid without any
+     * hints under the input.
+     */
+    errors?: boolean | string[] | ErrorMap;
+    /**
+     * Fine-grained control over when the errors are shown. Can be `false` to
+     * never show errors, `true` to show errors on blur, or a number to show
+     * errors on change with the given delay in milliseconds.
+     */
+    errorUpdate: boolean | number;
+    /**
+     * Attributes that will be added to the native HTML input element.
+     */
+    nativeAttributes?: {
+        [key: string]: string;
+    };
+    /**
+     * The placement of the dropdown.
+     */
+    placement: Placement;
+    /**
+     * The step size for times in minutes.
+     */
+    step: number;
+    /**
+     * Emitted when the value is changed.
+     */
+    catChange: EventEmitter<string>;
+    /**
+     * Emitted when the input received focus.
+     */
+    catFocus: EventEmitter<FocusEvent>;
+    /**
+     * Emitted when the input loses focus.
+     */
+    catBlur: EventEmitter<FocusEvent>;
+    componentWillLoad(): void;
+    componentWillRender(): void;
+    componentDidLoad(): void;
+    onOpen(): void;
+    /**
+     * Select a time in the picker.
+     *
+     * @param date The time to select.
+     */
+    select(date: Date | null): Promise<void>;
+    /**
+     * Programmatically move focus to the input. Use this method instead of
+     * `input.focus()`.
+     *
+     * @param options An optional object providing options to control aspects of
+     * the focusing process.
+     */
+    doFocus(options?: FocusOptions): Promise<void>;
+    /**
+     * Programmatically remove focus from the input. Use this method instead of
+     * `input.blur()`.
+     */
+    doBlur(): Promise<void>;
+    /**
+     * Clear the input.
+     */
+    clear(): Promise<void>;
+    render(): any;
+    private timeArray;
+    private syncValue;
+    private toggleAm;
+    private onInputBlur;
+    private format;
+    private formatIso;
+}