https://github.com/netsells/storybook-vue-generate-arg-types
https://github.com/netsells/storybook-vue-generate-arg-types
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/netsells/storybook-vue-generate-arg-types
- Owner: netsells
- Created: 2021-11-08T10:28:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-07T16:10:22.000Z (over 2 years ago)
- Last Synced: 2025-03-03T06:34:39.238Z (2 months ago)
- Language: JavaScript
- Size: 33.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @netsells/storybook-vue-generate-arg-types
This package provides a single function to generate your `argType` property on your storybook stories based on the props added to your component.
## Installation
```bash
$ yarn add -D @netsells/storybook-vue-generate-arg-types
```
## Usage
```js
// MyComponent.stories.js
import MyComponent from './MyComponent';
import generateArgTypes from '@netsells/storybook-vue-generate-arg-types';
export default {
// ...story config
argTypes: generateArgTypes(MyComponent),
};
```
If for any reason you'd like to override an arg type, you can pass an additional parameter of overrides:
```js
// MyComponent.stories.js
import MyComponent from './MyComponent';
import generateArgTypes from '@netsells/storybook-vue-generate-arg-types';
export default {
// ...story config
argTypes: generateArgTypes(MyComponent, {
myProp: {
control: 'number',
default: 5,
},
}),
};
```