Skip to content

feat: allow VPContent to use custom components #5176

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
brc-dd merged 2 commits into from
Apr 8, 2026
+11 −8
Merged

feat: allow VPContent to use custom components #5176

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7bb037
feat: allow VPContent to use custom components
shigma Apr 8, 2026
4ee0955
feat: enhance layout resolution
shigma Apr 8, 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
19 changes: 11 additions & 8 deletions src/client/theme-default/components/VPContent.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<script setup lang="ts">
import { resolveComponent } from 'vue'
import NotFound from '../NotFound.vue'
import { useData } from '../composables/data'
import { useLayout } from '../composables/layout'
Expand All @@ -8,6 +9,11 @@ import VPPage from './VPPage.vue'

const { page, frontmatter } = useData()
const { isHome, hasSidebar } = useLayout()

function resolveLayout(name: string) {
const component = resolveComponent(name)
return typeof component === 'string' ? null : component
Copy link
Copy Markdown
Member

@brc-dd brc-dd Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could've just returned true/false I guess for this use case

}
</script>

<template>
Expand All @@ -18,12 +24,12 @@ const { isHome, hasSidebar } = useLayout()
>
<slot name="not-found" v-if="page.isNotFound"><NotFound /></slot>

<VPPage v-else-if="frontmatter.layout === 'page'">
<VPPage v-else-if="frontmatter.layout === 'page' && !resolveLayout('page')">
<template #page-top><slot name="page-top" /></template>
<template #page-bottom><slot name="page-bottom" /></template>
</VPPage>

<VPHome v-else-if="frontmatter.layout === 'home'">
<VPHome v-else-if="frontmatter.layout === 'home' && !resolveLayout('home')">
<template #home-hero-before><slot name="home-hero-before" /></template>
<template #home-hero-info-before><slot name="home-hero-info-before" /></template>
<template #home-hero-info><slot name="home-hero-info" /></template>
Expand All @@ -36,12 +42,7 @@ const { isHome, hasSidebar } = useLayout()
<template #home-features-after><slot name="home-features-after" /></template>
</VPHome>

<component
v-else-if="frontmatter.layout && frontmatter.layout !== 'doc'"
:is="frontmatter.layout"
/>

<VPDoc v-else>
<VPDoc v-else-if="(!frontmatter.layout || frontmatter.layout === 'doc') && !resolveLayout('doc')">
<template #doc-top><slot name="doc-top" /></template>
<template #doc-bottom><slot name="doc-bottom" /></template>

Expand All @@ -56,6 +57,8 @@ const { isHome, hasSidebar } = useLayout()
<template #aside-ads-after><slot name="aside-ads-after" /></template>
<template #aside-bottom><slot name="aside-bottom" /></template>
</VPDoc>

<component v-else :is="frontmatter.layout || 'doc'" />
</div>
</template>

Expand Down
Loading