feat: you can now edit the render toggle key (#144)

* feat: you can now edit the render toggle key

* chore: version bumps

* chore: removed blank space

---------

Co-authored-by: April <april@groover.co>

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "aprils-automatic-timelines",
 	"name": "April's Automatic Timelines",
-	"version": "0.13.1",
+	"version": "0.13.2",
 	"minAppVersion": "0.15.0",
 	"description": "Simple timeline generator for story tellers",
 	"author": "April Gras",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "obsidian-auto-timelines",
-	"version": "0.13.1",
+	"version": "0.13.2",
 	"description": "This Obsidian (https://obsidian.md) plugin aims to simplify creating and maintaining timelines in different a project",
 	"main": "main.js",
 	"type": "module",

src/cardData.ts

@@ -8,11 +8,6 @@ import {
 	getTagsFromMetadataOrTagObject,
 } from "./cardDataExtraction";
 
-/**
- * A un-changeable key used to check if a note is eligeable for render.
- */
-const RENDER_GREENLIGHT_METADATA_KEY = ["aat-render-enabled"];
-
 /**
  * Provides additional context for the creation cards in the DOM.
  *
@@ -28,8 +23,7 @@ export async function getDataFromNoteMetadata(
 	const { frontmatter: metaData, tags } = cachedMetadata;
 
 	if (!metaData) return undefined;
-	if (!RENDER_GREENLIGHT_METADATA_KEY.some((key) => metaData[key] === true))
-		return undefined;
+	if (metaData[settings.eventRenderToggleKey] !== true) return undefined;
 
 	const timelineTags = getTagsFromMetadataOrTagObject(
 		settings,

src/locales/en.json

@@ -65,6 +65,7 @@
       "dateFontSize": "Override the font size of the date in the timeline cards (value in pixels)",
       "titleFontSize": "Override the font size of the title in the timeline cards (value in pixels)",
       "bodyFontSize": "Override the font size of the body in the timeline cards (value in pixels)",
+      "eventRenderToggleKey": "Render toggle key",
       "configureSingleDateToken": {
         "type": "The type of the token",
         "conditionalFormatting": "Add additional formatting"
@@ -106,6 +107,7 @@
       "lookForInlineEventsInNotes": "Check {linkText} on how to create inline events.",
       "applyAdditonalConditionFormatting": "Toggle on to allow date tokens conditional formatting to be allowed. When set to false this feature will be skipped. This could save you a few milliseconds off every card render.",
       "stylizeDateInline": "Turn on for a more compact display in your timeline event cards. Or turn off for more space.",
+      "eventRenderToggleKey": "The key used to control if a perculiar event is rendered or not",
       "configureSingleDateToken": {
         "STRING": "A string typed date token represents something akin to our months. tl;dr, they are written using letter and not numbers",
         "NUMBER": "A numerical typed date token is your stardard number representing a date. Just make sure to configure it's mininal lengh. For example a minimal length set to 2 will result in the 6th day being written as \"06\""

src/markdownBlockData.ts

@@ -51,7 +51,7 @@ export const acceptedSettingsOverride = [
 	"dateFontSize",
 	"titleFontSize",
 	"bodyFontSize",
-] as const;
+] satisfies (keyof AutoTimelineSettings)[];
 
 /**
  * Checks if a given string is part of the settings keys that can be overriden.

src/settings.ts

@@ -21,6 +21,7 @@ export const SETTINGS_DEFAULT = {
 	dateDisplayFormat: "{day}/{month}/{year}",
 	dateParserGroupPriority: "year,month,day",
 	dateParserRegex: "(?<year>-?[0-9]*)-(?<month>-?[0-9]*)-(?<day>-?[0-9]*)",
+	eventRenderToggleKey: "aat-render-enabled",
 	inlineEventEndOfBodyMarker: "%%aat-event-end-of-body%%",
 	markdownBlockTagsToFindSeparator: ",",
 	metadataKeyEventBodyOverride: "aat-event-body",

src/views/VSettings.vue

@@ -28,6 +28,7 @@ const generalSettingKeys = [
 	"markdownBlockTagsToFindSeparator",
 	"noteInlineEventKey",
 	"inlineEventEndOfBodyMarker",
+	"eventRenderToggleKey",
 ] satisfies (keyof PickByType<AutoTimelineSettings, string>)[];
 
 const fantasyCalendarPreset: Record<

versions.json

@@ -38,5 +38,6 @@
 	"0.12.1": "0.15.0",
 	"0.12.2": "0.15.0",
 	"0.13.0": "0.15.0",
-	"0.13.1": "0.15.0"
+	"0.13.1": "0.15.0",
+	"0.13.2": "0.15.0"
 }