Merge pull request #4 from matthewturk/default-file

Add default-file settings.

README.md

@@ -53,8 +53,14 @@ file.
 
 - [ ] Add support for [metadatamenu](https://github.com/mdelobelle/metadatamenu) `fileClass`es to apply `sidecar-panel` attributes across queries.
 - [x] Add per-tag support, so that not all files have to have their properties modified to benefit.
+- [x] Add a default sidecar file and allow it to always be used even if others are to be applied.
 - [ ] Better support changes in properties and sidecar files for open files.
 
+## Version History
+
+- 0.2.3 -- First release in the plugin list!
+- 0.2.4 -- Add a default panel file and a toggle to always apply it.
+
 ## License
 
 This template is available under the [MIT License](LICENSE). Feel free to modify

manifest.json

@@ -4,7 +4,7 @@
 	"description": "Add a context-dependent sidecar panel.",
 	"author": "Matthew Turk",
 	"authorUrl": "https://matthewturk.github.io/",
-	"version": "0.2.3",
+	"version": "0.2.4",
 	"minAppVersion": "0.15.0",
 	"isDesktopOnly": false
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "sidecar-panel",
   "private": true,
-  "version": "0.2.3",
+  "version": "0.2.4",
   "main": "main.js",
   "type": "module",
   "scripts": {

public/versions.json

@@ -8,5 +8,6 @@
 	"0.2.0": "0.15.0",
 	"0.2.1": "0.15.0",
 	"0.2.2": "0.15.0",
-	"0.2.3": "0.15.0"
+	"0.2.3": "0.15.0",
+	"0.2.4": "0.15.0"
 }

src/components/ContextualSidecarPanel.svelte

@@ -31,6 +31,20 @@
     if (cache) {
       const fileTags = getAllTags(cache) || [];
       let sidecarPanelMarkdown: string[] = [];
+      // If the default panel is set, and the file doesn't have a sidecar-panel, or the alwaysUseDefaultPanel is set, then use the default panel.
+      if ($contextualSidecarPanelSetting.defaultPanel !== "") {
+        if (
+          $contextualSidecarPanelSetting.alwaysUseDefaultPanel ||
+          !(cache.frontmatter && cache.frontmatter["sidecar-panel"])
+        ) {
+          sidecarPanelMarkdown.push(
+            await readSidecarPanel(
+              $contextualSidecarPanelSetting.defaultPanel,
+              "/"
+            )
+          );
+        }
+      }
       for (const { tag, panel } of $contextualSidecarPanelSetting.tagMaps) {
         // I don't like that this is quadratic.  But, it shouldn't be called that often.  Right?
         const normalizedTag = tag.startsWith("#") ? tag.slice(1) : tag;

src/main.ts

@@ -82,6 +82,33 @@ class ContextualSidecarPanelSettingTab extends PluginSettingTab {
 
     // Some of this logic was inspired by the bwydoogh/obsidian-force-view-mode-of-note plugin.
 
+    new Setting(this.containerEl)
+      .setName("Default Panel")
+      .setDesc(
+        "Specify a default sidebar panel file, if none is set in the frontmatter."
+      )
+      .addSearch((cb) => {
+        cb.setPlaceholder("Example: daily-note-panel")
+          .setValue(this.plugin.settings.defaultPanel)
+          .onChange(async (newPanel) => {
+            this.plugin.settings.defaultPanel = newPanel;
+            await this.plugin.saveSettings();
+          });
+      });
+    new Setting(this.containerEl)
+      .setName("Always use default panel?")
+      .setDesc(
+        "If checked, the default panel will be used for all files, even if one is specified in the frontmatter."
+      )
+      .addToggle((cb) => {
+        cb.setValue(this.plugin.settings.alwaysUseDefaultPanel).onChange(
+          async (value) => {
+            this.plugin.settings.alwaysUseDefaultPanel = value;
+            await this.plugin.saveSettings();
+          }
+        );
+      });
+
     new Setting(this.containerEl).setDesc(
       "Specify a sidecar panel for all files with a given tag.  These will be applied in order."
     );

src/types.ts

@@ -1,6 +1,10 @@
 export interface ContextualSidecarPanelSettings {
+	defaultPanel: string;
+	alwaysUseDefaultPanel: boolean;
 	tagMaps: { tag: string; panel: string }[];
 }
 export const DEFAULT_SETTINGS: ContextualSidecarPanelSettings = {
+	defaultPanel: "",
+	alwaysUseDefaultPanel: false,
 	tagMaps: [],
 };