Autocomplete Providers

Help query: "How do I add autocomplete to my plugin?" / "How do autocomplete providers work?"

Autocomplete is backed by providers registered in user/autocomplete.rs via backends(). Providers in the same or-group compete: once a higher-priority provider returns results, lower ones in that group are skipped.

Default priority

Priority	Provider	Or-group	Notes
1	lsp	source	Completions from an attached language server
2	calculator	source	Active in calculator buffers
3	buffer	source	Words already present in the buffer

Add a provider for your plugin

In your module:

pub fn autocomplete_provider() -> AutocompleteProviderConfig {
    AutocompleteProviderConfig::new(
        "myplugin",
        "My Plugin",
        MY_PROVIDER_ICON,
        MY_ITEM_ICON,
    )
    .with_buffer_kind(MY_BUFFER_KIND)
    .with_or_group(autocomplete::PROVIDER_SOURCE_GROUP)
    .with_items(my_autocomplete_items())
}

In user/autocomplete.rs backends():

myplugin::autocomplete_provider(),

Then rebuild the user package.

Related pages

• Create a plugin
• After scaffold
• Calculator plugin