Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
img A better icon image Apr 20, 2018
snippets dev May 22, 2018
.gitattributes first commit Mar 13, 2018
.gitignore first commit Mar 13, 2018
CHANGELOG.md release v1.0.9 May 11, 2018
ISSUE_TEMPLATE.md first commit Mar 13, 2018
LICENSE check validity Mar 14, 2018
README.md release v0.1.8 May 10, 2018
documentation.md getting ready for v0.1.4 Mar 16, 2018
package.json release v1.0.9 May 11, 2018

README.md

WORK IN PROGRESS

vuetify-vscode

Vuetify vscode extension

vuetify-vscode is the official extension for Vuetifyjs when working in visual studio code. It provides snippets and autocomplete functionality for Vuetifyjs.

Documentation

For all snippets available for Visual Studio Code click here

Installation

Install through VS Code extensions. Search for vuetify-vscode

Visual Studio Code Market Place: vuetify-vscode

Can also be installed using

ext install vuetifyjs.vuetify-vscode

Pro Tip

You can feel it when using vs code, the autocompletions simply don't work in double quotes.

For example when you are typing inside any double quote in html like class="", it will never show you the availbale vuetify snippets. But don't worry, there is a hack for this. Simply add to your user setting in following code.

  "editor.quickSuggestions": {
    "strings": true,
  }

Now you work more time without pressing ctrl + space. But if you find it annoying just disable it.

Usage

Snippet

You don't need usage example if you are familiar with concept of snippets or you looked up the documentation. But here is an example:

Let's suppose you want to insert Button componenet. For that you have to write full component.

<v-btn>buttonText<v-btn>

But in vuetify-vscode only writing vBtn will give you all options available for Button component.

Everything is in camel case and with 'v' prefix which is for Vuetifyjs.

If you want to see list of all available props of a component. Just write v{component-name}Props. For example : vBtnProps,vAvatarProps etc.

If you want to insert a component with all of its props. Just write v{component-name}WithProps. This will insert component with all of its props. For example : vBtnWithProps, vAvatarWithProps etc.

Templates

Every component in the Vuetify have additional code to write inside it. For example the v-btn-toggle component have v-btn inside it. Thats why vuetify-vscode provides templates for them. The syntax of template is pretty easy. v{component}Template or v{component}Template{availableTemplate} For example vBtnToggleTemplate will give you following code.

<v-btn-toggle mandatory multiple v-model="value">
  <v-btn flat>
    <v-icon>icon</v-icon>
  </v-btn>
  <v-btn flat>
    <v-icon>icon</v-icon>
  </v-btn>
  <v-btn flat>
    <v-icon>icon</v-icon>
  </v-btn>
  <v-btn flat>
    <v-icon>icon</v-icon>
  </v-btn>
</v-btn-toggle>

and vBtnToggleTemplateTextIcon will give you following code.

<v-btn-toggle multiple mandatory v-model="value">
  <v-btn flat value="value">
    <span>text</span>
    <v-icon>icon</v-icon>
  </v-btn>
  <v-btn flat value="value">
    <span>text</span>
    <v-icon>icon</v-icon>
  </v-btn>
  <v-btn flat value="value">
    <span>text</span>
    <v-icon>icon</v-icon>
  </v-btn>
  <v-btn flat value="value">
    <span>text</span>
    <v-icon>icon</v-icon>
  </v-btn>
</v-btn-toggle>

Upcoming features

  • on hover documentation for components and props
  • Less dependent on snippets
  • More dependent on Auto Completion
  • Only show relevant props for component
  • eslint integration

Changelog

Changelog

Questions

If you have any questions, ideas or you want to discuss with me. Just raise a issue in vuetify-vscode github repository.

License

MIT