Skip to content
A Vue.js UI Toolkit that integrates with the WordPress dashboard to build admin pages.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.storybook register addons for documentation Apr 25, 2019
public init Apr 24, 2019
src fix multiple links Jul 16, 2019
stories added page header component Jul 16, 2019
tests/unit added tabs and modal tests Apr 25, 2019
.browserslistrc init Apr 24, 2019
.editorconfig test button component Apr 24, 2019
.eslintrc.js init Apr 24, 2019
.gitignore ignore storybook build Apr 25, 2019
LICENSE Create LICENSE Apr 25, 2019
README.md updated badges Apr 25, 2019
babel.config.js init Apr 24, 2019
jest.config.js init Apr 24, 2019
package.json fix multiple links Jul 16, 2019
postcss.config.js init Apr 24, 2019
vue.config.js prepare for production release Apr 25, 2019
yarn.lock added page header component Jul 16, 2019

README.md

Vue WordPress Components

Netlify Status NPM GitHub package.json version

Vue WordPress components is a simple, lightweight Vue.js UI Toolkit that integrates with the WordPress dashboard to build admin pages.

This is an opinionanted set of components that I use in the majority of my WordPress projects, therefore it made sense to merge the components into a library.

Installation

Install Vue WordPress Components through npm or yarn

npm i vue-wp-components
yarn add vue-wp-components

Import or require Vue and Vue WordPress components in your code:

import Vue from 'vue'
import VueWPComponents from 'vue-wordpress-components'
import 'vue-wordpress-components/dist/vue-wordpress-components.min.css'

Vue.use(VueWPComponents)

Demo and Documentation

https://vue-wordpress-components.netlify.com/

Documentation can be found under the "Notes" tab of each component.

Development setup

Install dependencies
yarn install
Use storybook.js for preview
yarn storybook
Compiles and hot-reloads for development
yarn run serve
Compiles and minifies for production
yarn run build
Lints and fixes files
yarn run lint
Run your unit tests
yarn run test:unit

Customize configuration

See Configuration Reference.

You can’t perform that action at this time.