Globals / "src/renderer/components/+namespaces/namespace-select" / Props
Interface: Props\#
Type parameters#
| Name | Default |
|---|---|
T |
any |
Hierarchy#
↳ Props
Index#
Properties#
- allowCreateWhileLoading
- aria-label
- aria-labelledby
- autoConvertOptions
- autoFocus
- backspaceRemovesValue
- blurInputOnSelect
- captureMenuScroll
- className
- classNamePrefix
- closeMenuOnScroll
- closeMenuOnSelect
- clusterOptionLabel
- components
- controlShouldRenderValue
- createOptionPosition
- defaultInputValue
- defaultMenuIsOpen
- defaultValue
- delimiter
- escapeClearsValue
- filterOption
- formatCreateLabel
- formatGroupLabel
- formatOptionLabel
- getNewOptionData
- getOptionLabel
- getOptionValue
- hideSelectedOptions
- id
- inputId
- inputValue
- instanceId
- isClearable
- isCreatable
- isDisabled
- isLoading
- isMulti
- isOptionDisabled
- isOptionSelected
- isRtl
- isSearchable
- isValidNewOption
- loadingMessage
- maxMenuHeight
- menuClass
- menuIsOpen
- menuPlacement
- menuPortalTarget
- menuPosition
- menuShouldBlockScroll
- menuShouldScrollIntoView
- minMenuHeight
- name
- noOptionsMessage
- onBlur
- onCreateOption
- onFocus
- onInputChange
- onKeyDown
- onMenuClose
- onMenuOpen
- onMenuScrollToBottom
- onMenuScrollToTop
- openMenuOnClick
- openMenuOnFocus
- options
- pageSize
- placeholder
- screenReaderStatus
- showClusterOption
- showIcons
- styles
- tabIndex
- tabSelectsValue
- theme
- themeName
- value
Methods#
Properties#
allowCreateWhileLoading#
• Optional allowCreateWhileLoading: boolean
Inherited from SelectProps.allowCreateWhileLoading
Defined in node_modules/@types/react-select/src/Creatable.d.ts:11
aria-label#
• Optional aria-label: string
Inherited from SelectProps.aria-label
Defined in node_modules/@types/react-select/src/Select.d.ts:58
aria-labelledby#
• Optional aria-labelledby: string
Inherited from SelectProps.aria-labelledby
Defined in node_modules/@types/react-select/src/Select.d.ts:60
autoConvertOptions#
• Optional autoConvertOptions: boolean
Inherited from SelectProps.autoConvertOptions
Defined in src/renderer/components/select/select.tsx:30
autoFocus#
• Optional autoFocus: boolean
Inherited from SelectProps.autoFocus
Defined in node_modules/@types/react-select/src/Select.d.ts:62
backspaceRemovesValue#
• Optional backspaceRemovesValue: boolean
Inherited from SelectProps.backspaceRemovesValue
Defined in node_modules/@types/react-select/src/Select.d.ts:64
blurInputOnSelect#
• Optional blurInputOnSelect: boolean
Inherited from SelectProps.blurInputOnSelect
Defined in node_modules/@types/react-select/src/Select.d.ts:66
captureMenuScroll#
• Optional captureMenuScroll: boolean
Inherited from SelectProps.captureMenuScroll
Defined in node_modules/@types/react-select/src/Select.d.ts:68
className#
• Optional className: string
Inherited from SelectProps.className
Defined in node_modules/@types/react-select/src/Select.d.ts:70
classNamePrefix#
• Optional classNamePrefix: string | null
Inherited from SelectProps.classNamePrefix
Defined in node_modules/@types/react-select/src/Select.d.ts:72
closeMenuOnScroll#
• Optional closeMenuOnScroll: boolean | EventListener
Inherited from SelectProps.closeMenuOnScroll
Defined in node_modules/@types/react-select/src/Select.d.ts:87
closeMenuOnSelect#
• Optional closeMenuOnSelect: boolean
Inherited from SelectProps.closeMenuOnSelect
Defined in node_modules/@types/react-select/src/Select.d.ts:74
clusterOptionLabel#
• Optional clusterOptionLabel: React.ReactNode
Defined in src/renderer/components/+namespaces/namespace-select.tsx:18
components#
• Optional components: SelectComponentsConfig\
Inherited from SelectProps.components
Defined in node_modules/@types/react-select/src/Select.d.ts:97
controlShouldRenderValue#
• Optional controlShouldRenderValue: boolean
Inherited from SelectProps.controlShouldRenderValue
Defined in node_modules/@types/react-select/src/Select.d.ts:99
createOptionPosition#
• Optional createOptionPosition: \"first\" | \"last\"
Inherited from SelectProps.createOptionPosition
Defined in node_modules/@types/react-select/src/Creatable.d.ts:26
defaultInputValue#
• Optional defaultInputValue: string
Inherited from SelectProps.defaultInputValue
Defined in node_modules/@types/react-select/src/Select.d.ts:207
defaultMenuIsOpen#
• Optional defaultMenuIsOpen: boolean
Inherited from SelectProps.defaultMenuIsOpen
Defined in node_modules/@types/react-select/src/Select.d.ts:208
defaultValue#
• Optional defaultValue: ValueType\
Inherited from SelectProps.defaultValue
Defined in node_modules/@types/react-select/src/Select.d.ts:209
delimiter#
• Optional delimiter: string
Inherited from SelectProps.delimiter
Defined in node_modules/@types/react-select/src/Select.d.ts:101
escapeClearsValue#
• Optional escapeClearsValue: boolean
Inherited from SelectProps.escapeClearsValue
Defined in node_modules/@types/react-select/src/Select.d.ts:103
filterOption#
• Optional filterOption: (option: Option, rawInput: string) => boolean | null
Inherited from SelectProps.filterOption
Defined in node_modules/@types/react-select/src/Select.d.ts:105
formatCreateLabel#
• Optional formatCreateLabel: (inputValue: string) => React.ReactNode
Inherited from SelectProps.formatCreateLabel
Defined in node_modules/@types/react-select/src/Creatable.d.ts:14
formatGroupLabel#
• Optional formatGroupLabel: formatGroupLabel\
Inherited from SelectProps.formatGroupLabel
Defined in node_modules/@types/react-select/src/Select.d.ts:110
formatOptionLabel#
• Optional formatOptionLabel: (option: T, labelMeta: FormatOptionLabelMeta\
Inherited from SelectProps.formatOptionLabel
Defined in node_modules/@types/react-select/src/Select.d.ts:112
getNewOptionData#
• Optional getNewOptionData: (inputValue: string, optionLabel: React.ReactNode) => T
Inherited from SelectProps.getNewOptionData
Defined in node_modules/@types/react-select/src/Creatable.d.ts:20
getOptionLabel#
• Optional getOptionLabel: getOptionLabel\
Inherited from SelectProps.getOptionLabel
Defined in node_modules/@types/react-select/src/Select.d.ts:114
getOptionValue#
• Optional getOptionValue: getOptionValue\
Inherited from SelectProps.getOptionValue
Defined in node_modules/@types/react-select/src/Select.d.ts:116
hideSelectedOptions#
• Optional hideSelectedOptions: boolean
Inherited from SelectProps.hideSelectedOptions
Defined in node_modules/@types/react-select/src/Select.d.ts:118
id#
• Optional id: string
Inherited from SelectProps.id
Defined in node_modules/@types/react-select/src/Select.d.ts:120
inputId#
• Optional inputId: string
Inherited from SelectProps.inputId
Defined in node_modules/@types/react-select/src/Select.d.ts:124
inputValue#
• Optional inputValue: string
Inherited from SelectProps.inputValue
Defined in node_modules/@types/react-select/src/Select.d.ts:122
instanceId#
• Optional instanceId: number | string
Inherited from SelectProps.instanceId
Defined in node_modules/@types/react-select/src/Select.d.ts:126
isClearable#
• Optional isClearable: boolean
Inherited from SelectProps.isClearable
Defined in node_modules/@types/react-select/src/Select.d.ts:128
isCreatable#
• Optional isCreatable: boolean
Inherited from SelectProps.isCreatable
Defined in src/renderer/components/select/select.tsx:29
isDisabled#
• Optional isDisabled: boolean
Inherited from SelectProps.isDisabled
Defined in node_modules/@types/react-select/src/Select.d.ts:130
isLoading#
• Optional isLoading: boolean
Inherited from SelectProps.isLoading
Defined in node_modules/@types/react-select/src/Select.d.ts:132
isMulti#
• Optional isMulti: boolean
Inherited from SelectProps.isMulti
Defined in node_modules/@types/react-select/src/Select.d.ts:138
isOptionDisabled#
• Optional isOptionDisabled: (option: T, options: OptionsType\
Inherited from SelectProps.isOptionDisabled
Defined in node_modules/@types/react-select/src/Select.d.ts:134
isOptionSelected#
• Optional isOptionSelected: (option: T, options: OptionsType\
Inherited from SelectProps.isOptionSelected
Defined in node_modules/@types/react-select/src/Select.d.ts:136
isRtl#
• Optional isRtl: boolean
Inherited from SelectProps.isRtl
Defined in node_modules/@types/react-select/src/Select.d.ts:140
isSearchable#
• Optional isSearchable: boolean
Inherited from SelectProps.isSearchable
Defined in node_modules/@types/react-select/src/Select.d.ts:142
isValidNewOption#
• Optional isValidNewOption: (inputValue: string, value: ValueType\
Inherited from SelectProps.isValidNewOption
Defined in node_modules/@types/react-select/src/Creatable.d.ts:17
loadingMessage#
• Optional loadingMessage: (obj: { inputValue: string }) => string | null
Inherited from SelectProps.loadingMessage
Defined in node_modules/@types/react-select/src/Select.d.ts:144
maxMenuHeight#
• Optional maxMenuHeight: number
Inherited from SelectProps.maxMenuHeight
Defined in node_modules/@types/react-select/src/Select.d.ts:148
menuClass#
• Optional menuClass: string
Inherited from SelectProps.menuClass
Defined in src/renderer/components/select/select.tsx:28
menuIsOpen#
• Optional menuIsOpen: boolean
Inherited from SelectProps.menuIsOpen
Defined in node_modules/@types/react-select/src/Select.d.ts:150
menuPlacement#
• Optional menuPlacement: MenuPlacement
Inherited from SelectProps.menuPlacement
Defined in node_modules/@types/react-select/src/Select.d.ts:153
menuPortalTarget#
• Optional menuPortalTarget: HTMLElement | null
Inherited from SelectProps.menuPortalTarget
Defined in node_modules/@types/react-select/src/Select.d.ts:157
menuPosition#
• Optional menuPosition: MenuPosition
Inherited from SelectProps.menuPosition
Defined in node_modules/@types/react-select/src/Select.d.ts:155
menuShouldBlockScroll#
• Optional menuShouldBlockScroll: boolean
Inherited from SelectProps.menuShouldBlockScroll
Defined in node_modules/@types/react-select/src/Select.d.ts:159
menuShouldScrollIntoView#
• Optional menuShouldScrollIntoView: boolean
Inherited from SelectProps.menuShouldScrollIntoView
Defined in node_modules/@types/react-select/src/Select.d.ts:161
minMenuHeight#
• Optional minMenuHeight: number
Inherited from SelectProps.minMenuHeight
Defined in node_modules/@types/react-select/src/Select.d.ts:146
name#
• Optional name: string
Inherited from SelectProps.name
Defined in node_modules/@types/react-select/src/Select.d.ts:163
noOptionsMessage#
• Optional noOptionsMessage: (obj: { inputValue: string }) => string | null
Inherited from SelectProps.noOptionsMessage
Defined in node_modules/@types/react-select/src/Select.d.ts:165
onBlur#
• Optional onBlur: FocusEventHandler
Inherited from SelectProps.onBlur
Defined in node_modules/@types/react-select/src/Select.d.ts:167
onCreateOption#
• Optional onCreateOption: (inputValue: string) => void
Inherited from SelectProps.onCreateOption
Defined in node_modules/@types/react-select/src/Creatable.d.ts:24
onFocus#
• Optional onFocus: FocusEventHandler
Inherited from SelectProps.onFocus
Defined in node_modules/@types/react-select/src/Select.d.ts:171
onInputChange#
• Optional onInputChange: (newValue: string, actionMeta: InputActionMeta) => void
Inherited from SelectProps.onInputChange
Defined in node_modules/@types/react-select/src/Select.d.ts:173
onKeyDown#
• Optional onKeyDown: KeyboardEventHandler
Inherited from SelectProps.onKeyDown
Defined in node_modules/@types/react-select/src/Select.d.ts:175
onMenuClose#
• Optional onMenuClose: () => void
Inherited from SelectProps.onMenuClose
Defined in node_modules/@types/react-select/src/Select.d.ts:179
onMenuOpen#
• Optional onMenuOpen: () => void
Inherited from SelectProps.onMenuOpen
Defined in node_modules/@types/react-select/src/Select.d.ts:177
onMenuScrollToBottom#
• Optional onMenuScrollToBottom: (event: SyntheticEvent\
Inherited from SelectProps.onMenuScrollToBottom
Defined in node_modules/@types/react-select/src/Select.d.ts:183
onMenuScrollToTop#
• Optional onMenuScrollToTop: (event: SyntheticEvent\
Inherited from SelectProps.onMenuScrollToTop
Defined in node_modules/@types/react-select/src/Select.d.ts:181
openMenuOnClick#
• Optional openMenuOnClick: boolean
Inherited from SelectProps.openMenuOnClick
Defined in node_modules/@types/react-select/src/Select.d.ts:187
openMenuOnFocus#
• Optional openMenuOnFocus: boolean
Inherited from SelectProps.openMenuOnFocus
Defined in node_modules/@types/react-select/src/Select.d.ts:185
options#
• Optional options: GroupedOptionsType\
Inherited from SelectProps.options
Defined in node_modules/@types/react-select/src/Select.d.ts:189
pageSize#
• Optional pageSize: number
Inherited from SelectProps.pageSize
Defined in node_modules/@types/react-select/src/Select.d.ts:191
placeholder#
• Optional placeholder: React.ReactNode
Inherited from SelectProps.placeholder
Defined in node_modules/@types/react-select/src/Select.d.ts:193
screenReaderStatus#
• Optional screenReaderStatus: (obj: { count: number }) => string
Inherited from SelectProps.screenReaderStatus
Defined in node_modules/@types/react-select/src/Select.d.ts:195
showClusterOption#
• Optional showClusterOption: boolean
Defined in src/renderer/components/+namespaces/namespace-select.tsx:17
showIcons#
• Optional showIcons: boolean
Defined in src/renderer/components/+namespaces/namespace-select.tsx:16
styles#
• Optional styles: StylesConfig
Inherited from SelectProps.styles
Defined in node_modules/@types/react-select/src/Select.d.ts:197
tabIndex#
• Optional tabIndex: string | null
Inherited from SelectProps.tabIndex
Defined in node_modules/@types/react-select/src/Select.d.ts:201
tabSelectsValue#
• Optional tabSelectsValue: boolean
Inherited from SelectProps.tabSelectsValue
Defined in node_modules/@types/react-select/src/Select.d.ts:203
theme#
• Optional theme: ThemeConfig
Inherited from SelectProps.theme
Defined in node_modules/@types/react-select/src/Select.d.ts:199
themeName#
• Optional themeName: \"dark\" | \"light\" | \"outlined\"
Inherited from SelectProps.themeName
Defined in src/renderer/components/select/select.tsx:27
value#
• Optional value: T
Inherited from SelectProps.value
Overrides void
Defined in src/renderer/components/select/select.tsx:26
Methods#
customizeOptions#
▸ OptionalcustomizeOptions(nsOptions: SelectOption[]): SelectOption[]
Defined in src/renderer/components/+namespaces/namespace-select.tsx:19
Parameters:
| Name | Type |
|---|---|
nsOptions |
SelectOption[] |
Returns: SelectOption[]
onChange#
▸ OptionalonChange(option: T, meta?: ActionMeta\
Inherited from SelectProps.onChange
Overrides void
Defined in src/renderer/components/select/select.tsx:31
Parameters:
| Name | Type |
|---|---|
option |
T |
meta? |
ActionMeta\ |
Returns: void