https://github.com/danielroe/nuxt-vue3-module
https://github.com/danielroe/nuxt-vue3-module
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/danielroe/nuxt-vue3-module
- Owner: danielroe
- License: mit
- Archived: true
- Created: 2021-06-08T15:04:07.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-13T23:22:32.000Z (over 1 year ago)
- Last Synced: 2025-03-18T10:49:19.905Z (over 1 year ago)
- Language: TypeScript
- Size: 1000 KB
- Stars: 21
- Watchers: 3
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# nuxt-vue3
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]
> Enable Vue 3 (compat) mode in your Nuxt project
**This module enables Vue 3 compatibility mode in your Nuxt 2 project. It is _unofficial_ and purely for exploring the Vue 3 API. Take a look at [the instructions here](https://github.com/vuejs/vue-next/blob/master/packages/vue-compat/README.md) for more information on how to use the compatibility build.**
## Features
- [x] Client-side webpack support
- [x] Nuxt features: `asyncData`, `validate`, layouts, middleware, plugins, etc.
- [x] Vue 3 features: `script setup`, `composables`
- [ ] Client-side vite support
- [ ] Server-side support
## Known limitations and workarounds
- You will need to use `` instead of ``
**Note**: This library overrides your `client.js` template from `@nuxt/vue-app`
## Not (yet) supported
- new-style `fetch()`
- `` in the same component as `script setup`
- Vue 2 Composition API (either `@vue/composition-api` or `@nuxtjs/composition-api`)
## Quick setup
1. Add `nuxt-vue3` dependency to your project
```bash
yarn add nuxt-vue3 # or npm install nuxt-vue3
```
2. Add `nuxt-vue3` to the `buildModules` section of `nuxt.config.js`
```js
{
buildModules: [
'nuxt-vue3',
]
}
```
3. Run `nuxt`!
## Development
1. Clone this repository
2. Install dependencies using `yarn install`
3. Start development server using `yarn dev`
## License
[MIT License](./LICENSE)
[npm-version-src]: https://img.shields.io/npm/v/nuxt-vue3/latest.svg
[npm-version-href]: https://npmjs.com/package/nuxt-vue3
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-vue3.svg
[npm-downloads-href]: https://npmjs.com/package/nuxt-vue3
[github-actions-ci-src]: https://github.com/danielroe/nuxt-vue3-module/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/danielroe/nuxt-vue3-module/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/danielroe/nuxt-vue3-module.svg
[codecov-href]: https://codecov.io/gh/danielroe/nuxt-vue3-module
[license-src]: https://img.shields.io/npm/l/nuxt-vue3.svg
[license-href]: https://npmjs.com/package/nuxt-vue3