Interface TagsProps<T>

Type Parameters

  • T = string

Hierarchy

Properties

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

Properties

Optional autoFocus

autoFocus?: boolean

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

Optional className

className?: string

CSS Class name for additional styles

Optional disabled

disabled?: boolean

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

Optional displayKey

displayKey?: keyof T

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

Optional dropDownLabel

dropDownLabel?: string

Optional Drop down label (default: '')

Optional error

error?: string

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

Optional id

id?: string

Form control id

Optional inlineMode

inlineMode?: boolean

Hide options not needed in the “inline” scenario

Optional label

label?: string

Form control label

name

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.

Optional onBlur

onBlur?: ((event) => void)

Type declaration

    • (event): void

    • Raised when the element has been selected

      Parameters

      • event: FormEvent<HTMLSelectElement>

      Returns void

Optional onChange

onChange?: ((event) => void)

Type declaration

    • (event): void

    • Raised when the value has changed

      Parameters

      • event: FormEvent<HTMLSelectElement>

      Returns void

Optional onFocus

onFocus?: ((event) => void)

Type declaration

    • (event): void

    • Raised when the element has been de-selected

      Parameters

      • event: FormEvent<HTMLSelectElement>

      Returns void

Optional tagsOptions

tagsOptions?: T[]

Array of options that can be selected from

Optional tooltipContent

tooltipContent?: ReactNode

A tooltip of additional information

Optional value

value?: string[]

If set, sets the form control value

Optional valueKey

valueKey?: keyof T

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc