Skip to content

Commit dd0c4c6

Browse files
dominikczbrc-dd
andauthored
feat(theme): support disabling aside globally (#1925)
Co-authored-by: Divyansh Singh <[email protected]>
1 parent 4a19dde commit dd0c4c6

File tree

3 files changed

+19
-4
lines changed

3 files changed

+19
-4
lines changed

docs/config/theme-configs.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,13 @@ export type SidebarItem = {
157157
}
158158
```
159159
160+
## aside
161+
162+
- Type: `boolean`
163+
- Default: `true`
164+
165+
Setting this value to `false` prevents rendering of aside container.
166+
160167
## outline
161168
162169
- Type: `number | [number, number] | 'deep' | false`
@@ -300,7 +307,7 @@ An option to support searching your docs site using [Algolia DocSearch](https://
300307

301308
```ts
302309
export interface AlgoliaSearchOptions extends DocSearchProps {
303-
locales?: Record<string, Partial<DocSearchProps>>
310+
locales?: Record<string, Partial<DocSearchProps>>
304311
}
305312
```
306313

src/client/theme-default/composables/sidebar.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,10 @@ export function useSidebar() {
5050
})
5151

5252
const hasAside = computed(() => {
53-
return (
54-
frontmatter.value.layout !== 'home' && frontmatter.value.aside !== false
55-
)
53+
if (frontmatter.value.layout === 'home') return false
54+
if (frontmatter.value.aside != null) return !!frontmatter.value.aside
55+
if (theme.value.aside === false) return false
56+
return true
5657
})
5758

5859
const isSidebarEnabled = computed(() => hasSidebar.value && is960.value)

types/default-theme.d.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,13 @@ export namespace DefaultTheme {
4747
*/
4848
sidebar?: Sidebar
4949

50+
/**
51+
* Set to `false` to prevent rendering of aside container.
52+
*
53+
* @default true
54+
*/
55+
aside?: boolean
56+
5057
/**
5158
* Info for the edit link. If it's undefined, the edit link feature will
5259
* be disabled.

0 commit comments

Comments
 (0)