buttons LP support

Author: mProjectsCode

exampleVault/Advanced Examples/PF2e Encounter Calculator.md

@@ -1,6 +1,6 @@
 ---
 playerCount: 6
-playerLevel: 4
+playerLevel: 6
 enemy:
   - name: Somthing
     level: 2
@@ -11,11 +11,11 @@ enemy:
     count: 1
     variant: 0
   - name: dragon
-    level: 2
+    level: 3
     count: 2
     variant: -1
   - name: test
-    level: 1
+    level: 5
     count: 1
     variant: 0
 test:

exampleVault/Button Example.md

@@ -137,4 +137,17 @@ actions:
   - type: input
     str: PF2e
 
+```
+
+```meta-bind-button
+label: Test
+hidden: false
+id: ""
+style: default
+actions:
+  - type: sleep
+    ms: 1000
+  - type: command
+    command: obsidian-meta-bind-plugin:open-help
+
 ```

src/api/API.ts

@@ -30,6 +30,8 @@ import { type ButtonActionRunner } from '../fields/button/ButtonActionRunner';
 import { ButtonManager } from '../fields/button/ButtonManager';
 import { type BindTargetDeclaration, BindTargetStorageType } from '../parsers/BindTargetDeclaration';
 import { ObsidianButtonActionRunner } from '../fields/button/ObsidianButtonActionRunner';
+import { ButtonMDRC } from '../renderChildren/ButtonMDRC';
+import { InlineButtonMDRC } from '../renderChildren/InlineButtonMDRC';
 
 export class API implements IAPI {
 	public plugin: MetaBindPlugin;
@@ -275,4 +277,36 @@ export class API implements IAPI {
 	public createBindTarget(fullDeclaration: string, currentFilePath: string): BindTargetDeclaration {
 		return this.bindTargetParser.parseAndValidateBindTarget(fullDeclaration, currentFilePath);
 	}
+
+	public createButtonFromString(
+		fullDeclaration: string,
+		filePath: string,
+		containerEl: HTMLElement,
+		component: Component | MarkdownPostProcessorContext,
+	): ButtonMDRC | ExcludedMDRC {
+		if (this.plugin.isFilePathExcluded(filePath)) {
+			return this.createExcludedField(containerEl, filePath, component);
+		}
+
+		const button = new ButtonMDRC(containerEl, fullDeclaration, this.plugin, filePath, getUUID());
+		component.addChild(button);
+
+		return button;
+	}
+
+	public createInlineButtonFromString(
+		fullDeclaration: string,
+		filePath: string,
+		containerEl: HTMLElement,
+		component: Component | MarkdownPostProcessorContext,
+	): InlineButtonMDRC | ExcludedMDRC {
+		if (this.plugin.isFilePathExcluded(filePath)) {
+			return this.createExcludedField(containerEl, filePath, component);
+		}
+
+		const button = new InlineButtonMDRC(containerEl, fullDeclaration, this.plugin, filePath, getUUID());
+		component.addChild(button);
+
+		return button;
+	}
 }

src/cm6/Cm6_Util.ts

@@ -1,10 +1,6 @@
 import { type EditorSelection, type EditorState } from '@codemirror/state';
-import type MetaBindPlugin from '../main';
-import { type Component, editorInfoField, type TFile } from 'obsidian';
-import { ErrorLevel, MetaBindInternalError } from '../utils/errors/MetaBindErrors';
-import { InputFieldWidget, type MarkdownRenderChildWidget, MBWidgetType, ViewFieldWidget } from './Cm6_Widgets';
+import { editorInfoField, type TFile } from 'obsidian';
 import { type DecorationSet, type EditorView } from '@codemirror/view';
-import { type AbstractMDRC } from '../renderChildren/AbstractMDRC';
 
 export class Cm6_Util {
 	/**
@@ -39,84 +35,6 @@ export class Cm6_Util {
 		return state.sliceDoc(from, to);
 	}
 
-	/**
-	 * Creates a MDRC widget from a given widget type.
-	 *
-	 * @param widgetType
-	 * @param content
-	 * @param filePath
-	 * @param component
-	 * @param plugin
-	 */
-	static constructMarkdownRenderChildWidget(
-		widgetType: MBWidgetType,
-		content: string,
-		filePath: string,
-		component: Component,
-		plugin: MetaBindPlugin,
-	): MarkdownRenderChildWidget<AbstractMDRC> | undefined {
-		if (widgetType === MBWidgetType.INPUT_FIELD_WIDGET) {
-			return new InputFieldWidget(content, filePath, component, plugin);
-		} else if (widgetType === MBWidgetType.VIEW_FIELD_WIDGET) {
-			return new ViewFieldWidget(content, filePath, component, plugin);
-		}
-
-		return undefined;
-	}
-
-	/**
-	 * Gets the prefix of a given widget type. (e.g. INPUT or VIEW)
-	 *
-	 * @param widgetType
-	 */
-	static getDeclarationPrefix(widgetType: MBWidgetType): string {
-		if (widgetType === MBWidgetType.INPUT_FIELD_WIDGET) {
-			return 'INPUT';
-		} else if (widgetType === MBWidgetType.VIEW_FIELD_WIDGET) {
-			return 'VIEW';
-		}
-
-		throw new MetaBindInternalError({
-			errorLevel: ErrorLevel.CRITICAL,
-			effect: 'failed to get declaration prefix',
-			cause: `Invalid widget type "${widgetType}"`,
-		});
-	}
-
-	/**
-	 * Checks if a string is a declaration of a given widget type.
-	 *
-	 * @param widgetType
-	 * @param str
-	 */
-	static isDeclaration(widgetType: MBWidgetType, str: string): boolean {
-		const startStr: string = Cm6_Util.getDeclarationPrefix(widgetType) + '[';
-		const endStr: string = ']';
-
-		return str.startsWith(startStr) && str.endsWith(endStr);
-	}
-
-	/**
-	 * Checks if a string is any declaration and if yes returns the widget type.
-	 * This does not use {@link isDeclaration} because of performance reasons.
-	 *
-	 * @param str
-	 */
-	static isDeclarationAndGetWidgetType(str: string): MBWidgetType | undefined {
-		if (!str.endsWith(']')) {
-			return undefined;
-		}
-
-		for (const widgetType of Object.values(MBWidgetType)) {
-			const startStr: string = Cm6_Util.getDeclarationPrefix(widgetType) + '[';
-			if (str.startsWith(startStr)) {
-				return widgetType;
-			}
-		}
-
-		return undefined;
-	}
-
 	/**
 	 * Gets the current file of an editor.
 	 *

src/cm6/Cm6_ViewPlugin.ts

@@ -4,8 +4,8 @@ import { syntaxTree } from '@codemirror/language';
 import { type SyntaxNode } from '@lezer/common';
 import { Component, editorLivePreviewField, type TFile } from 'obsidian';
 import type MetaBindPlugin from '../main';
-import { type MBWidgetType } from './Cm6_Widgets';
 import { Cm6_Util } from './Cm6_Util';
+import { InlineMDRCUtils, type InlineMDRCType } from '../utils/InlineMDRCUtils';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function createMarkdownRenderChildWidgetEditorPlugin(plugin: MetaBindPlugin): ViewPlugin<any> {
@@ -107,7 +107,7 @@ export function createMarkdownRenderChildWidgetEditorPlugin(plugin: MetaBindPlug
 			 * @param content the content of the node
 			 * @param widgetType the type of the widget to add
 			 */
-			addDecoration(node: SyntaxNode, view: EditorView, content: string, widgetType: MBWidgetType): void {
+			addDecoration(node: SyntaxNode, view: EditorView, content: string, widgetType: InlineMDRCType): void {
 				const from = node.from - 1;
 				const to = node.to + 1;
 
@@ -141,7 +141,7 @@ export function createMarkdownRenderChildWidgetEditorPlugin(plugin: MetaBindPlug
 			getRenderInfo(
 				view: EditorView,
 				node: SyntaxNode,
-			): { shouldRender: boolean; content: string | undefined; widgetType: MBWidgetType | undefined } {
+			): { shouldRender: boolean; content: string | undefined; widgetType: InlineMDRCType | undefined } {
 				// get the node props
 				// const propsString: string | undefined = node.type.prop<string>(tokenClassNodeProp);
 				// workaround until bun installs https://github.com/lishid/cm-language/ correctly
@@ -174,11 +174,11 @@ export function createMarkdownRenderChildWidgetEditorPlugin(plugin: MetaBindPlug
 				view: EditorView,
 				from: number,
 				to: number,
-			): { content: string; widgetType: MBWidgetType | undefined } {
+			): { content: string; widgetType: InlineMDRCType | undefined } {
 				const content = Cm6_Util.getContent(view.state, from, to);
 				return {
 					content: content,
-					widgetType: Cm6_Util.isDeclarationAndGetWidgetType(content),
+					widgetType: InlineMDRCUtils.isDeclarationAndGetMDRCType(content),
 				};
 			}
 
@@ -234,20 +234,17 @@ export function createMarkdownRenderChildWidgetEditorPlugin(plugin: MetaBindPlug
 			 */
 			renderWidget(
 				node: SyntaxNode,
-				widgetType: MBWidgetType,
+				widgetType: InlineMDRCType,
 				content: string,
 				currentFile: TFile,
 			): Range<Decoration> | undefined {
-				const widget = Cm6_Util.constructMarkdownRenderChildWidget(
+				const widget = InlineMDRCUtils.constructMDRCWidget(
 					widgetType,
 					content,
 					currentFile.path,
 					this.component,
 					plugin,
 				);
-				if (!widget) {
-					return;
-				}
 
 				return Decoration.replace({
 					widget: widget,

src/cm6/Cm6_Widgets.ts

@@ -5,7 +5,7 @@ import { type ViewFieldMDRC } from '../renderChildren/ViewFieldMDRC';
 import { type InputFieldMDRC } from '../renderChildren/InputFieldMDRC';
 import { type Component } from 'obsidian';
 import { type ExcludedMDRC } from '../renderChildren/ExcludedMDRC';
-import { RenderChildType } from '../config/FieldConfigs';
+import { InlineMDRCUtils } from '../utils/InlineMDRCUtils';
 
 export abstract class MarkdownRenderChildWidget<T extends AbstractMDRC> extends WidgetType {
 	content: string;
@@ -22,7 +22,8 @@ export abstract class MarkdownRenderChildWidget<T extends AbstractMDRC> extends
 		this.plugin = plugin;
 	}
 
-	eq(other: ViewFieldWidget): boolean {
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	eq(other: MarkdownRenderChildWidget<any>): boolean {
 		return other.content === this.content;
 	}
 
@@ -43,31 +44,32 @@ export abstract class MarkdownRenderChildWidget<T extends AbstractMDRC> extends
 	}
 }
 
-export class ViewFieldWidget extends MarkdownRenderChildWidget<ViewFieldMDRC> {
-	public createRenderChild(container: HTMLElement, component: Component): ViewFieldMDRC | ExcludedMDRC {
-		return this.plugin.api.createViewFieldFromString(
+export class InputFieldWidget extends MarkdownRenderChildWidget<InputFieldMDRC> {
+	public createRenderChild(container: HTMLElement, component: Component): InputFieldMDRC | ExcludedMDRC {
+		return InlineMDRCUtils.createInlineInputFieldMDRC(
 			this.content,
-			RenderChildType.INLINE,
 			this.filePath,
 			container,
 			component,
+			this.plugin,
 		);
 	}
 }
 
-export class InputFieldWidget extends MarkdownRenderChildWidget<InputFieldMDRC> {
-	public createRenderChild(container: HTMLElement, component: Component): InputFieldMDRC | ExcludedMDRC {
-		return this.plugin.api.createInputFieldFromString(
+export class ViewFieldWidget extends MarkdownRenderChildWidget<ViewFieldMDRC> {
+	public createRenderChild(container: HTMLElement, component: Component): ViewFieldMDRC | ExcludedMDRC {
+		return InlineMDRCUtils.createInlineViewFieldMDRC(
 			this.content,
-			RenderChildType.INLINE,
 			this.filePath,
 			container,
 			component,
+			this.plugin,
 		);
 	}
 }
 
-export enum MBWidgetType {
-	INPUT_FIELD_WIDGET = 'INPUT_FIELD_WIDGET',
-	VIEW_FIELD_WIDGET = 'VIEW_FIELD_WIDGET',
+export class ButtonWidget extends MarkdownRenderChildWidget<InputFieldMDRC> {
+	public createRenderChild(container: HTMLElement, component: Component): InputFieldMDRC | ExcludedMDRC {
+		return InlineMDRCUtils.createInlineButtonMDRC(this.content, this.filePath, container, component, this.plugin);
+	}
 }

src/config/ButtonConfig.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { oneOf, schemaForType } from '../utils/ZodHelpers';
+import { oneOf, schemaForType } from '../utils/ZodUtils';
 
 export enum ButtonStyleType {
 	DEFAULT = 'default',

src/faq/FaqComponent.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-	import { DocsHelper } from '../utils/DocsHelper';
+	import { DocsUtils } from '../utils/DocsUtils';
 	import ErrorIndicatorComponent from '../utils/errors/ErrorIndicatorComponent.svelte';
 	import { App } from 'obsidian';
 	import { ErrorCollection } from '../utils/errors/ErrorCollection';
@@ -48,30 +48,30 @@
 		<Button
 			variant="primary"
 			on:click={() => {
-				DocsHelper.open(DocsHelper.linkToHome());
+				DocsUtils.open(DocsUtils.linkToHome());
 			}}
 			>Docs
 		</Button>
 		<Button
 			variant="default"
 			on:click={() => {
-				DocsHelper.open(DocsHelper.linkToGithub());
+				DocsUtils.open(DocsUtils.linkToGithub());
 			}}
 			>GitHub
 		</Button>
 		<Button
 			variant="default"
 			on:click={() => {
-				DocsHelper.open(DocsHelper.linkToIssues());
+				DocsUtils.open(DocsUtils.linkToIssues());
 			}}
 			>Report Issue
 		</Button>
 	</p>
 
 	<h2>Error Messages</h2>
 	<p>
-		When creating <a href={DocsHelper.linkToInputFields()}>Input Fields</a> or
-		<a href={DocsHelper.linkToViewFields()}>View Fields</a>
+		When creating <a href={DocsUtils.linkToInputFields()}>Input Fields</a> or
+		<a href={DocsUtils.linkToViewFields()}>View Fields</a>
 		<strong>warnings</strong>
 		(
 		<ErrorIndicatorComponent
@@ -92,7 +92,7 @@
 
 	<h2>Input Fields</h2>
 	<p>
-		<a href={DocsHelper.linkToInputFields()}>Input Fields</a> let you change the frontmatter of your notes from inside
+		<a href={DocsUtils.linkToInputFields()}>Input Fields</a> let you change the frontmatter of your notes from inside
 		of notes.
 	</p>
 
@@ -103,7 +103,7 @@
 
 	<h2>View Fields</h2>
 	<p>
-		<a href={DocsHelper.linkToViewFields()}>View Fields</a> let you view and perform calculations using the frontmatter
+		<a href={DocsUtils.linkToViewFields()}>View Fields</a> let you view and perform calculations using the frontmatter
 		of your notes from inside of notes. They will update instantly to reflect changes to the frontmatter made by input
 		fields and as fast as obsidian allows it for changes from other sources.
 	</p>
@@ -114,8 +114,8 @@
 			>Bind Targets</a
 		>
 		let the plugin know what frontmatter properties to bind
-		<a href={DocsHelper.linkToInputFields()}>Input Fields</a>
+		<a href={DocsUtils.linkToInputFields()}>Input Fields</a>
 		and
-		<a href={DocsHelper.linkToViewFields()}>View Fields</a> to.
+		<a href={DocsUtils.linkToViewFields()}>View Fields</a> to.
 	</p>
 </div>