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

[![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://www.moritzjung.dev/obsidian-stats/plugins/note-toolbar/#downloads) [![License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
# Note Toolbar

**[English](/README.md) | [中文文档](https://github.com/chrisgurney/obsidian-note-toolbar/blob/master/README-ZH.md) | [日本語](https://github.com/chrisgurney/obsidian-note-toolbar/blob/master/README-JA.md)**

The [Note Toolbar plugin](https://obsidian.md/plugins?id=note-toolbar) for [Obsidian](https://obsidian.md) lets you create context-aware toolbars for your notes, which can include commands, file and folder links, websites/URIs, menus, and scripts (Dataview, Templater, and JavaScript).

> What's new? See the [Release Notes](https://github.com/chrisgurney/obsidian-note-toolbar/releases)
> 
> What's ahead? See the [Roadmap](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Roadmap)

<a href="https://www.buymeacoffee.com/cheznine"><img src="https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=%E2%98%95&slug=cheznine&button_colour=fe9b27&font_colour=000000&font_family=Lato&outline_colour=000000&coffee_colour=FFDD00" /></a>

**Jump to:**

- [Disclosures](#disclosures)
- [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)

## Screenshots

*Toolbars can stick to the top on scroll:*

<img width="600" src="./docs/images/note_toolbar_demo.gif" title="Toolbars can stick to the top on scroll"/>

*Have a toolbar appear when text is selected:*

<img width="600" src="./docs/images/demo_text_toolbar.gif" title="Have a toolbar appear when text is selected"/>

*More options on mobile:*

<img width="800" src="./docs/images/mobile_options.png" title="Mobile options for accessing the toolbar"/>

## Disclosures

In order for Note Toolbar to provide a built-in library of helpful tools, and scripting extensibility, the plugin needs access to read, write, and list files within a vault. _The majority of these features are completely optional._

Expand below to see what's accessed and why. Let me know (via [GitHub ↗](https://github.com/chrisgurney/obsidian-note-toolbar/issues/546) or [Google form ↗](https://forms.gle/sa75KNAQiWTtAY4P8)) if you have any questions or concerns.

<details>
<summary>See disclosures...</summary>
<br/>
<ul>
  <li><b>Uses Obsidian APIs newer than the declared minAppVersion</b></li>
  <ul>
    <li>The plugin uses some internal Obsidian APIs. This warning is indicating that some of those APIs <i>will</i> be public in a newer release, and should go away then.</li>
  </ul>
  <li><b>Vault Read: Reads individual vault files via the Obsidian API</b></li>
  <ul>
    <li>Used by script items to read in a user script to execute it (if configured to do so).</li>
    <li>Used in Note Toolbar's <code>modal</code> API to display a file.</li>
  </ul>
  <li><b>Vault Enumeration: Enumerates all files in the vault. Gives the plugin access to every file path in the vault.</b></li>
  <ul>
    <li>Used by the Settings UI to show a list of files or folders in the vault (e.g., to select a script file, or to select a folder for mapping).</li>
  </ul>
  <li><b>Other notes</b></li>
  <ul>
    <li>URLs links from the plugin are used for: the user guide, donation page, and for a page to facilitate <a href="https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Sharing-toolbars">sharing of toolbars or toolbar items</a> with other users (<a href="https://github.com/chrisgurney/obsidian-note-toolbar/tree/gh-pages/docs">source code</a>). See the documentation in <a href="https://github.com/chrisgurney/obsidian-note-toolbar/blob/master/src/Utils/Urls.ts"><code>src/utils/Urls.ts</code></a>, which contains all external URLs referenced by the plugin.</li>
  </ul>
</ul>

Note that all Gallery item scripts can be inspected (and modified) after adding them to any toolbar.
</details>

## 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, in the tab bar, or as a floating button.
  - [Show a toolbar when text is selected.](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Toolbars-within-the-app#Selected-text)
  - Access the toolbar from [the ribbon](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Ribbon), and from [navigation bars](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Navigation-bars) (on mobile).
  - Add a toolbar to the _New tab_ view, or [completely replace the New tab view](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Toolbars-within-the-app#New-tab-view) as a launchpad for your vault.
  - Right-click (or long press) toolbars to swap with others, quickly change their position, style, or to access configuration.
- Use Obsidian's built-in icons, labels (which can include emojis), or a mix of both.
  - Show items specifically on mobile, desktop, or both.
  - Choose whether the icon, label, or both are displayed.
  - Set optional tooltips for each item.
- [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 toolbar styles on mobile (i.e, phone and tablet).
  - 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.).
- [Note Toolbar Callouts](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Note-Toolbar-Callouts) let you create and place toolbars anywhere within your notes.
- 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.
- Use [variables](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Variables) or script expressions to sub in the note's title or properties and more into toolbar item labels, tooltips, and URIs.
- [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
- [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).
- The [Note Toolbar CLI](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Note-Toolbar-CLI) provides command-line access to create Note Toolbar toolbars and items, using Obsidian's CLI.
- The [Note Toolbar API](https://github.com/chrisgurney/obsidian-note-toolbar/wiki/Note-Toolbar-API) provides toolbar access, and the ability to show UI (suggesters, prompts, menus, and modals). The latter enables Dataview JS, JS Engine, or Templater scripts to ask for information, or to show helpful text.

## 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)|
|Japanese|日本語|[@dai](https://github.com/dai)|
|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://community.obsidian.md/plugins/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

<details>
<summary>Installing beta versions via BRAT</summary>
<br/>
<a href="https://github.com/TfTHacker/obsidian42-brat">BRAT</a> lets you beta-test plugins, to provide feedback.<br/>
<br/>
As beta versions become available, I welcome <a href="https://github.com/chrisgurney/obsidian-note-toolbar/discussions">your feedback</a> and any <a href="https://github.com/chrisgurney/obsidian-note-toolbar/issues">issues</a> you uncover!<br/>
<br/>
<em>Disclaimer: Betas are pre-release versions of the plugin. It is strongly encouraged to make a backup of your Note Toolbar's <code>data.json</code> file before proceeding, and/or test within a separate vault (depending on the nature of the beta).</em><br/>
<br/>
<blockquote>
  <ol>
    <li>Install the BRAT plugin:
      <ul>
        <li>Open <i>Settings > Community Plugins</i></li>
        <li><i>Disable safe mode</i>, if enabled</li>
        <li>Browse, and <i>search for "BRAT"</i></li>
        <li>Install the latest version of <i>BRAT</i></li>
      </ul></li>
    <li>Open BRAT settings (<i>Settings -> BRAT</i>)</li>
    <li>Scroll to the <i>Beta plugin list</i> section</li>
    <li><i>Add beta plugin</i></li>
    <li>Specify this repository: <code>chrisgurney/obsidian-note-toolbar</code></li>
    <li><i>Enable the Note Toolbar plugin</i> (<i>Settings -> Community plugins</i>)</li>
    <li>In Note Toolbar's settings, confirm the version number at the top is the latest beta version. You may need to restart Obsidian, or re-open your vault.</li>
  </ol>
</blockquote>
</details>

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

<img width="700" title="Screenshot of the Gallery" src="https://raw.githubusercontent.com/chrisgurney/obsidian-note-toolbar/master/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:

<img width="700" title="Example of settings configuration" src="https://raw.githubusercontent.com/chrisgurney/obsidian-note-toolbar/master/docs/images/settings.png" />

<img width="700" title="Example of settings for a toolbar" src="https://raw.githubusercontent.com/chrisgurney/obsidian-note-toolbar/master/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 🧑‍💻

Check out the [discussions](https://github.com/chrisgurney/obsidian-note-toolbar/discussions) to [ask a question](https://github.com/chrisgurney/obsidian-note-toolbar/discussions/new?category=q-a) or [request a feature](https://github.com/chrisgurney/obsidian-note-toolbar/discussions/new?category=ideas).
  - Use this [Google form ↗](https://forms.gle/sa75KNAQiWTtAY4P8) if you don't have a GitHub account.

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

Or [contribute to development](https://github.com/chrisgurney/obsidian-note-toolbar/blob/master/CONTRIBUTING.md).

## 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](https://buymeacoffee.com/cheznine). Thank you!

<a href="https://www.buymeacoffee.com/cheznine"><img src="https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=%E2%98%95&slug=cheznine&button_colour=fe9b27&font_colour=000000&font_family=Lato&outline_colour=000000&coffee_colour=FFDD00" /></a>