Explorer

summary:

• File tree explorer sidebar.
• Details: Explorer

Note

Plugin management: Configuration

Configuration

yaml_options (quartz.config.yaml):

• title: title; default Explorer
• folderClickBehavior: click action; link navigates, collapse toggles; default link
• folderDefaultState: initial state; collapsed or open; default collapsed
• useSavedState: persist state in localStorage; default true

ts_override_options (quartz.ts):

• sortFn: custom file/folder sort
• filterFn: custom node exclusion
• mapFn: custom node property transform
• order: operation order; default ["filter", "map", "sort"]

default_config:

quartz.config.yaml

- source: github:quartz-community/explorer
  enabled: true
  options:
    title: Explorer
    folderClickBehavior: link
    folderDefaultState: collapsed
    useSavedState: true

ts_override_example:

quartz.ts

import * as ExternalPlugin from "./.quartz/plugins"
 
// Must be placed before loadQuartzConfig()
ExternalPlugin.Explorer({
  mapFn: (node) => {
    node.displayName = node.displayName.toUpperCase()
    return node
  },
})

examples:

• explorer > Advanced customization

API

api:

• category: Component
• function: ExternalPlugin.Explorer()
• source: quartz-community/explorer
• install: npx quartz plugin add github:quartz-community/explorer