Skip to content

Vue3: Use component's name as displayName if available #33428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sidnioulz merged 3 commits into from
Feb 23, 2026
Merged

Vue3: Use component's name as displayName if available #33428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8678ab
fix(vue3): use components name as displayName by default
huang-julien Dec 25, 2025
5d3ab31
fix: runtimedisplayName in vue-docgen-api
huang-julien Dec 28, 2025
e74960e
fix: apply suggestion
huang-julien Feb 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions code/frameworks/vue3-vite/src/plugins/vue-component-meta.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,9 @@ export async function vueComponentMeta(tsconfigPath = 'tsconfig.json'): Promise<
s.replace('export default ', 'const _sfc_main = ');
s.append('\nexport default _sfc_main;');
}

s.append(`\n;${name}.__docgenInfo = ${JSON.stringify(meta)}`);
s.append(`\n;${name}.__docgenInfo = Object.assign({
displayName: ${name}.name ?? ${name}.__name
}, ${JSON.stringify(meta)})`);
});

return {
Expand Down
4 changes: 3 additions & 1 deletion code/frameworks/vue3-vite/src/plugins/vue-docgen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ export async function vueDocgen(): Promise<Plugin> {
const metaData = await parse(id);

const s = new MagicString(src);
s.append(`;_sfc_main.__docgenInfo = ${JSON.stringify(metaData)}`);
s.append(`;_sfc_main.__docgenInfo = Object.assign({
displayName: _sfc_main.name ?? _sfc_main.__name
}, ${JSON.stringify(metaData)});`);

return {
code: s.toString(),
Expand Down