Skip to content

Commit 63589c7

Browse files
committed
build: update API generator
1 parent 30a98e3 commit 63589c7

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

build/templates/component.js

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
'use strict'
22

33
module.exports = (renderedUsage, doc, config, fileName, requiresMd, { isSubComponent, hasSubComponents }) => {
4-
const { displayName, description, docsBlocks, tags, functional } = doc;
4+
const { displayName, description, tags, functional } = doc;
55
const { deprecated, author, since, version, see, link } = tags || {};
66
const frontMatter = [];
77
if (!config.outFile && deprecated) {
@@ -25,6 +25,12 @@ ${isSubComponent || hasSubComponents ? '#' : ''}### ${deprecated ? `~~${displayN
2525
${deprecated ? `> **Deprecated** ${deprecated[0].description}\n` : ''}
2626
${description ? '> ' + description : ''}
2727
28+
\`\`\`jsx
29+
import { ${displayName} } from '@coreui/vue'
30+
// or
31+
import ${displayName} from '@coreui/vue/src/components/${fileName.replace('.ts', '')}'
32+
\`\`\`\n
33+
2834
${functional ? renderedUsage.functionalTag : ''}
2935
${author ? author.map(a => `Author: ${a.description}\n`) : ''}
3036
${since ? `Since: ${since[0].description}\n` : ''}
@@ -36,7 +42,6 @@ ${renderedUsage.props}
3642
${renderedUsage.methods}
3743
${renderedUsage.events}
3844
${renderedUsage.slots}
39-
${docsBlocks ? '---\n' + docsBlocks.join('\n---\n') : ''}
4045
4146
${requiresMd.length
4247
? '---\n' + requiresMd.map(component => component.content).join('\n---\n')

0 commit comments

Comments
 (0)