alrayyes/wiki
1
0
Fork 0
mirror of https://github.com/alrayyes/wiki.git synced 2024-11-25 21:16:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs(explorer): update default config + new example (#493)

Browse source
This commit is contained in:
Ben Schlegel 2023-09-21 18:53:19 +02:00 committed by GitHub
parent 48452231d5
commit dcdeae4e7b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/features/explorer.md
View file

@ -29,7 +29,7 @@ Component.Explorer({
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 @@ Component.Explorer({
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