SnippetString

A snippet string is a template which allows to insert text and to control the editor cursor when insertion happens.

A snippet can define tab stops and placeholders with $1, $2 and ${3:foo}. $0 defines the final tab stop, it defaults to the end of the snippet. Variables are defined with $name and ${name:default value}. Also see the full snippet syntax.

Online Documentation

Constructors

SnippetString

constructor(value: String = definedExternally)

Create a new snippet string.

Properties

value

var value: String

The snippet string.

Functions

appendChoice

fun appendChoice(values: ReadonlyArray<JsString>, number: Int = definedExternally): SnippetString

Builder-function that appends a choice (${1|a,b,c|}) to the {@linkcode SnippetString.value value} of this snippet string.

appendPlaceholder

fun appendPlaceholder(value: (snippet: SnippetString) -> Unit, number: Int = definedExternally): SnippetString

fun appendPlaceholder(value: String, number: Int = definedExternally): SnippetString

Builder-function that appends a placeholder (${1:value}) to the {@linkcode SnippetString.value value} of this snippet string.

appendTabstop

fun appendTabstop(number: Int = definedExternally): SnippetString

Builder-function that appends a tabstop ($1, $2 etc) to the {@linkcode SnippetString.value value} of this snippet string.

appendText

fun appendText(string: String): SnippetString

Builder-function that appends the given string to the {@linkcode SnippetString.value value} of this snippet string.

appendVariable

fun appendVariable(name: String, defaultValue: (snippet: SnippetString) -> Unit): SnippetString

fun appendVariable(name: String, defaultValue: String): SnippetString

Builder-function that appends a variable (${VAR}) to the {@linkcode SnippetString.value value} of this snippet string.