View source

class InlineCompletionItem

package vscode

@:jsRequire("vscode","InlineCompletionItem")

An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.

@link InlineCompletionItemProvider.provideInlineCompletionItems}

See also:

  • {

Constructor

new(insertText:EitherType<String, SnippetString>, ?range:Range, ?command:Null<Command>)

Creates a new inline completion item.

@link Command} that is executed after inserting this completion.

Parameters:

insertText

The text to replace the range with.

range

The range to replace. If not set, the word at the requested position will be used.

command

An optional {

Variables

command:Null<Command>

An optional {@link Command} that is executed after inserting this completion.

filterText:Null<String>

A text that is used to decide if this inline completion should be shown. When falsy the {@link InlineCompletionItem.insertText} is used.

An inline completion is shown if the text to replace is a prefix of the filter text.

insertText:EitherType<String, SnippetString>

The text to replace the range with. Must be set. Is used both for the preview and the accept operation.

range:Null<Range>

The range to replace. Must begin and end on the same line.

Prefer replacements over insertions to provide a better experience when the user deletes typed text.