Skip to main content

EventAutocomplete

Interfaces

EventAutocompleteProps

Extends

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

Properties

PropertyTypeDescription
TextFieldProps?TextFieldPropsThe props applied to text field

Default
{variant: 'outlined, label: events_label}
checkboxSelect?booleanIf checkbox is selected

Default
false
limitCountEvents?numberThe maximum number of events that will be visible when not focused.

Default
0
onChange?(value: any) => voidCallback for change event on event object

Functions

EventAutocomplete()

EventAutocomplete(inProps): Element

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

Import

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

Component Name

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

CSS

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

Parameters

ParameterTypeDescription
inPropsEventAutocompleteProps

Returns

Element

Source

packages/react-ui/src/components/EventAutocomplete/EventAutocomplete.tsx:94