Meta Bind

https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs
Admin
Meta Bind is an Obsidian plugin that makes notes interactive by enabling input fields, metadata...
Tokens:27,106
Snippets:372
Trust Score:6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Basic Meta Bind Button Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/buttons

A simple button configuration example.

```yaml
label: My Button
...
```

--------------------------------

### Circular Dependency Examples

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/viewfields

Examples of configurations that create circular dependencies, which the plugin will detect and prevent.

```text

VIEW[{a}][math:b]
VIEW[{b} + 1][math:a]

```

```text

VIEW[{a} + 1][math:a]

```

--------------------------------

### Set Metadata Example

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Demonstrates how to retrieve the plugin API and set a metadata property value.

```javascript

// Assumes you use the JS Engine plugin to run this.
const mb = engine.getPlugin("obsidian-meta-bind-plugin").api;
const bindTarget = mb.parseBindTarget("property", context.file.path);
mb.setMetadata(bindTarget, "some value");

```

--------------------------------

### Open URL Button Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/open

Example configuration for a button that opens an external URL.

```yaml
meta-bind-button
style: primary
label: Open Meta Bind Docs
action:
  type: open
  link: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/
```

--------------------------------

### Equivalent Bind Targets Example

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/bindtargets

Demonstrates equivalent bind targets for a file named 'Test Note'.

```text
property


frontmatter^Test Note#property
```

--------------------------------

### Input Action Configuration Example

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/input

Demonstrates using the input action to type 'help' into the command palette after opening it.

```yaml
```meta-bind-button
style: primary
label: Help Commands
actions:
  - type: command
    command: command-palette:open
  - type: input
    str: help
```
```

--------------------------------

### NoteA Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/viewfields

Example of a note containing an input field and a view field that performs a calculation.

```text

---
someInputValue: 1
someComputedValue: 2
---


Input: `INPUT[number:someComputedValue]`
Computed Value: `VIEW[{someInputValue} * 2][math:someComputedValue]`

```

--------------------------------

### Greet the World Button Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/inlinejs

A button configuration example that logs a message to the console when triggered.

```yaml
```meta-bind-button
style: primary
label: Greet the World
action:
  type: inlineJS
  code: "console.log('Hello World!');"
```
```

--------------------------------

### Create Note Button Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/createnote

Example configuration for a meta-bind-button that creates a note in a specific folder.

```yaml
```meta-bind-button
style: primary
label: Create Note
action:
  type: createNote
  folderPath: "My Folder"
  fileName: "New Note"
  openNote: false
```
```

--------------------------------

### Configure useLinks for Suggester Fields

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/uselinks

Examples showing how to apply different useLinks configurations to suggester input fields.

```meta-bind
INPUT[suggester(optionQuery("someFolder")):useLinksTrue]
```

```meta-bind
INPUT[suggester(optionQuery("someFolder"), useLinks(partial)):useLinksPartial]
```

```meta-bind
INPUT[suggester(optionQuery("someFolder"), useLinks(false)):useLinksFalse]
```

--------------------------------

### Command Button Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/command

Example configuration for a button that triggers the Meta Bind FAQ page.

```yaml
```meta-bind-button
style: primary
label: Meta Bind Help
action:
  type: command
  command: obsidian-meta-bind-plugin:open-faq
```
```

--------------------------------

### JavaScript Script Example

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/runjavascript

Example script content that accesses passed arguments via the context object.

```javascript
console.log('Hello ${context.args.greeting}!');
```

--------------------------------

### Button Configuration for Templater

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/runtemplaterfile

Example configuration for a meta-bind-button that triggers a specific template file.

```yaml
```meta-bind-button
style: primary
label: Say Filename
actions:
  - type: runTemplaterFile
    templateFile: "templates/Notice.md"
```
```

--------------------------------

### Templater File Content

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/runtemplaterfile

Example content for the template file to be executed by the button action.

```javascript
<%*
new Notice(tp.file.title);
%>
```

--------------------------------

### Meta Bind Button Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/runjavascript

Example configuration for a button that triggers a JavaScript file with arguments.

```yaml
```meta-bind-button
style: primary
label: Run JavaScript File
action:
  type: js
  file: someScript.js
  args:
    greeting: "Meta Bind User"
```
```

--------------------------------

### Templater Create Note Button Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/templatercreatenote

Example configuration for a button that creates a new note using a specific template and folder path.

```yaml
meta-bind-button
style: primary
label: Create Lecture Note
actions:
  - type: templaterCreateNote
    templateFile: "templates/Lecture Template.md"
    folderPath: Lectures
    fileName: "New Lecture Note - RENAME ME"
```

--------------------------------

### Update Metadata Example

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Demonstrates how to update an existing metadata property using a transformation function.

```javascript

// Assumes you use the JS Engine plugin to run this.
const mb = engine.getPlugin("obsidian-meta-bind-plugin").api;
const bindTarget = mb.parseBindTarget("property", context.file.path);
mb.updateMetadata(bindTarget, (value) => {
    return value + 1;
});

```

--------------------------------

### Create a basic input field

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/viewfields

Initial setup for tracking a distance value in frontmatter using an input field.

```text
Distance: `INPUT[number:distance]` km
```

--------------------------------

### Replace In Note Button Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/replaceinnote

Example configuration for a meta-bind-button that replaces lines 3 through 5 with specified text.

```yaml
meta-bind-button
style: primary
label: Replace in Note
action:
  type: "replaceInNote"
  fromLine: 3
  toLine: 5
  replacement: "some\ntext\nwow"
```

--------------------------------

### NoteB Cross-Note Reference

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/viewfields

Example of referencing values from NoteA within NoteB.

```text

Input: `INPUT[number:NoteA#someComputedValue]`
Computed Value: `VIEW[{NoteA#someComputedValue}]`

```

--------------------------------

### Sleep Action Usage Example

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/sleep

Demonstrates integrating a sleep action within a button configuration to pause between command execution and text input.

```yaml
```meta-bind-button
style: primary
label: Sleep
actions:
  - type: command
    command: command-palette:open
  - type: sleep
    ms: 1000
  - type: input
    str: help
```
```

--------------------------------

### createNotePosition(lineStart, lineEnd)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a note position object based on the provided line start and end numbers.

```APIDOC
## createNotePosition(lineStart, lineEnd)

### Description
Creates a note position from a line start and line end number.

### Parameters
- **lineStart** (number)
- **lineEnd** (number)

### Returns
- **NotePosition**
```

--------------------------------

### Example note with relative line references

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/buttons

Visual representation of how relative line markers map to specific positions in a note.

```markdown
---
<- fileStart, frontmatterStart
foo: bar
--- <- frontmatterEnd
```

--------------------------------

### Replace Self Button Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/replaceself

Example configuration for a button that replaces itself with static text when clicked.

```yaml
```meta-bind-button
style: primary
label: Replace Self
action:
  type: "replaceSelf"
  replacement: "i am no longer a button :("
```
```

--------------------------------

### RegExp Replace In Note Button Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/regexpreplaceinnote

Example configuration for a meta-bind button that replaces TODO lines with a 'Done' suffix using capture groups.

```yaml
```meta-bind-button
style: primary
label: RexExp Replace In Note
action:
  type: "regexpReplaceInNote"
  regexp: "^(TODO: .*)$"
  regexpFlags: "gm"
  replacement: "$1 - Done"
```
```

--------------------------------

### Create a button via the Meta Bind API

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/api

Demonstrates creating a button by defining configuration objects and mounting them to the DOM. Requires the JS Engine plugin for context variables like container and component.

```javascript
// First we get an instance of the Meta Bind plugin, then we access the API.
const mb = app.plugins.getPlugin('obsidian-meta-bind-plugin')?.api;


// We create a button configuration object.
const buttonConfig = {
    label: 'Greet the World',
    style: 'primary',
    action: {
        type: 'inlineJS',
        code: "console.log('Hello World!');",
    },
};


// We specify the button options.
const buttonOptions = {
    declaration: buttonConfig,
    isPreview: false, // This flag is used to render a non-functional preview of the button. Internally this is used for the Button Builder.
};


// We create the button. This will return something that inherits from `Mountable` and can be mounted to the DOM.
const button = mb.createButtonMountable(context.file.path, buttonOptions);


// Mount the button to the DOM and make sure it gets unmounted when the component is destroyed.
mb.wrapInMDRC(button, container, component);
```

```javascript
// First we get an instance of the Meta Bind plugin, then we access the API.
const mb = app.plugins.getPlugin('obsidian-meta-bind-plugin')?.api;


// We create the button. This will return something that inherits from `Mountable` and can be mounted to the DOM.
const button = mb.createButtonMountable(context.file.path, {
    // the button options
    declaration: {
        // the button config
        label: 'Greet the World',
        style: 'primary',
        action: {
            type: 'inlineJS',
            code: "console.log('Hello World!');",
        },
    },
    isPreview: false,
});


// Mount the button to the DOM and make sure it gets unmounted when the component is destroyed.
mb.wrapInMDRC(button, container, component);
```

--------------------------------

### Image Suggester with Folder Path Query

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/optionquery

Configures an image suggester to populate options from a specified folder path.

```text
INPUT[imageSuggester(optionQuery("path/to/folder")):bind_target]
```

--------------------------------

### Equivalent Math View Fields

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/viewfields

Demonstrates that specifying the 'math' type explicitly is equivalent to the default behavior.

```text

VIEW[{a} * {b}]
VIEW[{a} * {b}][math]

```

--------------------------------

### Suggester with Folder Path Query

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/optionquery

Configures a suggester to populate options from a specified folder path.

```text
INPUT[suggester(optionQuery("path/to/folder")):bind_target]
```

--------------------------------

### Default Storage Path Syntax

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/bindtargets

Syntax for using the default frontmatter storage type.

```text
storagePath#property
```

--------------------------------

### createTableMountable(filePath, options)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a table mountable component from the provided options.

```APIDOC
## createTableMountable(filePath, options)

### Description
Creates a table from an options object.

### Parameters
- **filePath** (string) - the file path that the field is located in or an empty string
- **options** (TableOptions)

### Returns
- **TableMountable**
```

--------------------------------

### Apply template with binding

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/templates

Invoke a previously defined template and bind it to a specific frontmatter property.

```text
INPUT[sliderTemplate][:rating]
```

--------------------------------

### new ButtonClickContext(type, shiftKey, ctrlKey, altKey)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/buttonclickcontext

Creates a new instance of ButtonClickContext.

```APIDOC
## new ButtonClickContext(type, shiftKey, ctrlKey, altKey)

### Description
Constructs a new ButtonClickContext object with the specified click type and modifier key states.

### Parameters
- **type** (ButtonClickType) - Required - The type of button click.
- **shiftKey** (boolean) - Required - Whether the shift key was pressed.
- **ctrlKey** (boolean) - Required - Whether the control key was pressed.
- **altKey** (boolean) - Required - Whether the alt key was pressed.

### Returns
- **ButtonClickContext** - A new instance of the context.
```

--------------------------------

### Create an input field via the Meta Bind API

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/api

Shows how to create a suggester-type input field bound to frontmatter. Uses a helper function to generate options and mounts the result to the DOM.

```javascript
const mb = engine.getPlugin('obsidian-meta-bind-plugin').api;
const primeNumberBound = 200;


/*
 * A function to calculate prime numbers up to a given bound.
 */
function calculatePrimeNumbers(bound) {
    const primeNumbers = [2];


    for (let i = 3; i <= bound; i++) {
        let halfI = i / 2;
        for (const p of primeNumbers) {
            if (p > halfI) {
                primeNumbers.push(i);
                break;
            }
            if (i % p === 0) {
                break;
            }
        }
    }


    return primeNumbers;
}


// Create the input field declaration with the bind target and arguments.
const declaration = {
    inputFieldType: 'suggester',
    bindTarget: mb.createBindTarget('frontmatter', context.file.path, ['favoritePrime']),
    arguments: calculatePrimeNumbers(primeNumberBound).map(x => {
        return {
            name: 'option',
            value: [x.toString()],
        };
    }),
};


// Create the input field options.
const options = {
    declaration: declaration,
    renderChildType: 'block',
};


// Create the input field.
const inputField = mb.createInputFieldMountable(context.file.path, options);


// Mount the input field to the DOM and make sure it gets unmounted when the component is destroyed.
mb.wrapInMDRC(inputField, container, component);
```

--------------------------------

### createButtonMountable()

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a button from an options object.

```APIDOC
## createButtonMountable(filePath, options)

### Description
Creates a button from an options object.

### Parameters
- **filePath** (string) - Required - The file path that the field is located in or an empty string
- **options** (ButtonOptions) - Required

### Returns
- **ButtonMountable**
```

--------------------------------

### Bind Target Syntax

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/bindtargets

The general structure for defining a bind target.

```text
storageType^storagePath#property
```

--------------------------------

### createViewFieldMountable(filePath, options)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a view field mountable component from the provided options.

```APIDOC
## createViewFieldMountable(filePath, options)

### Description
Creates a view field from an options object.

### Parameters
- **filePath** (string) - the file path that the field is located in or an empty string
- **options** (ViewFieldOptions)

### Returns
- **ViewFieldMountable**
```

--------------------------------

### Retrieve Metadata via API

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Demonstrates how to access the plugin API to read a property from the metadata cache using a parsed bind target.

```javascript
// Assumes you use the JS Engine plugin to run this.
const mb = engine.getPlugin("obsidian-meta-bind-plugin").api;
const bindTarget = mb.parseBindTarget("property", context.file.path);
const value = mb.getMetadata(bindTarget);
```

--------------------------------

### showcase

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/showcase

The showcase argument creates a card around the input field, showing the input field declaration at the bottom.

```APIDOC
## showcase

### Description
The `showcase` argument creates a card around the input field, showing the input field declaration at the bottom.

### Values
- `showcase`
- `showcase(value: true | false)`

### Allowed Input Fields
This argument can be used on all input fields.

### Example
```
INPUT[toggle(showcase):bind_target]
```
```

--------------------------------

### Basic Image View Field Syntax

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/viewfields/image

The standard syntax for declaring an image view field using a property bind target.

```text
VIEW[{property}][image]
```

--------------------------------

### createButtonMountable

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/api

Creates a button component that can be mounted to the DOM. It requires a file path and a configuration object containing the button's label, style, and action.

```APIDOC
## createButtonMountable(filePath, options)

### Description
Creates a button mountable object that can be rendered in the DOM.

### Parameters
- **filePath** (string) - Required - The path of the file where the button is being created.
- **options** (object) - Required - Configuration object containing `declaration` (button config) and `isPreview` (boolean).

### Returns
- **Mountable** - An object that can be mounted to the DOM.
```

--------------------------------

### Suggester with Tag Query

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/optionquery

Configures a suggester to populate options based on a specific tag.

```text
INPUT[suggester(optionQuery(#tag)):bind_target
```

--------------------------------

### Create Dropdown Select with Options

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/inputfields

Configures an inlineSelect input with multiple named options.

```text
INPUT[inlineSelect(
    option(bad),
    option(meh),
    option(ok),
    option(good),
    option(great)
):rating]
```

--------------------------------

### useLinks(value: true | partial | false)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/uselinks

Configures link formatting for suggester input fields.

```APIDOC
## useLinks Argument

### Description
The `useLinks` argument controls how input fields handle links. It is applicable to `suggester`, `listSuggester`, and `inlineListSuggester` fields.

### Values
- `true` (Default): Uses full links like `[[someFolder/Note.md|Note]]`.
- `partial`: Uses partial links like `[[Note]]`.
- `false`: Uses plain text (note name only).

### Usage Example
```meta-bind
INPUT[suggester(optionQuery("someFolder"), useLinks(partial)):useLinksPartial]
```
```

--------------------------------

### Basic Link View Field Syntax

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/viewfields/link

Standard syntax for implementing a link view field in a document.

```text
VIEW[{property}][link]
```

--------------------------------

### Basic Option Usage

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/option

Defines simple options where the value and display name are identical.

```text
INPUT[select(option(banana), option(apple)):bind_target]
```

--------------------------------

### Create a primary button

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/buttons

Defines a button that triggers a specific Obsidian command.

```meta-bind-button
style: primary
label: Meta Bind Help
action:
  type: command
  command: obsidian-meta-bind-plugin:mb-open-faq
```

--------------------------------

### new NotePosition(linePosition)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/noteposition

Creates a new instance of the NotePosition class.

```APIDOC
## Constructor

### Description
Creates a new NotePosition instance.

### Signature
`new NotePosition(linePosition: undefined | LinePosition)`

### Parameters
- **linePosition** (undefined | LinePosition) - The initial line position.
```

--------------------------------

### Correct API Method Invocation

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/api

Demonstrates the requirement to call API methods directly on the instance to preserve the 'this' context.

```javascript
// DON'T DO THIS
const { someAPIMethod } = app.plugins.getPlugin('obsidian-meta-bind-plugin')?.api;
someAPIMethod(); // will most likely error
// OR
const someAPIMethod = app.plugins.getPlugin('obsidian-meta-bind-plugin')?.api.someAPIMethod;
someAPIMethod(); // will most likely error


// DO THIS
const mb = app.plugins.getPlugin('obsidian-meta-bind-plugin')?.api;
mb.someAPIMethod(); // works
```

--------------------------------

### Automate Lifecycle with wrapInMDRC

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/api

Uses the wrapInMDRC helper to automatically handle mounting and unmounting by attaching the object to an Obsidian component.

```javascript
// Create a mountable object.
const mountable = ...;


// Mount the mountable via the helper function.
// `container` is the parent HTMLElement that the mountable should be mounted to.
// `component` is an Obsidian `Component` object.
mb.wrapInMDRC(mountable, container, component);
```

--------------------------------

### Mountable Class Methods

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/mountable

Methods available on the Mountable class for managing element lifecycle.

```APIDOC
## getTargetEl()

### Description
Get the element that the mountable is currently mounted to.

### Returns
- `undefined | HTMLElement` - The current target element or undefined if not mounted.

---

## isMounted()

### Description
Check if the mountable is currently mounted.

### Returns
- `boolean` - True if mounted, false otherwise.

---

## mount(targetEl)

### Description
Mount the mountable to the given element. Will throw an error if the mountable is already mounted.

### Parameters
- **targetEl** (HTMLElement) - The element to mount to.

### Returns
- `void`

---

## registerUnmountCb(cb)

### Description
Register a callback that will be called when the mountable is unmounted.

### Parameters
- **cb** (() => void) - The callback function to execute on unmount.

### Returns
- `void`

---

## unmount()

### Description
Unmount the mountable from the current element.

### Returns
- `void`
```

--------------------------------

### createInputFieldMountable()

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates an input field from an options object.

```APIDOC
## createInputFieldMountable(filePath, options)

### Description
Creates an input field from an options object.

### Parameters
- **filePath** (string) - Required - The file path that the field is located in or an empty string.
- **options** (InputFieldOptions) - Required - Configuration options for the input field.

### Returns
- **InputFieldMountable** - The created input field object.
```

--------------------------------

### RunTemplaterFileButtonAction

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/runtemplaterfile

Defines the structure for the runTemplaterFile action, which executes a specified template file.

```APIDOC
## RunTemplaterFileButtonAction

### Description
Executes all Templater templates within a single file.

### Interface
```typescript
interface RunTemplaterFileButtonAction {
    type: 'runTemplaterFile';
    templateFile: string; // the path to the template file, relative to the vault root
}
```

### Usage Example
```yaml
- type: runTemplaterFile
  templateFile: "templates/Notice.md"
```
```

--------------------------------

### Import custom definitions into MathJS

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/custommathjs

Use the mathJSImport API function within a startup script to register custom functions and constants.

```javascript
const mb = engine.getPlugin('obsidian-meta-bind-plugin').api;


mb.mathJSImport({
    // definition of the clamp function
    clamp: (val, min, max) => Math.min(Math.max(min, val), max),


    // we can also define useful constants here
    foo: 42,
});
```

--------------------------------

### addChild(child: Component): void

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/interfaces/componentlike

Adds a child component to the current ComponentLike instance.

```APIDOC
## addChild(child: Component)

### Description
Adds a child component to the current ComponentLike instance.

### Parameters
- **child** (Component) - Required - The child component to add.
```

--------------------------------

### Using allowOther in a suggester field

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/allowother

Enables custom user input for a suggester field alongside predefined options.

```text
INPUT[suggester(
    option(option 1),
    option(option 2),
    option(option 3),
    allowOther
):bind_target]
```

--------------------------------

### CreateNoteButtonAction Interface

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/createnote

Defines the configuration structure for the create note action.

```typescript
interface CreateNoteButtonAction {
    type: 'createNote';
    fileName: string; // the name of the new note
    folderPath?: string; // the folder path where the note should be created, if not specified the note will be created in the root of the vault
    openNote?: boolean; // if true, the note will be opened after creation
    openIfAlreadyExists?: boolean; // whether to open the note if it already exists instead of creating a new one with an incremented name
}
```

--------------------------------

### Apply showcase to a toggle input

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/showcase

Wraps a toggle input field in a showcase card.

```text
INPUT[toggle(showcase):bind_target]
```

--------------------------------

### Displaying a text view field

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/viewfields/text

Basic syntax for rendering a variable as plain text within a note.

```text
VIEW[Movie Title: {moveTitle}][text]
```

--------------------------------

### createEmbedMountable()

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a meta bind embed field from an options object.

```APIDOC
## createEmbedMountable(filePath, options)

### Description
Creates a meta bind embed fields from an options object.

### Parameters
- **filePath** (string) - Required - The file path that the field is located in or an empty string
- **options** (EmbedOptions) - Required

### Returns
- **EmbedMountable**
```

--------------------------------

### Use memory storage for view fields

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/viewfields

Demonstrates using the memory storage type to avoid persisting values to frontmatter.

```text
Distance: `INPUT[number:memory^distance]` km
Distance in freedom units: `VIEW[round(number({memory^distance} km, miles), 2)]` miles
```

--------------------------------

### createButtonGroupMountable()

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a button group from an options object.

```APIDOC
## createButtonGroupMountable(filePath, options)

### Description
Creates a button group from an options object.

### Parameters
- **filePath** (string) - Required - The file path that the field is located in or an empty string
- **options** (ButtonGroupOptions) - Required

### Returns
- **ButtonGroupMountable**
```

--------------------------------

### CreateNoteButtonAction

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/createnote

Interface definition for the Create Note action, which defines the parameters for creating a new note.

```APIDOC
## CreateNoteButtonAction

### Description
The `createNote` action creates a new empty note in the specified location. If a note with the same name already exists, the system appends a running number to the filename.

### Interface
```typescript
interface CreateNoteButtonAction {
    type: 'createNote';
    fileName: string; // the name of the new note
    folderPath?: string; // the folder path where the note should be created, if not specified the note will be created in the root of the vault
    openNote?: boolean; // if true, the note will be opened after creation
    openIfAlreadyExists?: boolean; // whether to open the note if it already exists instead of creating a new one with an incremented name
}
```

### Example Usage
```yaml
meta-bind-button
style: primary
label: Create Note
action:
  type: createNote
  folderPath: "My Folder"
  fileName: "New Note"
  openNote: false
```
```

--------------------------------

### Bind Input Field to Metadata

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/inputfields

Binds a toggle input to the 'completed' frontmatter field.

```text
INPUT[toggle:completed]
```

--------------------------------

### option(value: any, name: any)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/option

Defines an option with a distinct stored value and a display name.

```APIDOC
## option(value: any, name: any)

### Description
Defines an option where the stored value differs from the display name shown in the input field.

### Parameters
- **value** (any) - Required - The value to be written to the front-matter.
- **name** (any) - Required - The display name shown in the input field.
```

--------------------------------

### Invoke a template

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/templates

Use the template syntax in a note to render an input field, optionally providing overrides.

```text
INPUT[templateName][overrides]
```

--------------------------------

### Define Toggle Input Field

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/inputfields

Creates a basic toggle input field.

```text
INPUT[toggle]
```

--------------------------------

### wrapInMDRC()

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Wraps any mountable in a MarkdownRenderChild and adds it as a child to the passed in ComponentLike.

```APIDOC
## wrapInMDRC(mountable, containerEl, component)

### Description
Wraps any mountable in a MarkdownRenderChild and adds it as a child to the passed in ComponentLike. A ComponentLike is either a Component or a MarkdownPostProcessorContext.

### Parameters
- **mountable** (Mountable) - The mountable to wrap in a MarkdownRenderChild
- **containerEl** (HTMLElement) - The element to mount the MarkdownRenderChild to
- **component** (ComponentLike) - The ComponentLike to register the MarkdownRenderChild to

### Returns
- **MountableMDRC** - The resulting MarkdownRenderChild wrapper
```

--------------------------------

### Render Markdown in Text View Field

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/viewfields

Use the renderMarkdown argument to display frontmatter text as formatted markdown.

```text

VIEW[**{someText}**][text(renderMarkdown)]

```

--------------------------------

### OpenButtonAction Interface

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/open

Defines the structure for the open action, which supports opening files or URLs with an optional new tab setting.

```APIDOC
## OpenButtonAction

### Description
The open action opens a file or URL when triggered.

### Interface Definition
```typescript
interface OpenButtonAction {
    type: 'open';
    link: string; // the file link ([[file]]) or URL (https://www.example.com) to open
    newTab?: boolean; // whether to open the link in a new tab
}
```

### Usage Example
```yaml
meta-bind-button
style: primary
label: Open Meta Bind Docs
action:
  type: open
  link: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/
```
```

--------------------------------

### Define a button with a custom class

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/stylingandcss

Assign a custom class to a button element within the Meta Bind configuration.

```yaml
style: primary
label: Open Meta Bind FAQ
class: green-button
action:
  type: command
  command: obsidian-meta-bind-plugin:open-faq
```

--------------------------------

### option(value: any)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/option

Defines an option where the value is both the stored data and the display name.

```APIDOC
## option(value: any)

### Description
Defines an option where the provided value is used for both the front-matter storage and the display label.

### Parameters
- **value** (any) - Required - The value to be stored and displayed.
```

--------------------------------

### createJsViewFieldMountable()

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a JS view field from an options object.

```APIDOC
## createJsViewFieldMountable(filePath, options)

### Description
Creates a JS view field from an options object.

### Parameters
- **filePath** (string) - Required - The file path that the field is located in or an empty string.
- **options** (JsViewFieldOptions) - Required - Configuration options for the JS view field.

### Returns
- **JsViewFieldMountable** - The created JS view field object.
```

--------------------------------

### mathJSImport(object, options?)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Imports new definitions into the internal mathJS instance.

```APIDOC
## mathJSImport(object, options?)

### Description
Imports new definitions into the internal mathJS instance. For details on how to use, see https://mathjs.org/docs/reference/functions/import.html

### Parameters
- **object** (ImportObject | ImportObject[]) - Required
- **options** (ImportOptions) - Optional

### Returns
- **void**
```

--------------------------------

### Accessing the Meta Bind API

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/api

Methods for obtaining an API reference using different JavaScript execution environments.

```javascript
// First we get an instance of the Meta Bind plugin, then we access the API.
// If the plugin is not loaded, this will return `undefined`.
const mb = engine.getPlugin('obsidian-meta-bind-plugin')?.api;


// Optional: Handle the case where the plugin is not loaded.
if (!mb) {
// ...
}


// Now we can use the API!
```

```javascript
// `app` refers to the Obsidian App object, depending on how you execute JavaScript you might need to get it from somewhere.
// First we get an instance of the Meta Bind plugin, then we access the API.
// If the plugin is not loaded, this will return `null`.
const mb = app.plugins.getPlugin('obsidian-meta-bind-plugin')?.api;


// Optional: Handle the case where the plugin is not loaded.
if (!mb) {
    // ...
}


// Now we can use the API!
```

--------------------------------

### TemplaterCreateNoteButtonAction

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/templatercreatenote

The interface definition for the templaterCreateNote action, detailing the available configuration properties.

```APIDOC
## TemplaterCreateNoteButtonAction

### Description
Defines the configuration object for the `templaterCreateNote` action type.

### Properties
- **type** (string) - Required - Must be 'templaterCreateNote'.
- **templateFile** (string) - Required - The path to the template file, relative to the vault root.
- **folderPath** (string) - Optional - The path to the folder to create the note in, relative to the vault root.
- **fileName** (string) - Optional - The name of the file to create.
- **openNote** (boolean) - Optional - Whether to open the created note.
- **openIfAlreadyExists** (boolean) - Optional - Whether to open the note if it already exists instead of creating a new one with an incremented name.
```

--------------------------------

### Use placeholder in a text input field

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/placeholder

Displays hint text within a text input field when no data is present.

```text
INPUT[text(placeholder(Appointment Location)):bind_target]
```

--------------------------------

### createSignal(value)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a new signal with an initial value.

```APIDOC
## createSignal<T>(value)

### Description
Creates a signal.

### Parameters
- **value** (T)

### Returns
- **Signal<T>**
```

--------------------------------

### Containing File Bind Targets

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/bindtargets

Syntax for binding to properties within the current file.

```text
property


storageType^property
```

--------------------------------

### Apply a title to a toggle input field

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/title

Demonstrates the syntax for adding a title to a toggle input field using the title argument.

```text
INPUT[toggle(title(this is a cool title)):bind_target]
```

--------------------------------

### CommandButtonAction Interface

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/command

The structure for defining a command action within a button configuration.

```APIDOC
## CommandButtonAction

### Description
Defines the configuration for a button action that executes an Obsidian command.

### Properties
- **type** (string) - Required - Must be set to 'command'.
- **command** (string) - Required - The unique ID of the Obsidian command to execute.
```

--------------------------------

### Basic Math View Field Usage

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/viewfields/math

Displays a simple multiplication calculation using the math view field syntax.

```text
VIEW[{a} * {b}]
```

--------------------------------

### reactiveMetadata(bindTargets, lifecycleHook, callback)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a JS Engine reactive component that will re-render when the given bind targets change.

```APIDOC
## reactiveMetadata(bindTargets, lifecycleHook, callback)

### Description
Creates a JS Engine reactive component that will re-render when the given bind targets change. This requires JS Engine to be installed and enabled!

### Parameters
- **bindTargets** (BindTargetDeclaration[]) - Required - the bind targets to listen to
- **lifecycleHook** (LifecycleHook) - Required - a Component
- **callback** ((...values) => Promise<unknown>) - Required - the callback to call with all the values of the bind targets when one of them changes. What ever this callback returns will be rendered by the reactive component.

### Returns
- **ReactiveComponent**
```

--------------------------------

### RegexpReplaceInNoteButtonAction

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/regexpreplaceinnote

Defines the configuration interface for the regexpReplaceInNote button action.

```APIDOC
## Interface: RegexpReplaceInNoteButtonAction

### Description
This action performs a search and replace on the entire note where the button is located. It supports capturing groups using $1, $2, etc., in the replacement string.

### Properties
- **type** (string) - Required - Must be 'replaceInNote'.
- **regexp** (string) - Required - The regular expression to search for.
- **regexpFlags** (string) - Optional - The flags for the regular expression (defaults to 'g').
- **replacement** (string) - Required - The replacement text.

### Example
```yaml
meta-bind-button
style: primary
label: RexExp Replace In Note
action:
  type: "regexpReplaceInNote"
  regexp: "^(TODO: .*)$"
  regexpFlags: "gm"
  replacement: "$1 - Done"
```
```

--------------------------------

### RunTemplaterFileButtonAction Interface

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/runtemplaterfile

Defines the structure for the runTemplaterFile action, requiring the template file path.

```typescript
interface RunTemplaterFileButtonAction {
    type: 'runTemplaterFile';
    templateFile: string; // the path to the template file, relative to the vault root
}
```

--------------------------------

### fromMouseEvent(event, type)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/buttonclickcontext

Creates a ButtonClickContext from a standard browser MouseEvent.

```APIDOC
## fromMouseEvent(event, type)

### Description
Static factory method to create a ButtonClickContext instance from a browser MouseEvent and a specified click type.

### Parameters
- **event** (MouseEvent) - Required - The source mouse event.
- **type** (ButtonClickType) - Required - The type of button click.

### Returns
- **ButtonClickContext** - A new instance populated with data from the mouse event.
```

--------------------------------

### Create a button group

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/buttons

Displays multiple buttons in a single row by referencing multiple IDs in an inline block.

```markdown
Theme Switcher: `BUTTON[light-mode, dark-mode]`
```

```meta-bind-button
style: destructive
label: Light Mode
id: light-mode
hidden: true
actions:
  - type: command
    command: theme:use-light
```

```meta-bind-button
style: primary
label: Dark Mode
id: dark-mode
hidden: true
actions:
  - type: command
    command: theme:use-dark
```

--------------------------------

### createInputFieldMountable

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/api

Creates an input field component that can be mounted to the DOM, typically used for binding data to frontmatter or other targets.

```APIDOC
## createInputFieldMountable(filePath, options)

### Description
Creates an input field mountable object for rendering in the DOM.

### Parameters
- **filePath** (string) - Required - The path of the file where the input field is being created.
- **options** (object) - Required - Configuration object containing `declaration` (input field type, bind target, arguments) and `renderChildType`.
```

--------------------------------

### Text Input Field Configuration

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfields/text

Details regarding the text input field, its availability, and supported configuration arguments.

```APIDOC
## Text Input Field

### Description
A text input field is a simple inline text input field. Markdown is not supported.

### Configuration Arguments
- **class** (string) - Optional - CSS class for the input field.
- **defaultValue** (string) - Optional - The default value of the input field.
- **placeholder** (string) - Optional - Placeholder text displayed when the field is empty.
- **showcase** (boolean) - Optional - Whether to showcase the input field.
- **title** (string) - Optional - Title for the input field.
- **limit** (number) - Optional - Character limit for the input field.

### Usage
- **Allowed in Code Block**: true
- **Allowed Inline**: true
```

--------------------------------

### Button configuration interface

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/buttons

TypeScript interface defining the required and optional properties for button configuration.

```typescript
interface ButtonConfig {
    // Required fields:
    // The text displayed on the button.
    label: string;
    // The style of the button.
    style: 'default' | 'primary' | 'destructive' | 'plain';


    // Optional fields:
    // An optional lucide icon to display on the button.
    icon?: string;
    // Optional CSS classes to add to the button. Multiple classes can be separated by spaces.
    class?: string;
    // Optional CSS inline stiles to apply to the button.
    cssStyle?: string;
    // Optional path to a background image for the button.
    backgroundImage?: string;
    // Optional tooltip to display when hovering over the button. If not set, the label is used.
    tooltip?: string;
    // The optional id of the button, used for referencing the button in inline buttons.
    id?: string;
    // Whether this button should be hidden, useful when only using the button in inline buttons.
    hidden?: boolean;


    // Button Actions:
    // The action to perform when the button is clicked.
    action?: ButtonAction;
    // Optionally multiple actions can be performed when the button is clicked.
    actions?: ButtonAction[];
}
```

--------------------------------

### createBindTarget()

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a bind target declaration for metadata properties.

```APIDOC
## createBindTarget(storageType, storagePath, property, listenToChildren)

### Description
Creates a bind target declaration.

### Parameters
- **storageType** (string) - Required - The storage type (also named metadata source sometimes)
- **storagePath** (string) - Required - The storage path (usually the file path)
- **property** (string[]) - Required - The property access path as an array.
- **listenToChildren** (boolean) - Optional (default: false) - Whether to listen to children, only relevant for arrays and objects

### Returns
- **BindTargetDeclaration**
```

--------------------------------

### Dynamic Bind Targets with JavaScript

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/advancedusecases

Uses a select input to control the target of a number input dynamically based on an index.

```yaml
---
list:
  - 1
  - 2
  - 3
index: 0
---
```

```markdown
Index: `INPUT[inlineSelect(option(0), option(1), option(2)):index]`
```

```javascript
{index} as index
---
const str = `\`INPUT[number:list[${context.bound.index}]]\``;
return engine.markdown.create(str)
```

--------------------------------

### Define a slider template

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/templates

Create a reusable slider template in the plugin settings using the specified input string.

```text
INPUT[slider(addLabels, minValue(0), maxValue(10))]
```

--------------------------------

### ReplaceSelfButtonAction

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/buttonactions/replaceself

Configuration interface for the replaceSelf button action.

```APIDOC
## ReplaceSelfButtonAction

### Description
Defines the configuration for replacing a button with text or a template.

### Properties
- **type** (string) - Required - Must be 'replaceSelf'.
- **replacement** (string) - Required - The string or the path to the Templater template to replace the button with.
- **templater** (boolean) - Optional - If true, the replacement is treated as a Templater template.

### Example
```meta-bind-button
style: primary
label: Replace Self
action:
  type: "replaceSelf"
  replacement: "i am no longer a button :("
```
```

--------------------------------

### createField()

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a field of a given type.

```APIDOC
## createField(type, filePath, options, honorExcludedSetting)

### Description
Creates a field of a given type.

### Parameters
- **type** (FieldType) - Required - The type of the field.
- **filePath** (string) - Required - The file path that the field is located in, or an empty string if it is not in a file.
- **options** (FieldOptionMap) - Required - Configuration options for the field.
- **honorExcludedSetting** (boolean) - Optional (default: true) - Whether to honor the excluded folders settings for this field.

### Returns
- **FieldMountable** - The created field object.
```

--------------------------------

### placeholder(value: any)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/placeholder

The placeholder argument allows for the specification of a placeholder value, which will be displayed when the input field has no data or is empty.

```APIDOC
## placeholder

### Description
The `placeholder` argument allows for the specification of a placeholder value, which will be displayed when the input field has no data or is empty. This is very similar to the HTML `placeholder` attribute.

### Configuration
`placeholder(value: any)`

### Allowed Input Fields
- text
- textArea
- number
- list
- inlineList

### Example
```
INPUT[text(placeholder(Appointment Location)):bind_target]
```
```

--------------------------------

### Define Slider Step Size

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/stepsize

Configures a slider input with a specific step increment.

```text
INPUT[slider(stepSize(2)):bind_target]
```

```text
INPUT[slider(stepSize(0.1)):bind_target]
```

--------------------------------

### link

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/viewfields/link

The link view field automatically formats bind targets as links. It supports wiki-links, markdown links, strings, URLs, and lists.

```APIDOC
## link

### Description
A link view field accepts a single bind target and automatically links to the target's value. It supports wiki-links, markdown links, strings (converted to wiki-links), URLs (converted to markdown links), and lists of these types.

### Allowed Arguments
- **hidden** - Optional - Hides the view field.
- **class** - Optional - Applies a CSS class to the view field.

### Usage Example
```
VIEW[{property}][link]
```
```

--------------------------------

### parseBindTarget(declarationString, filePath, scope?)

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Parses a bind target declaration from a string.

```APIDOC
## parseBindTarget(declarationString, filePath, scope?)

### Description
Parses a bind target declaration from a string.

### Parameters
- **declarationString** (string) - Required - the string to parse
- **filePath** (string) - Required - the file path that this bind target is relative to
- **scope** (BindTargetScope) - Optional - optional bind target scope

### Returns
- **BindTargetDeclaration**
```

--------------------------------

### Style a button with CSS

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/stylingandcss

Target the button element using the custom class to apply color changes.

```css
.mb-button.green-button > button {
    color: var(--color-green);
}
```

```css
.mb-button.green-button > button {
    color: var(--color-green) !important;
}
```

--------------------------------

### optionQuery Argument

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/optionquery

The optionQuery argument is used to define the source of options for suggester input fields. It supports multiple options and can be used with suggester, imageSuggester, listSuggester, inlineListSuggester, and imageListSuggester.

```APIDOC
## optionQuery

### Description
The `optionQuery` argument allows you to add multiple options to suggesters based on a data source. Note that `imageSuggester` only supports providing a folder path, while other suggesters support broader data sources.

### Configuration
`optionQuery(value: any)`

- **value** (any) - The query string or path used to retrieve options.

### Supported Input Fields
- suggester
- imageSuggester
- listSuggester
- inlineListSuggester
- imageListSuggester

### Examples

#### Tag-based query
`INPUT[suggester(optionQuery(#tag)):bind_target]`

#### Folder-based query
`INPUT[suggester(optionQuery("path/to/folder")):bind_target]`

#### Image suggester folder query
`INPUT[imageSuggester(optionQuery("path/to/folder")):bind_target]`
```

--------------------------------

### Set Minimum and Maximum Values for Slider

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/minvalue

Configures a slider input with both a minimum value of -10 and a maximum value of 10.

```text
INPUT[slider(minValue(-10), maxValue(10)):bind_target]
```

--------------------------------

### constructMDRCWidget()

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/api/classes/obsapi

Creates a CodeMirror 6 widget from a given widget type, intended for use within a CodeMirror plugin.

```APIDOC
## constructMDRCWidget(inlineFieldType, content, filePath, component)

### Description
Creates a CM6 widget from a given widget type. This is only useful for use in a CodeMirror plugin.

### Parameters
- **inlineFieldType** (InlineFieldType) - Required
- **content** (string) - Required
- **filePath** (string) - Required
- **component** (Component) - Required

### Returns
- **MarkdownRenderChildWidget**
```

--------------------------------

### Display reactive view fields

Source: https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/viewfields

Basic implementation of a view field that reacts to changes in the distance frontmatter field.

```text
Distance: `INPUT[number:distance]` km
Distance in freedom units: `VIEW[{distance}]` miles
```
Tokens:
Raw