Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/chrisgurney/obsidian-note-toolbar

Create flexible, context-aware toolbars for your notes with this plugin for Obsidian.
https://github.com/chrisgurney/obsidian-note-toolbar

obsidian obsidian-md obsidian-plugin toolbar

Last synced: 4 days ago
JSON representation

Create flexible, context-aware toolbars for your notes with this plugin for Obsidian.

Awesome Lists containing this project

README 

        
![Note Toolbar Obsidian Plugin](./docs/images/readme_banner.png)



[![GitHub Release](https://img.shields.io/github/v/release/chrisgurney/obsidian-note-toolbar?sort=semver)](https://github.com/chrisgurney/obsidian-note-toolbar/releases/latest) [![GitHub Release](https://img.shields.io/github/v/release/chrisgurney/obsidian-note-toolbar?include_prereleases&label=latest)](https://github.com/chrisgurney/obsidian-note-toolbar/releases) [![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?logo=obsidian&color=%23483699&label=downloads&query=%24%5B%22note-toolbar%22%5D.downloads&url=https%3A%2F%2Fraw.githubusercontent.com%2Fobsidianmd%2Fobsidian-releases%2Fmaster%2Fcommunity-plugin-stats.json)](https://obsidian.md/plugins?id=note-toolbar) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [!["Buy Me A Coffee"](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee)](https://www.buymeacoffee.com/cheznine)



The Note Toolbar plugin for [Obsidian](https://obsidian.md) lets you create context-aware toolbars for your notes, which can include commands, links to vault files and folders, websites/URIs, menus, and scripts (Dataview, Templater, and JavaScript).



Wondering what's new? See the [Release Notes](https://github.com/chrisgurney/obsidian-note-toolbar/releases)



Wondering what's ahead? See the [Roadmap](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Roadmap)



**Jump to:**



- [Features](#features)

- [Installation](#installation)

- [Getting Started](#getting-started-)

- [Gallery](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Gallery)

- [User Guide](https://github.com/chrisgurney/obsidian-note-toolbar/wiki)



![Demo of a sticky toolbar](./docs/images/note_toolbar_demo.gif)



More options on mobile:



![Mobile options for accessing the toolbar](./docs/images/mobile_options.png)



# Features



_๐Ÿ† Runner up in the Obsidian Gems of the Year 2024: New plugins category._



- [Create toolbars](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Creating-toolbars) with items that link to commands, files/folders, URIs/URLs, menus, and [scripts](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Executing-scripts) (Dataview, JS Engine, Templater, and built-in support for JavaScript).

  - Built-in [Gallery of 100+ items](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Gallery) that can be added to your toolbars in just a couple clicks/taps.

- [Define where and how toolbars are displayed](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Defining-where-to-show-toolbars): Based on their folders, or a user-defined property.

  - [Position each toolbar](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Positioning-toolbars) below the Properties section, at the top or bottom of notes, or as a floating button.

  - Add a toolbar to the _New tab_ view.

  - 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.

- Use [variables](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Variables) or script experssions to sub in the note's title or properties and more into toolbar item labels, tooltips, and URIs.

- [Note Toolbar Callouts](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Note-Toolbar-Callouts) let you create and place toolbars anywhere within your notes.

- [Share toolbars](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Sharing-toolbars) with other users with a link, or [as callouts](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Creating-callouts-from-toolbars).

- [Style toolbars](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Styling-toolbars) by adding borders, sticking to the top of your note on scroll, auto-hiding, choosing whether or not the toolbar should wrap (on mobile), making items look like buttons or act like tabs, 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](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Navigation-bar) (on mobile).

  - Or use the [Style Settings plugin](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Style-Settings-plugin-support) for even more options (colors, positioning, sizing, etc.).

- Add [commands](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Commands) to open any toolbar, or to execute any item. Built-in commands _completely_ hide note properties, quickly access toolbars with [Quick Tools](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Quick-Tools), get command URIs, and more.

- [Note Toolbar URIs](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Note-Toolbar-URIs) let you execute commands, focus on folders, open menus (within Note Toolbar Callouts), and open toolbar settings, from mostly anywhere within your notes.

- [Keyboard controls](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Accessibility) available via the _Note Toolbar: Focus_ command

- Right-click toolbars to swap with other toolbars, quickly change the position, style, or to access configuration.

- The [Note Toolbar API](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Note-Toolbar-API) which, to start, includes enhanced prompt and suggester UI that you can trigger from script items, including from Dataview and JavaScript.



## Translations ๐ŸŒ



Note Toolbar's UI, and Style Settings options, are also available in:



|Language name|Native name|Contributors|

|---|---|---|

|Chinese (Simplified)|็ฎ€ไฝ“ไธญๆ–‡|[@Moyf](https://github.com/Moyf)|

|German|Deutsch|[@hartimd](https://github.com/hartimd)|

|Ukrainian|ะฃะบั€ะฐั—ะฝััŒะบะธะน|[@Laktiv](https://github.com/laktiv)|



[Help add more translations.](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Help-translate-Note-Toolbar-%F0%9F%8C%90)



# Installation



[Click here](https://obsidian.md/plugins?id=note-toolbar) or:



1. Open Obsidian's settings, and click _Community plugins_

2. Search for _Note Toolbar_ and select it

3. _Install_

4. Make sure to _Enable_ the plugin



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!





Disclaimer: Betas are pre-release versions of the plugin. It is strongly encouraged to make a backup of your Note Toolbar's data.json file before proceeding, and/or test within a separate vault (depending on the nature of the beta).







  
    

        
  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. 

        
  2. Open BRAT settings (Settings -> Obsidian 42 - BRAT)
    3. 

        
  3. Scroll to the Beta Plugin List section
    4. 

        
  4. Add Beta Plugin
    5. 

        
  5. Specify this repository: chrisgurney/obsidian-note-toolbar

    6. 

        
  6. 

    Enable the Note Toolbar plugin (Settings > Community plugins)
    7. 

        
  7. Restart Obsidian, or re-open your vault.
    8. 

        
  8. In Note Toolbar's settings, confirm the version number at the top is the latest beta version.
    9. 

      





# Getting Started ๐Ÿš€



Once enabled, open Note Toolbar's settings:



1. Create a _+ New toolbar_

2. Give the toolbar a _name_.

3. _+ Add_ (or search the [Gallery](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Gallery))

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](./docs/images/example_toolbar_daily_notes.png)



๐Ÿ“– [See the User Guide](https://github.com/chrisgurney/obsidian-note-toolbar/wiki) for detailed instructions, and tips, and [the discussions](https://github.com/chrisgurney/obsidian-note-toolbar/discussions/categories/show-and-tell) for examples.



# Gallery



In the Gallery, **[explore 100+ items](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Gallery)** that can be added to toolbars in just a couple clicks/taps.



![Screenshot of the Gallery](./docs/images/gallery.png)



# User Guide



๐Ÿ“– **See the [User Guide](https://github.com/chrisgurney/obsidian-note-toolbar/wiki)** for detailed instructions, tips, and lots more.



Screenshots of Note Toolbar's configuration:



![Example of settings configuration](./docs/images/settings.png)



![Example of settings for a toolbar](./docs/images/settings_edit_toolbar_example.png)



# License



Note Toolbar is licensed under GPL 3.0. See the [LICENSE](https://github.com/chrisgurney/obsidian-note-toolbar/blob/master/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](https://github.com/obsidianmd/obsidian-sample-plugin), [developer docs](https://docs.obsidian.md/) and [this playlist](https://www.youtube.com/playlist?list=PLIDCb22ZUTBnMCbJa-st4PD5T3Olep078).

- [Templater](https://github.com/SilentVoid13/Templater) - for code, especially around settings.

- [Periodic Notes](https://github.com/liamcain/obsidian-periodic-notes/) - for code, and one of the reasons this plugin works well for my own needs... and for liam.cain's help!

- [BRAT](https://github.com/TfTHacker/obsidian42-brat) - for the means to beta test this plugin.

- Everybody on the [Obsidian Discord](https://discord.gg/obsidianmd) #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](https://github.com/chrisgurney/obsidian-note-toolbar/discussions)! Pull requests are welcome!



[Help add or review translations.](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Help-translate-Note-Toolbar-%F0%9F%8C%90)



# Support ๐Ÿ›Ÿ



๐Ÿ“– **See [Troubleshooting](https://github.com/chrisgurney/obsidian-note-toolbar/Troubleshooting) in the [User Guide](https://github.com/chrisgurney/obsidian-note-toolbar/wiki).**



[Ask questions here](https://github.com/chrisgurney/obsidian-note-toolbar/discussions) or [request a feature](https://github.com/chrisgurney/obsidian-note-toolbar/discussions/categories/ideas). If you run into something that looks like a bug, please [log an issue](https://github.com/chrisgurney/obsidian-note-toolbar/issues).



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