Skip to content

Commit 409ce83

Browse files
committed
Merge branch 'master' into release
2 parents 6487bc6 + e56e0b3 commit 409ce83

23 files changed

+8963
-1417
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ This plugin can create input fields inside your notes and bind them to metadata
55
This plugin is not yet finished.
66

77
### How to use
8-
To create an input field you have to write an inline code block starting with `INPUT`. Then in square brackets the type of input field and what metadata field to bind to.
8+
To create an input field you have to write an inline code block or normal code block starting with `INPUT`. Then in square brackets the type of input field, in round brackets arguments and finally behind a colon the metadata field to bind to.
99

10-
Examples:
10+
#### Examples:
1111
- `INPUT[toggle]` will create an unbound toggle
1212
- `INPUT[slider:rating]` will create a slider bound to the metadata field `rating` of this note
1313
- `INPUT[text:task#completedOn]` will create a text input bound to the metadata field `completedOn` of the note with the name `task`
@@ -18,16 +18,21 @@ INPUT[input_type(argument_name(argument_value), argument_name_2, ...):file_name_
1818
```
1919

2020
#### Input field types
21-
- `slider` a slider from 0 to 100 (custom ranges are on the road map)
21+
- `slider` a slider from 0 to 100 (custom ranges can be set using `minValue` and `maxValue`, see below)
2222
- `toggle` a toggle element
2323
- `text` a text field
2424
- `text_area` a bigger text field
25+
- `select` a select input field, only for code blocks
26+
- `multi-select` a multi-select input field, only for code blocks
27+
- `date` a date input field
2528

2629
#### Arguments
2730
- `class(class_name)` adds a css class to the input field
2831
- `addLabels` only for slider, adds labels for the min and max values
2932
- `minValue(value)` only for slider, sets the min value
3033
- `maxValue(value)` only for slider, sets the max value
34+
- `option(value)` only for (multi-)selects, adds an option to the select
35+
- `title(value)` only for (multi-)selects, adds a title to the select input
3136

3237
### How to install
3338
This plugin is still in **beta**.
@@ -47,11 +52,12 @@ The folder structure should look like this:
4752
```
4853

4954
### Problems, unexpected behavior or improvement suggestions?
50-
#### The sync seems laggy
51-
This is intentional. To reduce the load on your hard drive the plugin ony syncs about 5 times a second.
52-
5355
You are more than welcome to open an issue on [GitHub](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/issues).
5456

57+
#### The sync seems laggy
58+
This is intentional. To reduce the load on your hard drive the plugin ony syncs about 5 times a second.
59+
There is a setting to change the sync interval, but I don't recommend changing it.
60+
5561
### Contributions
5662
Thank you for wanting to contribute to this project.
5763

jest.config.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module.exports = {
2+
preset: "ts-jest",
3+
testEnvironment: "jsdom",
4+
moduleDirectories: ["node_modules", "src"],
5+
};

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"id": "obsidian-meta-bind-plugin",
33
"name": "Meta Bind Plugin",
4-
"version": "0.1.6",
4+
"version": "0.1.7",
55
"minAppVersion": "0.14.0",
66
"description": "This plugin can create input fields inside your notes and bind them to metadata fields.",
77
"author": "Moritz Jung",

0 commit comments

Comments
 (0)