You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Evan You 49dc2dd1e4 fix(sfc/style-vars): properly re-apply style vars on component root elements change 3 years ago
.github ci: move to github actions / remove circleci config 3 years ago
.vscode workflow: cross platform vscode jest debugging (#414) 4 years ago
packages fix(sfc/style-vars): properly re-apply style vars on component root elements change 3 years ago
scripts chore: log runtime build file size 3 years ago
test-dts fix(type): infer parent as `this` on `nextTick` function (#3608) 3 years ago
.eslintrc.js chore: disallow async/await usage in src 3 years ago
.gitignore chore: add the yarn error log file to git ignore (#150) 5 years ago
.prettierrc init (graduate from prototype) 6 years ago
CHANGELOG.md release: v3.1.5 3 years ago
LICENSE chore: license 5 years ago
README.md chore: update build status badge [ci skip] 3 years ago
api-extractor.json feat(types): adjust type exports for manual render function and tooling usage 4 years ago
jest.config.js test: fix test ts target 3 years ago
package.json workflow: also rebuild runtime-dom when working on sfc playground 3 years ago
rollup.config.js build: fix compat build type treatment 3 years ago
tsconfig.json fix(build): fix generated code containing unprocessed class field syntax 3 years ago
yarn.lock chore: bump serve 3 years ago

README.md

vue-next npm build status

This is the repository for Vue 3.0.

Quickstart

  • Via CDN: <script src="https://unpkg.com/vue@next"></script>

  • In-browser playground on Codepen

  • Scaffold via Vite:

    # npm
    npm init @vitejs/app
    # yarn
    yarn create @vitejs/app
    # select vue template
    
  • Scaffold via vue-cli:

    npm install -g @vue/cli # OR yarn global add @vue/cli
    vue create hello-vue3
    # select vue 3 preset
    

Changes from Vue 2

Please consult the Migration Guide.

Also note: Vue 3 does not support IE11 (RFC | Discussion).

Supporting Libraries

All of our official libraries and tools now support Vue 3, but most of them are still in beta status and distributed under the next dist tag on NPM. We are planning to stabilize and switch all projects to use the latest dist tag in early 2021.

Vue CLI

As of v4.5.0, vue-cli now provides built-in option to choose Vue 3 preset when creating a new project. You can upgrade vue-cli and run vue create to create a Vue 3 project today.

Vue Router

Vue Router 4.0 provides Vue 3 support and has a number of breaking changes of its own. Check out its Migration Guide for full details.

Vuex

Vuex 4.0 provides Vue 3 support with largely the same API as 3.x. The only breaking change is how the plugin is installed.

Devtools Extension

We are working on a new version of the Devtools with a new UI and refactored internals to support multiple Vue versions. The new version is currently in beta and only supports Vue 3 (for now). Vuex and Router integration is also work in progress.

IDE Support

It is recommended to use VSCode. There are currently two viable extensions for Single-File Components (SFCs) support:

  • Vetur (recommended if you are used to Vetur features)
  • Volar (recommended if using TypeScript with SFCs, or <script setup> syntax)

TypeScript Support

  • All Vue 3 packages ship with types.
  • vue-tsc perform TypeScript type checks / diagnostics on Vue SFCs via the command line.
  • vue-dts-gen: generate TypeScript definitions from Vue SFCs.

Other Projects

Project NPM Repo
@vue/babel-plugin-jsx rc [GitHub]
eslint-plugin-vue stable [GitHub]
@vue/test-utils beta [GitHub]
vue-class-component beta [GitHub]
vue-loader beta [GitHub]
rollup-plugin-vue beta [GitHub]