Note Toolbar Documentation

The ntb API allows you to write, edit, or debug JavaScript within Obsidian to extend the Note Toolbar functionality. You can use it to:

• Create UI elements: Use ntb.prompt, ntb.suggester, ntb.fileSuggester, ntb.menu, or ntb.modal to interact with the user.
• Manage note properties: Read or write note properties using ntb.getProperty and ntb.setProperty.
• Manipulate toolbar items: Access or modify existing items using ntb.getItem or ntb.getToolbars.
• Integrate with other plugins: Combine the ntb API with Dataview JS, JS Engine, or Templater.

Important: Always fetch the full API reference from the official source before writing or editing scripts to ensure accuracy.

Beyond standard markdown notes, you can extend Note Toolbar functionality:

• Item Types: Create items for commands, file/folder links, websites/URIs, menus, groups, and scripts (supporting Dataview, Templater, and JavaScript).
• App-wide Toolbars: Enable Toolbars within the app in settings to access toolbars in the New tab view, the mobile Navigation bar, and other areas.
• Non-Markdown Files: Toolbars can be displayed in Canvases, PDFs, and video files.
• In-note Placement: Use Note Toolbar Callouts to place a toolbar in the middle of your note content rather than at the top.

Item Types

Beyond simple commands, you can create toolbar items for:

• File and folder links
• Websites/URIs
• Menus
• Groups
• Scripts (supporting Dataview, Templater, and JavaScript)

Alternative Locations

Toolbars are not limited to the top of markdown notes. You can also use them in:

• App-wide locations: Via the Toolbars within the app setting (e.g., New tab view, mobile Navigation bar).
• Non-markdown files: Such as Canvases, PDFs, and video files.
• Inside note content: Using Note Toolbar Callouts to place toolbars in the middle of a note.

The ntb object is the primary entry point for interacting with the plugin. It is organized into several functional namespaces:

• Note Manipulation: Methods for interacting with note properties and selections (e.g., ntb.getProperty, ntb.getSelection).
• Toolbars: Methods for managing and accessing toolbar instances and items (e.g., ntb.getToolbars, ntb.getActiveItem).
• UI Components: Methods for displaying user interface elements like prompts, menus, modals, and suggesters (e.g., ntb.prompt, ntb.menu).
• Utilities: Helper objects for common tasks, including access to the Obsidian app, clipboard operations, and shorthand utilities ntb.o and ntb.t.

Instead of hard-coding dates or note names, use Note Toolbar variables within URI items. This makes toolbar items context-aware.

Supported Variable Types:

• Standard Variables: {{note_title}}, {{file_path}}, and properties like {{prop_NAME}}.
• Expressions: You can embed logic using:
  • {{js: ...}} (JavaScript)
  • {{dv: ...}} (Dataview)
  • {{tp: ...}} (Templater)

Note Toolbar provides two specialized modifiers for variables used in configuration fields:

1. URL Encoding: Use the encode: prefix before a variable to ensure its value is safely encoded for use in URIs (e.g., {{encode:file_path}}).
2. Hide on Empty: You can configure items to hide if the resolved variable value is empty, preventing broken or useless buttons from appearing in the toolbar.

If you want to test a beta version using a feature branch and the BRAT plugin:

1. Create a new feature branch and make your changes.
2. Update WHATSNEW_VERSION in NoteToolbarSettings.ts.
3. Run the release command with a beta version string:

   npm run release 1.xx-beta-01

4. Go to the GitHub releases page, edit the release, and Set as a pre-release.
5. Use the BRAT plugin in Obsidian to install the latest version.

The Note Toolbar CLI allows you to interact with a running Obsidian instance to manage toolbars and items (commands, links, scripts, etc.) without manually editing configuration files.

Prerequisites:

• Obsidian must be open.
• The Note Toolbar plugin must be installed and enabled.
• The obsidian CLI must be installed and configured to interact with your instance.

Warning: Do NOT modify the plugin's data.json file directly or use Obsidian's eval command to bypass the CLI; use the provided commands instead.

obsidian note-toolbar:help

Once the skills are installed in your agent's directory, the agent will automatically select the appropriate skill when your request matches the skill's capabilities. You can also explicitly invoke a skill by referencing the Note Toolbar CLI or API in your prompt.

Example prompt:

"Using the Note Toolbar CLI, create a toolbar called Formatting and add a Bold command item to it."