SilverBullet TreeView plug

This plugs adds a tree view that allows you to navigate your SilverBullet pages Hierarchically.

Dragging-and-dropping files and folders is supported but requires SilverBullet v0.7.2 or greater. If running < v0.7.2, this feature will be automatically disabled (regardless of configuration).

Installation

Use the Plugs: Add command and enter the following URI:

github:joekrill/silverbullet-treeview/treeview.plug.js

or

Open (cmd+k) your PLUGS note in SilverBullet and add this plug to the list:

- github:joekrill/silverbullet-treeview/treeview.plug.js

Then run the Plugs: Update command and off you go!

Configuration

This plug can be configured using the SETTINGS page (default values shown):

treeview:
  # Determines where the panel is displayed:
  # - "lhs" - left hand side
  # - "rhs" - right hand side
  # - "bhs" - bottom
  # - "modal" - in a modal
  position: lhs

  # Must be > 0.
  # position = "lhs" | "rhs": determines the width of the panel.
  # position = "modal": sets the margin around the modal window.
  # position = "bhs": No effect
  size: 1

  dragAndDrop:
    # Set to false to disable drag-and-drop
    enabled: true

    # Set to false to disable the confirmation prompt shown when dragging and
    # dropping pages that causes them to be renamed/moved.
    confirmOnRename: true

  # Regular Expression string to exclude pages from the tree
  # - Any page that is all-caps: "^[A-Z]+$"
  # - A specific set of pages: "^(?:SETTINGS|PLUGS|index|Library)$"
  # - Any path containing Hidden: "Hidden" e.g. test/Hidden/page1
  pageExcludeRegex: "^(?:SETTINGS|PLUGS|index|Library)$"

Adding a top bar toggle icon

You can add add a button to the top bar that will toggle the tree view by adding the following to your actionButtons array in your SETTINGS page:

actionButtons:
- icon: sidebar
  command: "{[Tree View: Toggle]}"
  description: "Toggle Tree View"

Build

To build this plug, make sure you have SilverBullet installed. Then, build the plug with:

deno task build

Or to watch for changes and rebuild automatically

deno task watch

Then, copy the resulting .plug.js file into your space's _plug folder. Or build and copy in one command:

deno task build && cp *.plug.js /my/space/_plug/

SilverBullet will automatically sync and load the new version of the plug (or speed up this process by running the {[Sync: Now]} command).

Development

SortableTree

The tree component used is Marc Anton Dahmen's SortableTree component (Github Repo).

Latest build files can be found here (replace them in assets/sortable-tree to upgrade):

• https://unpkg.com/sortable-tree/dist/sortable-tree.js
• https://unpkg.com/sortable-tree/dist/sortable-tree.css