Package Exports
- vue-docgen-api
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-docgen-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
vue-docgen-api
vue-docgen-api
is a toolbox to help extracting information from Vue components, and generate documentation from it.
Use babel and jsdoc-api to compile the code and analyze the contents of the component extracting methods and props. The output is a JavaScript object.
Install
Install the module directly from npm:
npm install vue-docgen-api --save-dev
API
The tool can be used programmatically to extract component information and customize the extraction process:
var vueDocs = require('vue-docgen-api');
var componentInfo = vueDocs.parse(filePath);
parse(filePath)
Parameter | Type | Description |
---|---|---|
filePath | string | The file path |
Using JSDoc tags
You can use the following JSDoc tags when documenting components, props and methods.
Example
For the following component
<template>
<div>
<!-- @slot Use this slot header -->
<slot name="header"></slot>
<table class="grid">
<!-- -->
</table>
<!-- @slot Use this slot footer -->
<slot name="footer"></slot>
</div>
</template>
<script>
import { text } from './utils';
/**
* This is an example of creating a reusable grid component and using it with external data.
* @version 1.0.5
* @author [Rafael](https://github.com/rafaesc92)
* @since Version 1.0.1
*/
export default {
name: 'grid',
props: {
/**
* object/array defaults should be returned from a factory function
* @version 1.0.5
* @since Version 1.0.1
* @see See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names
* @link See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names
*/
msg: {
type: [String, Number],
default: text
},
/**
* Model example
* @model
*/
value: {
type: String
}
/**
* describe data
* @version 1.0.5
*/
data: [Array],
/**
* get columns list
*/
columns: [Array],
/**
* filter key
* @ignore
*/
filterKey: {
type: String,
default: 'example'
}
},
data () {
var sortOrders = {}
this.columns.forEach(function (key) {
sortOrders[key] = 1
})
return {
sortKey: '',
sortOrders: sortOrders
}
},
computed: {
filteredData: function () {
var sortKey = this.sortKey
var filterKey = this.filterKey && this.filterKey.toLowerCase()
var order = this.sortOrders[sortKey] || 1
var data = this.data
if (filterKey) {
data = data.filter(function (row) {
return Object.keys(row).some(function (key) {
return String(row[key]).toLowerCase().indexOf(filterKey) > -1
})
})
}
if (sortKey) {
data = data.slice().sort(function (a, b) {
a = a[sortKey]
b = b[sortKey]
return (a === b ? 0 : a > b ? 1 : -1) * order
})
}
return data
}
},
filters: {
capitalize: function (str) {
return str.charAt(0).toUpperCase() + str.slice(1)
}
},
methods: {
/**
* Sets the order
*
* @public
* @version 1.0.5
* @since Version 1.0.1
* @param {string} key Key to order
* @returns {string} Test
*/
sortBy: function (key) {
this.sortKey = key
this.sortOrders[key] = this.sortOrders[key] * -1;
/**
* Success event.
*
* @event success
* @type {object}
*/
this.$emit('success', {
demo: 'example',
})
},
hiddenMethod: function(){
}
}
}
</script>
we are getting this output:
{
"description": "This is an example of creating a reusable grid component and using it with external data.",
"methods": [
{
"name": "sortBy",
"comment": "/**\n * Sets the order\n *\n * @public\n * @version 1.0.5\n * @since Version 1.0.1\n * @param {string} key Key to order\n * @returns {string} Test\n */",
"modifiers": [],
"params": [
{
"name": "key",
"description": "Key to order",
"type": {
"name": "string"
}
}
],
"returns": {
"description": "Test",
"type": {
"name": "string"
}
},
"description": "Sets the order",
"tags": {
"access": [
{
"title": "access",
"description": "public"
}
],
"params": [
{
"title": "param",
"description": "Key to order",
"name": "key",
"type": {
"type": "NameExpression",
"name": "string"
}
}
],
"returns": [
{
"title": "returns",
"description": "Test",
"type": {
"type": "NameExpression",
"name": "string"
}
}
],
"since": [
{
"title": "since",
"description": "Version 1.0.1"
}
],
"version": [
{
"title": "version",
"description": "1.0.5"
}
]
}
}
],
"displayName": "grid",
"props": {
"msg": {
"type": {
"name": "string|number"
},
"required": "",
"defaultValue": {
"value": "\"this is a secret\"",
"computed": false
},
"tags": {
"see": [
{
"title": "see",
"description": "See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names"
}
],
"since": [
{
"title": "since",
"description": "Version 1.0.1"
}
],
"version": [
{
"title": "version",
"description": "1.0.5"
}
],
"link": [
{
"title": "link",
"description": "See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names"
}
]
},
"comment": "/**\n * object/array defaults should be returned from a factory function\n * @version 1.0.5\n * @since Version 1.0.1\n * @see See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names\n * @link See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names\n */",
"description": "object/array defaults should be returned from a factory function"
},
"v-model": {
"type": {
"name": "string"
},
"description": "Model example"
},
"data": {
"type": {
"name": "array"
},
"description": "describe data"
},
"columns": {
"type": {
"name": "array"
},
"description": "get columns list"
},
"filterKey": {
"type": {
"name": "string"
},
"required": "",
"defaultValue": {
"value": "\"example\"",
"computed": false
},
"tags": {
"ignore": [
{
"title": "ignore",
"description": true
}
]
},
"comment": "/**\n * filter key\n * @ignore\n */",
"description": "filter key"
}
},
"comment": "/**\n * This is an example of creating a reusable grid component and using it with external data.\n * @version 1.0.5\n * @author [Rafael](https://github.com/rafaesc92)\n * @since Version 1.0.1\n */",
"tags": {
"author": [
{
"title": "author",
"description": "[Rafael](https://github.com/rafaesc92)"
}
],
"since": [
{
"title": "since",
"description": "Version 1.0.1"
}
],
"version": [
{
"title": "version",
"description": "1.0.5"
}
]
},
"events": {
"success": {
"description": "Success event.",
"type": {
"names": [
"object"
]
},
"comment": "/**\n * Success event.\n *\n * @event success\n * @type {object}\n */"
}
},
"slots": {
"header": {
"description": "Use this slot header"
},
"footer": {
"description": "Use this slot footer"
}
}
}
Mixins or Extends
If you import a mixin or extends, for it to be documented you need to add in the header the mixin tag @mixin, for example
Case Mixin:
// src/mixins/colorMixin.js
/**
* @mixin
*/
module.exports = {
props: {
/**
* The color for the button example
*/
color: {
type: String,
default: '#333'
},
}
}
Case Extends:
// src/extends/Base.vue
<template>
<div>
<h4>{{ color }}</h4>
<!--the appropriate input should go here-->
</div>
</template>
<script>
/**
* @mixin
*/
export default {
props: {
/**
* The color for the button example
*/
colorExtends: {
type: String,
default: '#333'
},
},
}
</script>
<template>
<!-- -->
</template>
<script>
// src/components/Button/Button.vue
import colorMixin from '../../mixins/colorMixin';
import Base from '../../extends/Base';
export default {
name: 'buttonComponent',
mixins: [colorMixin],
extends: Base,
props: {
/**
* The size of the button
* `small, normal, large`
*/
size: {
default: 'normal'
},
/**
* Add custom click actions.
**/
onCustomClick: {
default: () => () => null,
},
},
/* ... */
}
</script>
Events
/**
* Success event.
*
* @event success
* @type {object}
*/
this.$emit('success', {
demo: 'example',
})
Slots
<template>
<div>
<!-- @slot Use this slot header -->
<slot name="header"></slot>
<!-- @slot Use this slot footer -->
<slot name="footer"></slot>
</div>
</template>
Change log
The change log can be found on the Releases page.
Authors and license
MIT License.