Axinom Mosaic Libraries
    Preparing search index...

    Interface TagsProps<T>

    interface TagsProps<T = string> {
        autoFocus?: boolean;
        className?: string;
        disabled?: boolean;
        displayKey?: keyof T;
        dropDownLabel?: string;
        error?: string;
        id?: string;
        inlineMode?: boolean;
        label?: string;
        name: string;
        onBlur?: (event: ChangeEvent<HTMLInputElement>) => void;
        onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
        onFocus?: (event: ChangeEvent<HTMLInputElement>) => void;
        tagsOptions?: T[];
        tooltipContent?: ReactNode;
        value?: string[];
        valueKey?: keyof T;
    }

    Type Parameters

    • T = string

    Hierarchy (View Summary)

    Index

    Properties

    autoFocus? className? disabled? displayKey? dropDownLabel? error? id? inlineMode? label? name onBlur? onChange? onFocus? tagsOptions? tooltipContent? value? valueKey?

    Properties

    autoFocus?: boolean

    Whether or not the control should start focused (default: false)

    className?: string

    CSS Class name for additional styles

    disabled?: boolean

    Whether or not the control is disabled (default: false)

    displayKey?: keyof T

    If the tags component uses objects as tagsOptions, this prop is used as the key to identify display value

    dropDownLabel?: string

    Optional Drop down label (default: '')

    error?: string

    If set, indicates the control has an error and will display this prop as the error message

    id?: string

    Form control id

    inlineMode?: boolean

    Hide options not needed in the “inline” scenario

    label?: string

    Form control label

    name: string

    Name of form control, required and must be unique from other form control names. This name should match the the name of the object corresponding to this control.

    onBlur?: (event: ChangeEvent<HTMLInputElement>) => void

    Raised when the element has been selected

    onChange?: (event: ChangeEvent<HTMLInputElement>) => void

    Raised when the value has changed

    onFocus?: (event: ChangeEvent<HTMLInputElement>) => void

    Raised when the element has been de-selected

    tagsOptions?: T[]

    Array of options that can be selected from

    tooltipContent?: ReactNode

    A tooltip of additional information

    value?: string[]

    If set, sets the form control value

    valueKey?: keyof T

    If the tags component uses objects as tagsOptions, this prop is used as the key to identify value

    Settings

    Member Visibility

    On This Page

    Properties