# Snippet

Vetur lets you use snippets for each embedded languages.

For example, snippet defined for TypeScript will be available in the TypeScript region:

<script lang="ts">
  // Use TS snippets here

Two exceptions:

  • Use snippets for vue-html inside <template></template>
  • Use vue snippets outside all regions
  <!-- Use `vue-html` snippets here -->
<!-- Use `vue` snippets here -->

# Customizable Scaffold Snippets

Vetur provides scaffolding snippets for quickly defining regions.
They are vue snippets and can be used outside language regions.

To start using them, type:

  • <vue for file scaffolding snippets
  • <template for template scaffolding snippets
  • <style for style scaffolding snippets
  • <script for script scaffolding snippets

Three sources supplement Vetur with scaffold snippets:

Snippet Main

  • πŸ’Ό Workspace. Located at <WORKSPACE>/.vscode/vetur/snippets. These scaffold snippets are only available in the workspace.
  • πŸ—’οΈ User data directory. You can open the folder with the command Vetur: Open user scaffold snippet folder. These scaffold snippets are available in all workspaces.
  • ✌ Vetur. Vetur offers a few scaffold snippets out of the box.

The workspace/user Vetur snippet folders share the same structure:

β”œβ”€β”€ docs/
β”‚   β”‚   // Completed as `<docs>`. Will have default completion icon.
β”‚   └── docs.vue
β”œβ”€β”€ style/
β”‚   β”‚   // Completed as `<style>`. Will have CSS completion icon.
β”‚   β”‚   // `template` and `script` folder will have HTML/JS icons.
β”‚   └── scss-module.vue 
└── vue-class-component.vue // Top level files will be completed as `<vue>`

Completions of scaffold snippets are sorted by their categories. Workspace > User > Vetur.

You can customize the suffix and turn sources on/off with vetur.completion.scaffoldSnippetSources:

"vetur.completion.scaffoldSnippetSources": {
  "workspace": "πŸ’Ό", // Suffix workspace snippets with `πŸ’Ό`
  "user": "(️User)", // Suffix workspace snippets with `(User)`
  "vetur": "" // Disable Vetur's builtin scaffold snippets

Snippet Partial

# Snippet Syntax

You can use everything that's allowed in VS Code Snippet Syntax (opens new window). The good thing is, you write them in .vue files instead of .json files, and you don't need to escape special characters.