Home

Awesome

vue-types

Prop type definitions for Vue.js.

<p id="badges"> <a href="https://www.npmjs.com/package/vue-types" target="_blank"> <img alt="NPM package version" src="https://img.shields.io/npm/v/vue-types" /> </a> <a href="https://circleci.com/gh/dwightjack/vue-types" target="_blank"> <img alt="CircleCI status" src="https://circleci.com/gh/dwightjack/vue-types.svg?style=shield" /> </a> <a href="https://www.npmjs.com/package/vue-types" target="_blank"> <img alt="Code coverage" src="https://img.shields.io/codeclimate/dwightjack/vue-types" /> </a> </p>

Note: This document is for VueTypes 5. If you are looking for an older versions, refer to the v1~v4 branches.

Introduction

vue-types is a collection of configurable prop type definitions for Vue.js components, inspired by React's prop-types.

Try it now! or learn more at the official documentation site.

Run examples

  1. Install dependencies: pnpm install
  2. Run script: pnpm run examples:dev
  3. Wait for the server and bundler to start-up

Run docs on localhost

  1. Install dependencies: pnpm install
  2. Run script: pnpm run docs:dev

Contributing

  1. Clone this repository
  2. Install dependencies: pnpm install
  3. Make your changes
  4. Update or add tests in packages/core/__tests__/
  5. Verify that everything works: pnpm -r run lint && pnpm -r test
  6. Submit a Pull Request

License

MIT

Copyright (c) 2016 - present Marco Solazzi