GroupAutocomplete
Interfaces
GroupAutocompleteProps
Extends
Pick
<AutocompleteProps
<SCGroupType
|null
,any
,any
,any
>,Exclude
<keyofAutocompleteProps
<SCGroupType
|null
,any
,any
,any
>,"open"
|"onOpen"
|"onClose"
|"onChange"
|"filterSelectedOptions"
|"disableCloseOnSelect"
|"options"
|"getOptionLabel"
|"value"
|"selectOnFocus"
|"clearOnBlur"
|"blurOnSelect"
|"handleHomeEndKeys"
|"clearIcon"
|"noOptionsText"
|"isOptionEqualToValue"
|"renderTags"
|"renderOption"
|"renderInput"
>>
Properties
Property | Type | Description |
---|---|---|
TextFieldProps? | TextFieldProps | The props applied to text field Default {variant: 'outlined, label: groups_label} |
checkboxSelect? | boolean | If checkbox is selected Default false |
limitCountGroups? | number | The maximum number of groups that will be visible when not focused. Default 0 |
onChange? | (value : any ) => void | Callback for change event on poll object |
Functions
GroupAutocomplete()
GroupAutocomplete(
inProps
):Element
API documentation for the Community-JS Group Autocomplete component. Learn about the available props and the CSS API.
This component renders a bar that allows users to search (with autocomplete) for all the groups available in the application.
Import
import {GroupAutocomplete} from '@selfcommunity/react-ui';
Component Name
The name SCGroupAutocomplete
can be used when providing style overrides in the theme.
CSS
Rule Name | Global class | Description |
---|---|---|
root | .SCGroupAutocomplete-root | Styles applied to the root element. |
Parameters
Parameter | Type | Description |
---|---|---|
inProps | GroupAutocompleteProps |
Returns
Element
Source
packages/react-ui/src/components/GroupAutocomplete/GroupAutocomplete.tsx:94