LabeledThemedSelectProps Interface

Beta  

Properties for LabeledThemedSelect components

Extends

  • { aria-label?: undefined | string, aria-labelledby?: undefined | string, autoFocus?: undefined | false | true, backspaceRemovesValue?: undefined | false | true, blurInputOnSelect?: undefined | false | true, captureMenuScroll?: undefined | false | true, className?: undefined | string, closeMenuOnScroll?: boolean | EventListener, closeMenuOnSelect?: undefined | false | true, components?: SelectComponentsConfig<OptionType>, controlShouldRenderValue?: undefined | false | true, defaultMenuIsOpen?: undefined | false | true, defaultValue?: ValueType<OptionType>, divRef?: React.Ref<HTMLDivElement>, escapeClearsValue?: undefined | false | true, filterOption?: (option: OptionType, rawInput: string) => boolean | null, formatGroupLabel?: undefined, formatOptionLabel?: undefined | (optionType: OptionType, formatLabelMeta: FormatOptionLabelMeta) => React.ReactNode, getOptionLabel?: undefined, getOptionValue?: undefined, hideSelectedOptions?: undefined | false | true, id?: undefined | string, inputId?: undefined | string, inputValue?: undefined | string, instanceId?: number | string, isClearable?: undefined | false | true, isDisabled?: undefined | false | true, isLoading?: undefined | false | true, isMenuFixed?: undefined | false | true, isMulti?: undefined | false | true, isOptionDisabled?: undefined | (option: OptionType, options: OptionsType) => boolean | false, isRtl?: undefined | false | true, isSearchable?: undefined | false | true, maxMenuHeight?: undefined | number, menuIsOpen?: undefined | false | true, menuShouldBlockScroll?: undefined | false | true, menuShouldScrollIntoView?: undefined | false | true, minMenuHeight?: undefined | number, name?: undefined | string, noOptionsMessage?: undefined | (obj: { inputValue: string }) => string | null, onBlur?: FocusEventHandler, onChange?: undefined | (value: ValueType<OptionType>, action: ActionMeta<OptionType>) => void, onFocus?: FocusEventHandler, onInputChange?: undefined | (newValue: string, actionMeta?: InputActionMeta) => void, onKeyDown?: KeyboardEventHandler, onMenuClose?: undefined | () => void, onMenuOpen?: undefined | () => void, onMenuScrollToBottom?: undefined | (e: SyntheticEvent<HTMLElement>) => void, onMenuScrollToTop?: undefined | (e: SyntheticEvent<HTMLElement>) => void, openMenuOnClick?: undefined | false | true, openMenuOnFocus?: undefined | false | true, options: OptionsType, pageSize?: undefined | number, placeholder?: undefined | string, ref?: React.Ref<Component>, styles?: React.CSSProperties, tabIndex?: undefined | string, tabSelectsValue?: undefined | false | true, value?: ValueType<OptionType> }
  • LabeledComponentProps
  • MessagedComponentProps

Inherited properties

Name Type Inherited from Description
aria-label undefined | string __type  
aria-labelledby undefined | string __type  
autoFocus undefined | false | true __type  
backspaceRemovesValue undefined | false | true __type  
blurInputOnSelect undefined | false | true __type  
captureMenuScroll undefined | false | true __type  
className undefined | string __type  
closeMenuOnScroll boolean | EventListener __type  
closeMenuOnSelect undefined | false | true __type  
components undefined | SelectComponentsConfig<OptionType> __type  
controlShouldRenderValue undefined | false | true __type  
defaultMenuIsOpen undefined | false | true __type  
defaultValue undefined | ValueType<OptionType> __type  
divRef undefined | React.Ref<HTMLDivElement> __type Provides ability to return reference to the outer HTMLDivElement
escapeClearsValue undefined | false | true __type  
filterOption (option: OptionType, rawInput: string) => boolean | null __type  
formatGroupLabel undefined | __type  
formatOptionLabel undefined | (optionType: OptionType, formatLabelMeta: FormatOptionLabelMeta) => React.ReactNode __type  
getOptionLabel undefined | __type  
getOptionValue undefined | __type  
hideSelectedOptions undefined | false | true __type  
id undefined | string __type  
inputClassName undefined | string LabeledComponentProps Custom CSS class name for the checkbox input element
inputId undefined | string __type  
inputStyle undefined | React.CSSProperties LabeledComponentProps Custom CSS Style for the checkbox input element
inputValue undefined | string __type  
instanceId number | string __type  
isClearable undefined | false | true __type  
isDisabled undefined | false | true __type  
isLoading undefined | false | true __type  
isMenuFixed undefined | false | true __type  
isMulti undefined | false | true __type  
isOptionDisabled undefined | (option: OptionType, options: OptionsType) => boolean | false __type  
isRtl undefined | false | true __type  
isSearchable undefined | false | true __type  
label undefined | string LabeledComponentProps Text that will be shown next to or above the input.
labelClassName undefined | string LabeledComponentProps Custom CSS class name for the label
labelStyle undefined | React.CSSProperties LabeledComponentProps Custom CSS Style for the label
maxMenuHeight undefined | number __type  
menuIsOpen undefined | false | true __type  
menuShouldBlockScroll undefined | false | true __type  
menuShouldScrollIntoView undefined | false | true __type  
message undefined | string MessagedComponentProps Optional text shown below the input.
messageClassName undefined | string MessagedComponentProps Custom CSS class name for the message
messageStyle undefined | React.CSSProperties MessagedComponentProps Custom CSS Style for the message
minMenuHeight undefined | number __type  
name undefined | string __type  
noOptionsMessage undefined | (obj: { inputValue: string }) => string | null __type  
onBlur undefined | FocusEventHandler __type  
onChange undefined | (value: ValueType<OptionType>, action: ActionMeta<OptionType>) => void __type  
onFocus undefined | FocusEventHandler __type  
onInputChange undefined | (newValue: string, actionMeta?: InputActionMeta) => void __type  
onKeyDown undefined | KeyboardEventHandler __type  
onMenuClose undefined | () => void __type  
onMenuOpen undefined | () => void __type  
onMenuScrollToBottom undefined | (e: SyntheticEvent<HTMLElement>) => void __type  
onMenuScrollToTop undefined | (e: SyntheticEvent<HTMLElement>) => void __type  
openMenuOnClick undefined | false | true __type  
openMenuOnFocus undefined | false | true __type  
options OptionsType __type  
pageSize undefined | number __type  
placeholder undefined | string __type  
ref undefined | React.Ref<Component> __type Provides ability to return reference to the ThemedSelect
status undefined | InputStatus LabeledComponentProps Input status like: "Success", "Warning" or "Error"
styles undefined | React.CSSProperties __type  
tabIndex undefined | string __type  
tabSelectsValue undefined | false | true __type  
value undefined | ValueType<OptionType> __type  

Defined in

Last Updated: 15 June, 2021