FileMaster

Edit File: sc-input.d.ts

import { EventEmitter } from '../../../stencil-public-runtime';
/**
 * @part base - The elements base wrapper.
 * @part input - The html input element.
 * @part form-control - The form control wrapper.
 * @part label - The input label.
 * @part help-text - Help text that describes how to use the input.
 * @part prefix - Used to prepend an icon or element to the input.
 * @part suffix - Used to prepend an icon or element to the input.
 */
export declare class ScInput {
    private input;
    private inputId;
    private helpId;
    private labelId;
    /** Element */
    el: HTMLScInputElement;
    private formController;
    squared: boolean;
    squaredBottom: boolean;
    squaredTop: boolean;
    squaredLeft: boolean;
    squaredRight: boolean;
    /** Hidden */
    hidden: boolean;
    /** The input's type. */
    type: 'email' | 'number' | 'password' | 'search' | 'tel' | 'text' | 'url' | 'hidden';
    /** The input's size. */
    size: 'small' | 'medium' | 'large';
    /** The input's name attribute. */
    name: string;
    /** The input's value attribute. */
    value: string;
    /** Draws a pill-style input with rounded edges. */
    pill: boolean;
    /** The input's label. */
    label: string;
    /** Should we show the label */
    showLabel: boolean;
    /** The input's help text. */
    help: string;
    /** Adds a clear button when the input is populated. */
    clearable: boolean;
    /** Adds a password toggle button to password inputs. */
    togglePassword: boolean;
    /** The input's placeholder text. */
    placeholder: string;
    /** Disables the input. */
    disabled: boolean;
    /** Makes the input readonly. */
    readonly: boolean;
    /** The minimum length of input that will be considered valid. */
    minlength: number;
    /** The maximum length of input that will be considered valid. */
    maxlength: number;
    /** The input's minimum value. */
    min: number | string;
    /** The input's maximum value. */
    max: number | string;
    /** The input's step attribute. */
    step: number;
    /** A pattern to validate input against. */
    pattern: string;
    /** Custom validation message to show when the input is invalid (replaces browser default). */
    customValidity: string;
    /** Makes the input a required field. */
    required: boolean;
    /**
     * This will be true when the control is in an invalid state. Validity is determined by props such as `type`,
     * `required`, `minlength`, `maxlength`, and `pattern` using the browser's constraint validation API.
     */
    invalid: boolean;
    /** The input's autocorrect attribute. */
    autocorrect: string;
    /** The input's autocomplete attribute. */
    autocomplete: string;
    /** The input's autofocus attribute. */
    autofocus: boolean;
    /** Enables spell checking on the input. */
    spellcheck: boolean;
    /** The input's inputmode attribute. */
    inputmode: 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url';
    /** Inputs focus */
    hasFocus: boolean;
    /** Is the password visible */
    isPasswordVisible: boolean;
    /** Emitted when the control's value changes. */
    scChange: EventEmitter<void>;
    /** Emitted when the clear button is activated. */
    scClear: EventEmitter<void>;
    /** Emitted when the control receives input. */
    scInput: EventEmitter<void>;
    /** Emitted when the control gains focus. */
    scFocus: EventEmitter<void>;
    /** Emitted when the control loses focus. */
    scBlur: EventEmitter<void>;
    reportValidity(): Promise<boolean>;
    /** Sets focus on the input. */
    triggerFocus(options?: FocusOptions): Promise<void>;
    /** Sets a custom validation message. If `message` is not empty, the field will be considered invalid. */
    setCustomValidity(message: string): Promise<void>;
    /** Removes focus from the input. */
    triggerBlur(): Promise<void>;
    /** Prevent mouse scroll wheel from modifying input value */
    handleWheel(): void;
    /** Selects all the text in the input. */
    select(): void;
    handleBlur(): void;
    handleFocus(): void;
    handleChange(): void;
    handleInput(): void;
    handleInvalid(): void;
    handleClearClick(event: MouseEvent): void;
    handlePasswordToggle(): void;
    handleFocusChange(): void;
    handleValueChange(): void;
    componentDidLoad(): void;
    disconnectedCallback(): void;
    render(): any;
}

Back