Skip to main content

TagAutocomplete

Interfaces

TagAutocompleteProps

Extends

  • Pick<AutocompleteProps<SCTagType | null, any, any, any>, Exclude<keyof AutocompleteProps<SCTagType | null, any, any, any>, "open" | "onOpen" | "onClose" | "onChange" | "filterSelectedOptions" | "disableCloseOnSelect" | "options" | "getOptionLabel" | "value" | "selectOnFocus" | "clearOnBlur" | "blurOnSelect" | "handleHomeEndKeys" | "noOptionsText" | "isOptionEqualToValue" | "renderTags" | "renderOption" | "renderInput">>

Properties

PropertyTypeDescriptionOverrides
defaultValueanyThe default value. Use when the component is not controlled. Default props.multiple ? [] : nullPick.defaultValue
onChange?(value) => voidCallback for change event on poll object-
TagChipProps?Pick<TagChipProps, "label" | "className" | "classes" | "disabled" | "sx" | "onClick" | "size" | "variant" | "ellipsis" | "icon" | "clickable" | "onDelete" | "disposable">The props to spread to TagChip component-
TextFieldProps?TextFieldPropsThe props applied to text field Default {variant: 'outlined, label: tags_label}-

Functions

TagAutocomplete()

TagAutocomplete(inProps): Element

API documentation for the Community-JS Tag 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 tags available in the application.

Import

import {TagAutocomplete} from '@selfcommunity/react-ui';

Component Name

The name SCTagAutocomplete can be used when providing style overrides in the theme.

CSS

Rule NameGlobal classDescription
root.SCTagAutocomplete-rootStyles applied to the root element.

Parameters

ParameterTypeDescription
inPropsTagAutocompleteProps

Returns

Element