ed0f27c05f
loadQuartzConfig() internally calls loadQuartzLayout() to build the PageTypeDispatcher, which instantiates components. Plugin option overrides must be registered before this happens. Updated quartz.ts and all doc snippets that show the ExternalPlugin override pattern to place calls before loadQuartzConfig(). Also updated OxHugo and Roam docs from stale v4 plugins pattern to v5 override pattern.
67 lines
2.0 KiB
Markdown
67 lines
2.0 KiB
Markdown
---
|
|
title: Explorer
|
|
tags:
|
|
- plugin/component
|
|
image:
|
|
---
|
|
|
|
File tree explorer sidebar.
|
|
|
|
> [!note]
|
|
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
|
|
|
|
See [[plugins/Explorer]] for detailed usage information.
|
|
|
|
## Configuration
|
|
|
|
This plugin accepts the following configuration options:
|
|
|
|
**YAML options** (in `quartz.config.yaml`):
|
|
|
|
- `title`: The title of the explorer. Defaults to `Explorer`.
|
|
- `folderClickBehavior`: The behavior when a folder is clicked. Can be `"link"` to navigate or `"collapse"` to toggle. Defaults to `link`.
|
|
- `folderDefaultState`: The default state of folders. Can be `"collapsed"` or `"open"`. Defaults to `collapsed`.
|
|
- `useSavedState`: Whether to use local storage to save the state of the explorer. Defaults to `true`.
|
|
|
|
**TS override options** (in `quartz.ts`, for callback functions that can't be expressed in YAML):
|
|
|
|
- `sortFn`: Custom sort function for ordering files and folders.
|
|
- `filterFn`: Custom filter function to exclude specific nodes.
|
|
- `mapFn`: Custom map function to transform node properties (e.g. display names).
|
|
- `order`: Array controlling the order of operations. Defaults to `["filter", "map", "sort"]`.
|
|
|
|
### Default options
|
|
|
|
```yaml title="quartz.config.yaml"
|
|
- source: github:quartz-community/explorer
|
|
enabled: true
|
|
options:
|
|
title: Explorer
|
|
folderClickBehavior: link
|
|
folderDefaultState: collapsed
|
|
useSavedState: true
|
|
```
|
|
|
|
### TS override example
|
|
|
|
```ts title="quartz.ts"
|
|
import * as ExternalPlugin from "./.quartz/plugins"
|
|
|
|
// Must be placed before loadQuartzConfig()
|
|
ExternalPlugin.Explorer({
|
|
mapFn: (node) => {
|
|
node.displayName = node.displayName.toUpperCase()
|
|
return node
|
|
},
|
|
})
|
|
```
|
|
|
|
See [[features/explorer#Advanced customization]] for more examples.
|
|
|
|
## API
|
|
|
|
- Category: Component
|
|
- Function name: `ExternalPlugin.Explorer()`.
|
|
- Source: [`quartz-community/explorer`](https://github.com/quartz-community/explorer)
|
|
- Install: `npx quartz plugin add github:quartz-community/explorer`
|