vue-docgen-cli/lib/templates/props.js

Generate documentation markdown files from VueJs components using the vue-docgen-api.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const utils_1 = require("./utils");
const tags_1 = require("./tags");
const tmpl = (props) => {
    let ret = '';
    props.forEach(pr => {
        const p = pr.name;
        let t = pr.description ?? '';
        t += (0, tags_1.renderTags)(pr.tags);
        const n = pr.type?.name ?? '-' + (pr.required ? ` (required)` : '');
        const v = pr.values?.map(pv => `\`${pv}\``).join(', ') ?? '-';
        const d = pr.defaultValue?.value ?? '';
        ret += `| ${(0, utils_1.mdclean)(p)} | ${(0, utils_1.mdclean)(t)} | ${(0, utils_1.mdclean)(n)} | ${(0, utils_1.mdclean)(v)} | ${(0, utils_1.mdclean)(d)} |\n`;
    });
    return ret;
};
exports.default = (props, opt = {}) => {
    return `
${opt.isSubComponent || opt.hasSubComponents ? '#' : ''}## Props

  | Prop name     | Description | Type      | Values      | Default     |
  | ------------- | ----------- | --------- | ----------- | ----------- |
  ${tmpl(props)}
  `;
};
//# sourceMappingURL=props.js.map