Skip to content

Commit 01f4cb2

Browse files
committed
update docs
1 parent 8ed650b commit 01f4cb2

File tree

74 files changed

+664
-591
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+664
-591
lines changed

obsidian-meta-bind-plugin

src/content/docs/api/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@ title: "meta-bind-obsidian"
2020

2121
## Classes
2222

23+
- [ButtonClickContext](/obsidian-meta-bind-plugin-docs/api/classes/buttonclickcontext/)
2324
- [FieldMountable](/obsidian-meta-bind-plugin-docs/api/classes/fieldmountable/)
2425
- [Mountable](/obsidian-meta-bind-plugin-docs/api/classes/mountable/)
2526
- [NotePosition](/obsidian-meta-bind-plugin-docs/api/classes/noteposition/)
26-
- [ObsidianAPI](/obsidian-meta-bind-plugin-docs/api/classes/obsidianapi/)
27+
- [ObsAPI](/obsidian-meta-bind-plugin-docs/api/classes/obsapi/)
2728

2829
## Interfaces
2930

3031
- [BindTargetDeclaration](/obsidian-meta-bind-plugin-docs/api/interfaces/bindtargetdeclaration/)
3132
- [ButtonActionMap](/obsidian-meta-bind-plugin-docs/api/interfaces/buttonactionmap/)
32-
- [ButtonClickContext](/obsidian-meta-bind-plugin-docs/api/interfaces/buttonclickcontext/)
3333
- [ButtonConfig](/obsidian-meta-bind-plugin-docs/api/interfaces/buttonconfig/)
3434
- [ButtonContext](/obsidian-meta-bind-plugin-docs/api/interfaces/buttoncontext/)
3535
- [ButtonDeclaration](/obsidian-meta-bind-plugin-docs/api/interfaces/buttondeclaration/)
Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
---
2+
editUrl: false
3+
next: false
4+
prev: false
5+
title: "ButtonClickContext"
6+
---
7+
8+
Defined in: [packages/core/src/config/ButtonConfig.ts:210](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/config/ButtonConfig.ts#L210)
9+
10+
Provides information about the button click event.
11+
12+
## Constructors
13+
14+
### new ButtonClickContext()
15+
16+
> **new ButtonClickContext**(`type`, `shiftKey`, `ctrlKey`, `altKey`): [`ButtonClickContext`](/obsidian-meta-bind-plugin-docs/api/classes/buttonclickcontext/)
17+
18+
Defined in: [packages/core/src/config/ButtonConfig.ts:216](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/config/ButtonConfig.ts#L216)
19+
20+
#### Parameters
21+
22+
<table>
23+
<thead>
24+
<tr>
25+
<th>Parameter</th>
26+
<th>Type</th>
27+
</tr>
28+
</thead>
29+
<tbody>
30+
<tr>
31+
<td>
32+
33+
`type`
34+
35+
</td>
36+
<td>
37+
38+
[`ButtonClickType`](/obsidian-meta-bind-plugin-docs/api/enumerations/buttonclicktype/)
39+
40+
</td>
41+
</tr>
42+
<tr>
43+
<td>
44+
45+
`shiftKey`
46+
47+
</td>
48+
<td>
49+
50+
`boolean`
51+
52+
</td>
53+
</tr>
54+
<tr>
55+
<td>
56+
57+
`ctrlKey`
58+
59+
</td>
60+
<td>
61+
62+
`boolean`
63+
64+
</td>
65+
</tr>
66+
<tr>
67+
<td>
68+
69+
`altKey`
70+
71+
</td>
72+
<td>
73+
74+
`boolean`
75+
76+
</td>
77+
</tr>
78+
</tbody>
79+
</table>
80+
81+
#### Returns
82+
83+
[`ButtonClickContext`](/obsidian-meta-bind-plugin-docs/api/classes/buttonclickcontext/)
84+
85+
## Properties
86+
87+
### altKey
88+
89+
> **altKey**: `boolean`
90+
91+
Defined in: [packages/core/src/config/ButtonConfig.ts:214](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/config/ButtonConfig.ts#L214)
92+
93+
***
94+
95+
### ctrlKey
96+
97+
> **ctrlKey**: `boolean`
98+
99+
Defined in: [packages/core/src/config/ButtonConfig.ts:213](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/config/ButtonConfig.ts#L213)
100+
101+
***
102+
103+
### shiftKey
104+
105+
> **shiftKey**: `boolean`
106+
107+
Defined in: [packages/core/src/config/ButtonConfig.ts:212](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/config/ButtonConfig.ts#L212)
108+
109+
***
110+
111+
### type
112+
113+
> **type**: [`ButtonClickType`](/obsidian-meta-bind-plugin-docs/api/enumerations/buttonclicktype/)
114+
115+
Defined in: [packages/core/src/config/ButtonConfig.ts:211](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/config/ButtonConfig.ts#L211)
116+
117+
## Methods
118+
119+
### openInNewTab()
120+
121+
> **openInNewTab**(): `boolean`
122+
123+
Defined in: [packages/core/src/config/ButtonConfig.ts:233](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/config/ButtonConfig.ts#L233)
124+
125+
Whether the click should cause a link to open in a new tab.
126+
Only applicable when the click is on a link.
127+
128+
#### Returns
129+
130+
`boolean`
131+
132+
***
133+
134+
### fromMouseEvent()
135+
136+
> `static` **fromMouseEvent**(`event`, `type`): [`ButtonClickContext`](/obsidian-meta-bind-plugin-docs/api/classes/buttonclickcontext/)
137+
138+
Defined in: [packages/core/src/config/ButtonConfig.ts:223](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/config/ButtonConfig.ts#L223)
139+
140+
#### Parameters
141+
142+
<table>
143+
<thead>
144+
<tr>
145+
<th>Parameter</th>
146+
<th>Type</th>
147+
</tr>
148+
</thead>
149+
<tbody>
150+
<tr>
151+
<td>
152+
153+
`event`
154+
155+
</td>
156+
<td>
157+
158+
[`MouseEvent`](https://developer.mozilla.org/docs/Web/API/MouseEvent)
159+
160+
</td>
161+
</tr>
162+
<tr>
163+
<td>
164+
165+
`type`
166+
167+
</td>
168+
<td>
169+
170+
[`ButtonClickType`](/obsidian-meta-bind-plugin-docs/api/enumerations/buttonclicktype/)
171+
172+
</td>
173+
</tr>
174+
</tbody>
175+
</table>
176+
177+
#### Returns
178+
179+
[`ButtonClickContext`](/obsidian-meta-bind-plugin-docs/api/classes/buttonclickcontext/)

src/content/docs/api/classes/FieldMountable.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ prev: false
55
title: "FieldMountable"
66
---
77

8-
Defined in: [packages/core/src/fields/FieldMountable.ts:4](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/fields/FieldMountable.ts#L4)
8+
Defined in: [packages/core/src/fields/FieldMountable.ts:4](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/fields/FieldMountable.ts#L4)
99

1010
## Extends
1111

@@ -15,9 +15,9 @@ Defined in: [packages/core/src/fields/FieldMountable.ts:4](https://github.com/mP
1515

1616
### new FieldMountable()
1717

18-
> **new FieldMountable**(`plugin`, `uuid`, `filePath`): [`FieldMountable`](/obsidian-meta-bind-plugin-docs/api/classes/fieldmountable/)
18+
> **new FieldMountable**(`mb`, `uuid`, `filePath`): [`FieldMountable`](/obsidian-meta-bind-plugin-docs/api/classes/fieldmountable/)
1919
20-
Defined in: [packages/core/src/fields/FieldMountable.ts:9](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/fields/FieldMountable.ts#L9)
20+
Defined in: [packages/core/src/fields/FieldMountable.ts:9](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/fields/FieldMountable.ts#L9)
2121

2222
#### Parameters
2323

@@ -32,12 +32,12 @@ Defined in: [packages/core/src/fields/FieldMountable.ts:9](https://github.com/mP
3232
<tr>
3333
<td>
3434

35-
`plugin`
35+
`mb`
3636

3737
</td>
3838
<td>
3939

40-
`IPlugin`
40+
`MetaBind`
4141

4242
</td>
4343
</tr>
@@ -78,19 +78,19 @@ Defined in: [packages/core/src/fields/FieldMountable.ts:9](https://github.com/mP
7878

7979
## Properties
8080

81-
### plugin
81+
### mb
8282

83-
> `readonly` **plugin**: `IPlugin`
83+
> `readonly` **mb**: `MetaBind`
8484
85-
Defined in: [packages/core/src/fields/FieldMountable.ts:5](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/fields/FieldMountable.ts#L5)
85+
Defined in: [packages/core/src/fields/FieldMountable.ts:5](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/fields/FieldMountable.ts#L5)
8686

8787
## Methods
8888

8989
### getFilePath()
9090

9191
> **getFilePath**(): `string`
9292
93-
Defined in: [packages/core/src/fields/FieldMountable.ts:21](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/fields/FieldMountable.ts#L21)
93+
Defined in: [packages/core/src/fields/FieldMountable.ts:21](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/fields/FieldMountable.ts#L21)
9494

9595
#### Returns
9696

@@ -102,7 +102,7 @@ Defined in: [packages/core/src/fields/FieldMountable.ts:21](https://github.com/m
102102

103103
> **getTargetEl**(): `undefined` \| [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)
104104
105-
Defined in: [packages/core/src/utils/Mountable.ts:22](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L22)
105+
Defined in: [packages/core/src/utils/Mountable.ts:22](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L22)
106106

107107
Get the element that the mountable is currently mounted to.
108108

@@ -120,7 +120,7 @@ Get the element that the mountable is currently mounted to.
120120

121121
> **getUuid**(): `string`
122122
123-
Defined in: [packages/core/src/fields/FieldMountable.ts:17](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/fields/FieldMountable.ts#L17)
123+
Defined in: [packages/core/src/fields/FieldMountable.ts:17](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/fields/FieldMountable.ts#L17)
124124

125125
#### Returns
126126

@@ -132,7 +132,7 @@ Defined in: [packages/core/src/fields/FieldMountable.ts:17](https://github.com/m
132132

133133
> **isMounted**(): `boolean`
134134
135-
Defined in: [packages/core/src/utils/Mountable.ts:15](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L15)
135+
Defined in: [packages/core/src/utils/Mountable.ts:15](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L15)
136136

137137
Check if the mountable is currently mounted.
138138

@@ -150,7 +150,7 @@ Check if the mountable is currently mounted.
150150

151151
> **mount**(`targetEl`): `void`
152152
153-
Defined in: [packages/core/src/utils/Mountable.ts:50](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L50)
153+
Defined in: [packages/core/src/utils/Mountable.ts:50](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L50)
154154

155155
Mount the mountable to the given element.
156156
Will throw an error if the mountable is already mounted.
@@ -198,7 +198,7 @@ Will throw an error if the mountable is already mounted.
198198

199199
> **registerUnmountCb**(`cb`): `void`
200200
201-
Defined in: [packages/core/src/utils/Mountable.ts:91](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L91)
201+
Defined in: [packages/core/src/utils/Mountable.ts:91](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L91)
202202

203203
Register a callback that will be called when the mountable is unmounted.
204204

@@ -245,7 +245,7 @@ Register a callback that will be called when the mountable is unmounted.
245245

246246
> **unmount**(): `void`
247247
248-
Defined in: [packages/core/src/utils/Mountable.ts:70](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L70)
248+
Defined in: [packages/core/src/utils/Mountable.ts:70](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L70)
249249

250250
Unmount the mountable from the current element.
251251

src/content/docs/api/classes/Mountable.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ prev: false
55
title: "Mountable"
66
---
77

8-
Defined in: [packages/core/src/utils/Mountable.ts:1](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L1)
8+
Defined in: [packages/core/src/utils/Mountable.ts:1](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L1)
99

1010
## Extended by
1111

@@ -17,7 +17,7 @@ Defined in: [packages/core/src/utils/Mountable.ts:1](https://github.com/mProject
1717

1818
> **new Mountable**(): [`Mountable`](/obsidian-meta-bind-plugin-docs/api/classes/mountable/)
1919
20-
Defined in: [packages/core/src/utils/Mountable.ts:6](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L6)
20+
Defined in: [packages/core/src/utils/Mountable.ts:6](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L6)
2121

2222
#### Returns
2323

@@ -29,7 +29,7 @@ Defined in: [packages/core/src/utils/Mountable.ts:6](https://github.com/mProject
2929

3030
> **getTargetEl**(): `undefined` \| [`HTMLElement`](https://developer.mozilla.org/docs/Web/API/HTMLElement)
3131
32-
Defined in: [packages/core/src/utils/Mountable.ts:22](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L22)
32+
Defined in: [packages/core/src/utils/Mountable.ts:22](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L22)
3333

3434
Get the element that the mountable is currently mounted to.
3535

@@ -43,7 +43,7 @@ Get the element that the mountable is currently mounted to.
4343

4444
> **isMounted**(): `boolean`
4545
46-
Defined in: [packages/core/src/utils/Mountable.ts:15](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L15)
46+
Defined in: [packages/core/src/utils/Mountable.ts:15](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L15)
4747

4848
Check if the mountable is currently mounted.
4949

@@ -57,7 +57,7 @@ Check if the mountable is currently mounted.
5757

5858
> **mount**(`targetEl`): `void`
5959
60-
Defined in: [packages/core/src/utils/Mountable.ts:50](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L50)
60+
Defined in: [packages/core/src/utils/Mountable.ts:50](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L50)
6161

6262
Mount the mountable to the given element.
6363
Will throw an error if the mountable is already mounted.
@@ -101,7 +101,7 @@ Will throw an error if the mountable is already mounted.
101101

102102
> **registerUnmountCb**(`cb`): `void`
103103
104-
Defined in: [packages/core/src/utils/Mountable.ts:91](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L91)
104+
Defined in: [packages/core/src/utils/Mountable.ts:91](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L91)
105105

106106
Register a callback that will be called when the mountable is unmounted.
107107

@@ -144,7 +144,7 @@ Register a callback that will be called when the mountable is unmounted.
144144

145145
> **unmount**(): `void`
146146
147-
Defined in: [packages/core/src/utils/Mountable.ts:70](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/164b4e159d0a9103f56c4079fbd94da824499fe4/packages/core/src/utils/Mountable.ts#L70)
147+
Defined in: [packages/core/src/utils/Mountable.ts:70](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/blob/6b3651315380ea977c7f8746a2130e83024d2b95/packages/core/src/utils/Mountable.ts#L70)
148148

149149
Unmount the mountable from the current element.
150150

0 commit comments

Comments
 (0)