From dcdeae4e7bd527945b887ca347b3b4408c03055b Mon Sep 17 00:00:00 2001
From: Ben Schlegel <31989404+benschlegel@users.noreply.github.com>
Date: Thu, 21 Sep 2023 16:53:19 +0000
Subject: [PATCH] docs(explorer): update default config + new example (#493)
---
docs/features/explorer.md | 12 +++++++++++-
1 files changed, 11 insertions(+), 1 deletions(-)
diff --git a/docs/features/explorer.md b/docs/features/explorer.md
index b0eb12d..f48ad1b 100644
--- a/docs/features/explorer.md
+++ b/docs/features/explorer.md
@@ -29,7 +29,7 @@
sortFn: (a, b) => {
... // default implementation shown later
},
- filterFn: undefined,
+ filterFn: filterFn: (node) => node.name !== "tags", // filters out 'tags' folder
mapFn: undefined,
// what order to apply functions in
order: ["filter", "map", "sort"],
@@ -160,6 +160,16 @@
You can customize this by changing the entries of the `omit` set. Simply add all folder or file names you want to remove.
+### Show every element in explorer
+
+To override the default filter function that removes the `tags` folder from the explorer, you can set the filter function to `undefined`.
+
+```ts title="quartz.layout.ts"
+Component.Explorer({
+ filterFn: undefined, // apply no filter function, every file and folder will visible
+})
+```
+
## Advanced examples
### Add emoji prefix
--
Gitblit v1.10.0