Skip to content

Plugin for Obsidian providing a flexible way to create context-aware toolbars for your notes.

License

Notifications You must be signed in to change notification settings

Coastalbee/obsidian-note-toolbar

 
 

Repository files navigation

Note Toolbar Obsidian Plugin

GitHub Release GitHub Release Obsidian Downloads License "Buy Me A Coffee"

The Note Toolbar plugin for Obsidian lets you create context-aware toolbars for your notes, which can include commands, links to vault files and folders, websites/URIs, and menus.

With this plugin, you also get Note Toolbar Callouts which you can add anywhere within your notes.

📖 How to use this plugin: User Guide

Demo of a sticky toolbar

More options on mobile:

Mobile options for accessing the toolbar

Features

For the latest additions, see the Release Notes.

  • Create toolbars with items that link to commands, files/folders, URIs/URLs, and have menus.
  • Define where and how toolbars are displayed: Based on their folders, or a user-defined property
    • Position each toolbar below the Properties section, at the top of notes, as a floating button (on mobile)
    • Access the toolbar from the navigation bar (on mobile)
    • Toolbar items can use Obsidian's built-in icons, labels (which can include emojis), or a mix of both
    • Set optional tooltips for each item
    • Show items specifically on mobile, desktop, or both
    • Choose whether the icon, label, or both are displayed
  • Variables let you sub in the note's title or properties into URIs
  • Note Toolbar Callouts let you create and place toolbars anywhere within your notes
  • Style toolbars by adding borders, sticking to the top of your note on scroll, making them look like buttons, and aligning items (left, right, centered, evenly spaced)
    • Change or override these styles on mobile (i.e, phone and tablet)
    • Use any icon for the floating button or nav bar (on mobile)
    • Or use the Style Settings plugin for even more options (colors, positioning, sizing, etc.)
  • Commands to completely toggle hiding of note properties, and to quickly access toolbar configuration
  • Keyboard controls available via the Note Toolbar: Focus command
  • Right-click toolbars to quickly change the position, or to access configuration

Installation

Click here or:

  1. Open Obsidian's settings, and click Community plugins
  2. Search for Note Toolbar and select it
  3. Install
Installing beta versions via BRAT
BRAT lets you beta-test plugins, to provide feedback.

As beta versions become available, I welcome your feedback and any issues you uncover!

  1. Install the BRAT plugin:
    • Open Settings > Community Plugins
    • Disable safe mode, if enabled
    • Browse, and search for "BRAT"
    • Install the latest version of Obsidian 42 - BRAT
  2. Open BRAT settings (Settings -> Obsidian 42 - BRAT)
  3. Scroll to the Beta Plugin List section
  4. Add Beta Plugin
  5. Specify this repository: chrisgurney/obsidian-note-toolbar
  6. Enable the Note Toolbar plugin (Settings > Community plugins)
  7. Restart Obsidian, or re-open your vault.
  8. In Note Toolbar's settings, confirm the version number at the top is the latest beta version.

Getting Started 🚀

Once enabled, open Note Toolbar's settings:

  1. Create a + New toolbar
  2. Give the toolbar a name.
  3. + Add toolbar item
  4. Exit settings, and open a note.
  5. Add a notetoolbar property. Set it to the name of your toolbar.

If you want your toolbar to show without using a property, try mapping a folder (like wherever your Daily Notes are stored) to your new toolbar.

Example

Example Daily Notes toolbar including Daily Notes navigation, and multiple command shortcuts

📖 See the User Guide for detailed instructions, and for more examples.

Let me know how you use your toolbars!

User Guide

📖 See the User Guide.

Once installed, in Obsidian go to: Settings... > Note Toolbar and click + New toolbar.

Example of settings configuration

Example of settings for a toolbar

License

Note Toolbar is licensed under Apache License Version 2.0. See the LICENSE.

Inspiration and Thanks 🙏

Shout out to other projects and people who helped me with questions I had while developing this plugin:

  • Obsidian's Sample Plugin, developer docs and this playlist.
  • Templater - for code, especially around settings.
  • Periodic Notes - for code, and one of the reasons this plugin works well for my own needs... and for liam.cain's help!
  • BRAT - for the means to beta test this plugin.
  • Everybody on the Obsidian Discord #plugin-dev channel for their time and documentation, including but not limited to: claremacrae, dovos, lemons_dev, liam.cain, joethei, sailKite, SkepticMystic

Contribute 🧑‍💻

Happy to discuss your ideas! Pull requests are welcome!

Support 🛟

📖 See Troubleshooting in the User Guide.

Ask questions here or request a feature. If you run into something that looks like a bug, please log an issue.

If you find this plugin useful, and wish to support me financially, I accept donations. Thank you!

About

Plugin for Obsidian providing a flexible way to create context-aware toolbars for your notes.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 78.8%
  • CSS 20.4%
  • JavaScript 0.8%