ComboboxEditor API

API reference docs for theComboboxEditorcomponent. For examples and details on the usage of this component, visit the component demo page.

Props

PropTypeDescriptionDefault
childrenReact.ReactNodeThe content of the combobox editor._
contentContentThe content of the editor._
onUpdate(editor: Editor, currentSearchTerm: string) => voidThe function to be called when the editor is updated._
optionsArray of ObjectsThe options that will be directly used to render items in the list_
placeholderstringThe placeholder for the trigger._
searchTermstringThe search term to be used for filtering the options._
singleSelectbooleanWhen true, only allows a single tag to be selected at a time._
tagAsTextFormat(value: string) => stringCustom function to format how tags appear in ouput text representation (e.g., when using editor.getText()).(value) => | {value} |
editorConfigObjectUsed to configure the editor used, which will be passed to the tiptap's useEditor hook._