Skip to content
Prism code editor

autoComplete

autoComplete(config): AutoComplete

Defined in: extensions/autocomplete/tooltip.ts:85

Extension adding basic autocomplete to an editor. For autocompletion to work, you need to registerCompletions for specific languages.

Parameters

Section titled “Parameters”

config

Section titled “config”

AutoCompleteConfig

Object used to configure the extension. The filter property is required.

Requires the cursorPosition extension to work.

Requires styling from prism-code-editor/autocomplete.css in addition to a stylesheet for icons. prism-code-editor/autocomplete-icons.css adds some icons from VSCode, but you can use your own icons instead.

Returns

Section titled “Returns”

AutoComplete

See

Section titled “See”

Completion.icon for how to style your own icons.

Keyboard shortcuts

Section titled “Keyboard shortcuts”

Here, Mod refers to Cmd on Mac and Ctrl otherwise.

  • Ctrl + Space: Trigger suggestion
  • Mod + I: Trigger suggestion
  • Alt + Escape: Trigger suggestion (Mac only)
  • Ctrl + Space: Toggle suggestion documentation
  • Mod + I: Toggle suggestion documentation
  • Tab: Insert completion
  • Enter: Insert completion
  • Escape: Close completion widget
  • Escape: Clear tab stops
  • Tab: Select next tab stop
  • Shift + Tab: Select previous tab stop
  • ArrowUp: Select previous suggestion
  • ArrowDown: Select next suggestion
  • PageUp: Select first visible suggestion
  • PageDown: Select last visible suggestion