https://github.com/dwightjack/vue-types

Vue Prop Types definitions
https://github.com/dwightjack/vue-types

nuxt nuxtjs props proptypes vue2 vue3 vuejs2 vuejs3

Last synced: about 2 months ago
JSON representation

Vue Prop Types definitions

• Host: GitHub
• URL: https://github.com/dwightjack/vue-types
• Owner: dwightjack
• License: mit
• Created: 2016-10-26T16:17:48.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T16:34:02.000Z (7 months ago)
• Last Synced: 2024-04-14T06:55:11.231Z (7 months ago)
• Topics: nuxt, nuxtjs, props, proptypes, vue2, vue3, vuejs2, vuejs3
• Language: TypeScript
• Homepage: https://dwightjack.github.io/vue-types/
• Size: 15.6 MB
• Stars: 551
• Watchers: 10
• Forks: 34
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vue-types

> Prop type definitions for [Vue.js](http://vuejs.org).



  

    

  

  

    

  



    

  



**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](https://vuejs.org/guide/components/props.html) definitions for Vue.js components, inspired by React's `prop-types`.

[Try it now!](https://stackblitz.com/edit/vitejs-vite-83cnar?file=src/App.vue) or learn more at the [official documentation site](https://dwightjack.github.io/vue-types/).

## 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

1. Install dependencies: `pnpm install`

1. Make your changes

1. Update or add tests in `packages/core/__tests__/`

1. Verify that everything works: `pnpm -r run lint && pnpm -r test`

1. Submit a Pull Request

## License

[MIT](http://opensource.org/licenses/MIT)

Copyright (c) 2016 - present Marco Solazzi