Interface TextInputProps

interface TextInputProps {
    attributes?: Record<string, string>;
    autoFocus?: boolean;
    classNames?: string[];
    description?: ExtendedHTMLElement;
    fireModifierAndEnterKeyPress?: (() => void);
    icon?: MynahIcons | "q" | "menu" | "minus" | "search" | "plus" | "paper-clip" | "list-add" | "tabs" | "chat" | "link" | "folder" | "file" | "flash" | "doc" | "external" | "cancel" | "cancel-circle" | "calendar" | "comment" | "megaphone" | "magic" | "notification" | "eye" | "ellipsis" | "ok" | "up-open" | "down-open" | "right-open" | "left-open" | "resize-full" | "resize-small" | "block" | "ok-circled" | "info" | "warning" | "error" | "thumbs-up" | "thumbs-down" | "star" | "stack" | "light-bulb" | "envelope-send" | "refresh" | "progress" | "scroll-down" | "user" | "play" | "pause" | "stop" | "pencil" | "code-block" | "copy" | "cursor-insert" | "text-select" | "revert" | "rocket" | "asterisk" | "bug" | "check-list" | "deploy" | "help" | "message" | "trash" | "transform";
    label?: string | ExtendedHTMLElement | HTMLElement;
    mandatory?: boolean;
    onChange?: ((value) => void);
    onKeyPress?: ((event) => void);
    placeholder?: string;
    testId?: string;
    type?: "number" | "email" | "text";
    validationPatterns?: {
        operator?: "and" | "or";
        patterns: ValidationPattern[];
    };
    value?: string;
}

Properties

attributes? autoFocus? classNames? description? fireModifierAndEnterKeyPress? icon? label? mandatory? onChange? onKeyPress? placeholder? testId? type? validationPatterns? value?

Properties

Optional attributes

attributes?: Record<string, string>

Optional autoFocus

autoFocus?: boolean

Optional classNames

classNames?: string[]

Optional description

description?: ExtendedHTMLElement

Optional fireModifierAndEnterKeyPress

fireModifierAndEnterKeyPress?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional icon

icon?: MynahIcons | "q" | "menu" | "minus" | "search" | "plus" | "paper-clip" | "list-add" | "tabs" | "chat" | "link" | "folder" | "file" | "flash" | "doc" | "external" | "cancel" | "cancel-circle" | "calendar" | "comment" | "megaphone" | "magic" | "notification" | "eye" | "ellipsis" | "ok" | "up-open" | "down-open" | "right-open" | "left-open" | "resize-full" | "resize-small" | "block" | "ok-circled" | "info" | "warning" | "error" | "thumbs-up" | "thumbs-down" | "star" | "stack" | "light-bulb" | "envelope-send" | "refresh" | "progress" | "scroll-down" | "user" | "play" | "pause" | "stop" | "pencil" | "code-block" | "copy" | "cursor-insert" | "text-select" | "revert" | "rocket" | "asterisk" | "bug" | "check-list" | "deploy" | "help" | "message" | "trash" | "transform"

Optional label

label?: string | ExtendedHTMLElement | HTMLElement

Optional mandatory

mandatory?: boolean

Optional onChange

onChange?: ((value) => void)

Type declaration

    • (value): void

    • Parameters

      • value: string

      Returns void

Optional onKeyPress

onKeyPress?: ((event) => void)

Type declaration

    • (event): void

    • Parameters

      • event: KeyboardEvent

      Returns void

Optional placeholder

placeholder?: string

Optional testId

testId?: string

Optional type

type?: "number" | "email" | "text"

Optional validationPatterns

validationPatterns?: {
    operator?: "and" | "or";
    patterns: ValidationPattern[];
}

Type declaration

Optional value

value?: string

Settings

Member Visibility

Theme

On This Page

attributesautoFocusclassNamesdescriptionfireModifierAndEnterKeyPressiconlabelmandatoryonChangeonKeyPressplaceholdertestIdtypevalidationPatternsvalue