An instance of this is passed to completion source functions.
Create a new completion context. (Mostly useful for testing completion sources—in the editor, the extension will create these for you.)
The editor state that the completion happens in.
The position at which the completion is happening.
Indicates whether completion was activated explicitly, or
implicitly by typing. The usual way to respond to this is to
only return completions when either there is part of a
completable entity before the cursor, or explicit is true.
Get the extent, content, and (if there is a token) type of the
token before this.pos.
Get the match of the given expression directly before the cursor.
Yields true when the query has been aborted. Can be useful in asynchronous queries to avoid doing work that will be ignored.
Allows you to register abort handlers, which will be called when the query is aborted.
Returns an extension that enables autocompletion.
Given a a fixed array of options, return an autocompleter that completes them.
Get the current completion status. When completions are available,
this will return "active". When completions are pending (in the
process of being queried), this returns "pending". Otherwise, it
returns null.
Returns the available completions as an array.
Wrap the given completion source so that it will only fire when the cursor is in a syntax node with one of the given names.
Wrap the given completion source so that it will not fire when the cursor is in a syntax node with one of the given names.
Return the currently selected completion, if any.
Objects type used to represent individual completions.
The label to show in the completion picker. This is what input is matched agains to determine whether a completion matches (and how well it matches).
An optional short piece of information to show (with a different style) after the label.
Additional info to show when the completion is selected. Can be a plain string or a function that'll render the DOM structure to show when invoked.
How to apply the completion. The default is to replace it with
its label. When this holds a
string, the completion range is replaced by that string. When it
is a function, that function is called to perform the
completion. If it fires a transaction, it is responsible for
adding the pickedCompletion
annotation to it.
The type of the completion. This is used to pick an icon to show
for the completion. Icons are styled with a CSS class created by
appending the type name to "cm-completionIcon-". You can
define or restyle icons by defining these selectors. The base
library defines simple icons for class, constant, enum,
function, interface, keyword, method, namespace,
property, text, type, and variable.
Multiple types can be provided by separating them with spaces.
When given, should be a number from -99 to 99 that adjusts how this completion is ranked compared to other completions that match the input as well as this one. A negative number moves it down the list, a positive number moves it up.
Interface for objects returned by completion sources.
The start of the range that is being completed.
The end of the range that is being completed. Defaults to the main cursor position.
The completions returned. These don't have to be compared with
the input by the source—the autocompletion system will do its
own matching (against the text between from and to) and
sorting.
When given, further input that causes the part of the document
between (mapped) from and to to
match this regular expression will not query the completion
source again, but continue with this list of options. This can
help a lot with responsiveness, since it allows the completion
list to be updated synchronously.
By default, the library filters and scores completions. Set
filter to false to disable this, and cause your completions
to all be included, in the order they were given. When there are
other sources, unfiltered completions appear at the top of the
list of completions. span must not be given when filter is
false, because it only works when filtering.
The function signature for a completion source. Such a function may return its result synchronously or as a promise. Returning null indicates no completions are available.
The function signature for a completion source. Such a function may return its result synchronously or as a promise. Returning null indicates no completions are available.