Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@vue-wordpress/core

vue-wordpess105MIT1.3.13TypeScript support: included

💫 Wordpress REST API plugin for Vue.js with out-of-box routing and data handling 💫

vue, vue.js, vuejs, vue-wp, vue-wordpress, wordpress, rest, api, wp, wordpress-rest-api, rest-api, wp-json

readme

Vue Wordpress Core Module


Vue.js module for WordPress, PWA ready, with full support for Vuex Store, Vue Router, Vue SSR and Nuxt.js https://vuewordpress.io/



Installation


Vue.js


1. Go to your app's main directory and run:

npm install @vue-wordpress/core

or


yarn add @vue-wordpress/core

2. Go to your app's main.js / main.ts file, import the module catalog and register it:


import  Vue  from  'vue'

import  Wordpress  from  '@vue-wordpress/core'

Vue.use(Wordpress, {
  config: {
    url:  'https://your-wordpress-url.com/',
    lang:  'en' // Your site's default language – It will be added to the html lang attribute.
  },
  store,
  router
  // Injecting VueX Store and Router is obligatory
})

And that is it – you are ready to go!


Nuxt.js


If you want to use this module with Nuxt.js, we have created a dedicated package available here: @vue-wordpress/nuxt


Vue Storefront


If you want to use this module with Vue Storefront, we have created a dedicated package available here: @vue-wordpress/vsf