Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.64 KB

README.md

File metadata and controls

50 lines (34 loc) · 1.64 KB
Raw

vue-types

Prop type definitions for Vue.js.

NPM package version CircleCI status Code coverage

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