From b397dae95113b0eaaf8054adf951fc533791bd0d Mon Sep 17 00:00:00 2001
From: Stephen Tse <Stephen-X@users.noreply.github.com>
Date: Wed, 26 Mar 2025 15:32:13 +0000
Subject: [PATCH] Updating breadcrumbs docs on ConditionalRender (#1871)
---
docs/features/breadcrumbs.md | 1 -
docs/layout-components.md | 11 ++++++++++-
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/docs/features/breadcrumbs.md b/docs/features/breadcrumbs.md
index a701858..f354505 100644
--- a/docs/features/breadcrumbs.md
+++ b/docs/features/breadcrumbs.md
@@ -19,7 +19,6 @@
spacerSymbol: "❯", // symbol between crumbs
rootName: "Home", // name of first/root element
resolveFrontmatterTitle: true, // whether to resolve folder names through frontmatter titles
- hideOnRoot: true, // whether to hide breadcrumbs on root `index.md` page
showCurrentPage: true, // whether to display the current page in the breadcrumbs
})
```
diff --git a/docs/layout-components.md b/docs/layout-components.md
index 339ace8..09c2d76 100644
--- a/docs/layout-components.md
+++ b/docs/layout-components.md
@@ -81,4 +81,13 @@
})
```
-This example would only render the Search component when the page is not in fullpage mode.
+The example above would only render the Search component when the page is not in fullpage mode.
+
+```typescript
+Component.ConditionalRender({
+ component: Component.Breadcrumbs(),
+ condition: (page) => page.fileData.slug !== "index",
+})
+```
+
+The example above would hide breadcrumbs on the root `index.md` page.
--
Gitblit v1.10.0