Skip to content

Button block reference

The Button block reference documents the syntax and parameters for creating interactive buttons within Obsidian using the Buttons plugin.^[600-developer-tools-obsidian-obsidian-buttons-create.md]

Syntax

Buttons are created using a code block with the button identifier.^[600-developer-tools-obsidian-obsidian-buttons-create.md]

```button
name Button Name
```

Parameters

The following parameters can be defined within the button block to configure its behavior and appearance:^[600-developer-tools-obsidian-obsidian-buttons-create.md]

  • name: Sets the display text for the button (e.g., name Btn).^[600-developer-tools-obsidian-obsidian-buttons-create.md]
  • type: Defines the functionality of the button. For example, type link creates a hyperlink button.^[600-developer-tools-obsidian-obsidian-buttons-create.md]
  • action: Specifies the target URL or command path.^[600-developer-tools-obsidian-obsidian-buttons-create.md]
  • color: Changes the color of the button (e.g., color blue).^[600-developer-tools-obsidian-obsidian-buttons-create.md]
  • templater: A boolean flag (e.g., templater true) that enables integration with the Templater plugin.^[600-developer-tools-obsidian-obsidian-buttons-create.md]

Block ID

A specific ID can be appended to the code block to reference the button elsewhere or to ensure the plugin recognizes it correctly.^[600-developer-tools-obsidian-obsidian-buttons-create.md]

Sources

  • 600-developer-tools-obsidian-obsidian-buttons-create.md