The sidebar plugin draws the left column of the app, labelled Sidebar, and the narrow strip of icons the column collapses to.1
Using the column day to day is The sidebar, tabs and the palette.
What the column shows
Top to bottom:2
| Entry | Added by |
|---|---|
| Agenda, with what is overdue or due today folded under it while there is any, then Today with the month under it | The journal: a calendar, day pages and an agenda |
| Inbox | Capture |
| Needs you and Chats3 | Talking to an agent from a row or a page |
| Plugins | vault-plugins: running the plugins your directory defines |
| Pinned | Pins |
Outlines, Reference and the olai group of _olai/ files |
The file list in the sidebar |
| Trash, pinned under the scrolling list | Trash |
The strip of icons
Collapsing the column leaves a narrow strip of icons, also named Sidebar. Expand sidebar is at the top, and the icons of the entries above follow in the same order.4
To open and close the column, press Cmd + \ (Ctrl + \ away from a Mac), run Toggle sidebar in the command palette, or tap the burger button on a phone.5
Headings
Every heading in the column is drawn the same way.6 Some headings carry a button.7 A section with nothing in it either draws nothing or draws a line of its own.8
How other plugins add to the column
A plugin that adds something asks for a named place, such as foot, and never for a pixel position or a place next to a named plugin. Trash sits at the bottom because the trash plugin asked for foot.9 The named places are listed in the block at the foot of this page.
Switching sidebar off removes the column and the strip of icons, and leaves the open page and its editor exactly as they are. It fills the layout.sidebar place in the app frame (Layout).
Every place in the sidebar another plugin can fill
| Place | Takes |
|---|---|
sidebar.entry |
an entry placed top (the first entries in the column), bottom (after the plugin sections) or foot (pinned under the list), with an icon for the collapsed strip if it wants one |
sidebar.section |
a heading in the plugin’s own words, and what sits under it |
sidebar.regions |
a region of the column: primary, shelf or files |
sidebar.rail |
an icon on the collapsed strip |
Footnotes
-
The sidebar plugin has no files and no data of its own. Every entry, heading and section in the column comes from another plugin, and the sidebar only decides where each one stands. ↩
-
On a phone the column is a drawer that slides in. Its foot sits above the drawer’s own foot, which carries the Preferences and Plugins entries. On a desktop the foot shares a line with Collapse sidebar. ↩
-
A Chats row is named after the row or the file its chat is about, with that agent’s mark beside it. Clicking it opens the chat’s own page, and the row’s two-column button, Open beside, puts that page in the pane to the right on a desktop. A document whose chat is set to open beside brings the document along; everything else opens alone (Talking to an agent from a row or a page). ↩
-
An entry placed
foothas its icon sink to the bottom of the strip. Each icon carries two labels, which differ on purpose: the tooltip a pointer or the keyboard shows (Outlines), and the name a screen reader and the tests read (Open outlines). Neither of them is the browser’s owntitleattribute, which the browser places itself and shows only to a pointer. ↩ -
On a phone the burger button is named Show sidebar and Hide sidebar.
Reset sidebar widthin the palette puts a column you have dragged back to its default width. ↩ -
How a heading is drawn: the words are written in sentence case and drawn as small, widely spaced capitals, so a test or a screen reader reads
Outlines, notOUTLINES. ↩ -
The buttons on headings: the
+beside Chats opens the palette at New chat, the+beside Plugins opens it at New plugin, and the+beside Outlines opens the menu for making a new file. The plugin that owns a heading draws its button too, so the heading and the button leave together when that plugin is switched off. ↩ -
An empty section: Pinned draws nothing at all until there is something in it, while Chats keeps its heading and its
+with no chats yet. Plugins is always drawn, whatever the directory holds, with one entry reading Ask for your first plugin…, because a directory with no plugins is where somebody is looking for the way to make one (vault-plugins: running the plugins your directory defines). ↩ -
While the sidebar plugin or the layout plugin is switched off, what other plugins contribute to the column waits, and comes back when the sidebar returns. Those plugins keep running and doing the rest of their work meanwhile. ↩