Additional Gallery items

This page provides more examples of items to add to your toolbars that make use of the clipboard, reading and writing files within your vault.

These examples were previously included in the Gallery but have been moved here because they require access to external resources or vault content. Review the scripts before adding these items to a toolbar.

To add these to a toolbar:

1. Create a JavaScript type item (unless otherwise noted)
2. Select Evaluate JavaScript.
3. Enter the scripts below.

Clipboard

Move note text to and from the clipboard, for use in other applications.

Copy to clipboard

Copies the selected text to the clipboard.

const e = ntb.app.workspace.activeLeaf.view?.editor;
try { 
  await activeWindow.navigator.clipboard.writeText(e.getSelection());
  e?.focus(); 
} 
catch (e) { console.error(e); new Notice(ntb.t('api.msg.error-console')); }

Cut to clipboard

Cuts the selected text to the clipboard.

const e = ntb.app.workspace.activeLeaf.view?.editor;
try { 
  await activeWindow.navigator.clipboard.writeText(e.getSelection()); 
  e.replaceSelection(''); 
  e?.focus(); 
} 
catch (e) { 
  console.error(e); 
  new Notice(ntb.t('api.msg.error-console')); 
}

Paste from clipboard

Pastes the text from the clipboard into your note.

const e = ntb.app.workspace.activeLeaf.view?.editor;
try { 
  let rs = e.replaceSelection;
  let text = await activeWindow.navigator.clipboard.readText();
  if (text) rs.apply(e, [text]); e?.focus();
}
catch (e) { 
  console.error(e);
  new Notice(ntb.t('api.msg.error-console'));
}

Copy block link

Copies a link to the current block to the clipboard.

const editor = ntb.app.workspace.activeEditor?.editor;
const file = ntb.app.workspace.getActiveFile();
const line = editor?.getCursor().line;

const blockId =
    editor?.getLine(line).match(/\^([\w-]+)/)?.[1] ??
    app.metadataCache.getFileCache(file)?.blocks?.[line]?.id;

if (blockId) {
    window.navigator.clipboard.writeText(`[[${file.path}#^${blockId}]]`);
    new Notice(ntb.t('api.msg.clipboard-copied'));
} else {
    new Notice(ntb.t('api.msg.block-no-id'));
}

Copy note content

Copy body of the note to the clipboard, ignoring frontmatter.

const editor = ntb.app.workspace.activeLeaf.view?.editor;
if (!editor) return;

const body = editor
    .getValue()
    .replace(/^---\n[\s\S]*?\n---\n*/, '');

await activeWindow.navigator.clipboard.writeText(body);
new Notice(ntb.t('api.msg.clipboard-copied'));

Files

Tools for working with files.

Append text to a file

Appends the prompted text to a file you specify.

const filePath = 'File.md'; // CHANGE THIS TO ANY FILE

const file = ntb.app.vault.getAbstractFileByPath(filePath);
if (!file) {
    new Notice(ntb.t('api.msg.file-not-exist'));
    return;
}

const text = await ntb.prompt({ large: true });
if (!text) return;

const content = await ntb.app.vault.read(file);
await ntb.app.vault.modify(file, `${content}\n\n${text}`);

Note Toolbar

Backup plugin data

Copies Note Toolbar's settings (data.json) file into the vault.

const src = `${ntb.app.vault.configDir}/plugins/note-toolbar/data.json`;
const date = new Date().toISOString().slice(0, 10).replace(/-/g, '');
const dest = `note-toolbar-${date}-data.json`;

ntb.app.vault.adapter.read(src).then(data => { 
  ntb.app.vault.adapter.write(dest, data); 
  new Notice(ntb.t('api.msg.file-created', {filename: dest})); 
});

Export all toolbars to callouts

Writes an export file containing all toolbars as callouts.

const toolbars = ntb.getToolbars();
let callouts = '';

for (let toolbar of toolbars) {
    callouts += `## ${toolbar.getName()}\n\n`;
    callouts += await ntb.export(toolbar);
    callouts += '\n';
}

const datestamp = new Date().toISOString().replace(/[:.]/g, '').replace('T', '-').split('Z')[0];
const filename = `TOOLBARS ${datestamp}.md`;
await ntb.app.vault.create(filename, callouts);

new Notice(`Toolbars exported to:\n${filename}`);

Other

File list

🧩 Requires the Dataview ↗ plugin.

Shows a list of files in the specified folder (and subfolders), in the current note. Excludes the current file. Defaults to current folder if folder not provided. Sorts alphabetically.

To add to a toolbar:

1. Paste this script into a .js file in your vault.
2. Create a Dataview type item.
3. Select Execute JavaScript file.
4. Enter the script below.
5. In the Arguments field, enter: fileFolder: "Scripts" where "Scripts" is the name of the folder you want to list files for.
6. Add a Note Toolbar Output Callout and add its ID (instructions) to render the output in.

function FileList(input) {
    let fileFolder;

    if (input) {
        ({fileFolder} = input);
    }
    /* if fileFolder is not provided... */
    else {
        /* ...default to the folder of the calling note */
        fileFolder = dv.current().file.folder;
    }
    fileFolder = fileFolder ?? "";

    const files = app.vault.getFiles()
        .filter(file => (fileFolder === ""
            ? !file.path.includes("/")
            : file.path.startsWith(
                fileFolder.endsWith("/") ? fileFolder : fileFolder + "/"))
            && file.path !== dv.current().file.path)
        .sort((a, b) => a.name.localeCompare(b.name));

    dv.paragraph("📂 `" + fileFolder + "`:");
    dv.list(files.map(file => dv.fileLink(file.path)));
}

FileList(input);