/obsidian-inputs

show form elements like inputs on render pages that can update the real md file. great for templates

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

Obsidian Inputs Plugin

The Obsidian Inputs Plugin allows users to utilize custom inputs component within their Obsidian notes, that can change the actual note.

Features

  • Expression and Target: Define expressions and their targets for dynamic content updates.
  • Input Notation Syntax: Use a simple syntax to define inputs, making it easier to create interactive and template notes.

Installation

To install the plugin, follow these steps:

  1. Download the plugin from the releases page.
  2. Place the downloaded folder in your .obsidian/plugins directory.
  3. Enable the plugin from the Obsidian settings under the "Community plugins" section.

For detailed instructions, refer to the installation guide.

Usage

To use the plugin, you can define inputs using specific notation. Here are three examples:

Example 1: Basic Input to add a line under header

`input:text|- {{input}} > #Activity append`

Example 2: Radio Input to save value in dataview inline field

what are you doing ? `input:radio? read,gym,clean| {{input}} >::activity-type`

Example 3: Select value from dropdown option add it to frontmatter field and save it back to that field

`input:text ? 10,20,20 | {{input}} + {{amount}} > :amount`

For more examples and details, refer to the small examples section.

Syntax

The input notation follows specific rules outlined in the Input Notation Syntax documentation. This includes various types of inputs like text, checkboxes, and select dropdowns.

Expression and Target

Learn how to set up expressions and targets in your notes to dynamically display content based on user input. Detailed instructions are available in the Expression and Target documentation.

License

This plugin is released under the GNU General Public License. See the LICENSE file for details.