web: rename to markdown shortcuts

JAsaxon · Mar 5, 2024 · 3465a81 · 3465a81
1 parent 3d1726c
commit 3465a81
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 17 deletions.
diff --git a/apps/web/src/components/editor/tiptap.tsx b/apps/web/src/components/editor/tiptap.tsx
@@ -141,7 +141,9 @@ function TipTap(props: TipTapProps) {
   );
   const dateFormat = useSettingsStore((store) => store.dateFormat);
   const timeFormat = useSettingsStore((store) => store.timeFormat);
-  const inputRules = useSettingsStore((store) => store.inputRules);
+  const markdownShortcuts = useSettingsStore(
+    (store) => store.markdownShortcuts
+  );
   const { toolbarConfig } = useToolbarConfig();
   const { isSearching, toggleSearch } = useSearch();
 
@@ -181,7 +183,7 @@ function TipTap(props: TipTapProps) {
           }
         }
       },
-      enableInputRules: inputRules,
+      enableInputRules: markdownShortcuts,
       downloadOptions,
       doubleSpacedLines,
       dateFormat,
@@ -292,7 +294,14 @@ function TipTap(props: TipTapProps) {
       },
       getAttachmentData: onGetAttachmentData
     };
-  }, [readonly, nonce, doubleSpacedLines, dateFormat, timeFormat, inputRules]);
+  }, [
+    readonly,
+    nonce,
+    doubleSpacedLines,
+    dateFormat,
+    timeFormat,
+    markdownShortcuts
+  ]);
 
   const editor = useTiptap(
     tiptapOptions,

diff --git a/apps/web/src/dialogs/settings/editor-settings.ts b/apps/web/src/dialogs/settings/editor-settings.ts
@@ -114,24 +114,23 @@ symbols (e.g. 202305261253)`,
         ]
       },
       {
-        key: "input-rules",
-        title: "Input rules",
-        description: `Input rules are triggered whenever you input a specific character combination.
+        key: "markdown-shortcuts",
+        title: "Markdown shortcuts",
+        description: `Markdown shortcuts are triggered whenever you input a specific character combination.
         
-A few examples of this:
+For example:
 
 1. Typing '/date' adds the current Date
 2. Wrapping something in '**' turns it into bold text
 3. Typing '1.' automatically creates a numbered list.
-
-This behavior can be disabled via this setting.`,
+4. etc.`,
         onStateChange: (listener) =>
-          useSettingStore.subscribe((c) => c.inputRules, listener),
+          useSettingStore.subscribe((c) => c.markdownShortcuts, listener),
         components: [
           {
             type: "toggle",
-            isToggled: () => useSettingStore.getState().inputRules,
-            toggle: () => useSettingStore.getState().toggleInputRules()
+            isToggled: () => useSettingStore.getState().markdownShortcuts,
+            toggle: () => useSettingStore.getState().toggleMarkdownShortcuts()
           }
         ]
       }

diff --git a/apps/web/src/stores/setting-store.js b/apps/web/src/stores/setting-store.js
@@ -38,7 +38,7 @@ class SettingStore extends BaseStore {
     PATHS.backupsDirectory
   );
   doubleSpacedParagraphs = Config.get("doubleSpacedLines", true);
-  inputRules = Config.get("inputRules", true);
+  markdownShortcuts = Config.get("markdownShortcuts", true);
   notificationsSettings = Config.get("notifications", { reminder: true });
 
   zoomFactor = 1.0;
@@ -167,11 +167,11 @@ class SettingStore extends BaseStore {
     Config.set("doubleSpacedLines", !doubleSpacedParagraphs);
   };
 
-  toggleInputRules = (toggleState) => {
+  toggleMarkdownShortcuts = (toggleState) => {
     this.set((state) => {
-      state.inputRules =
-        toggleState !== undefined ? toggleState : !state.inputRules;
-      Config.set("inputRules", state.inputRules);
+      state.markdownShortcuts =
+        toggleState !== undefined ? toggleState : !state.markdownShortcuts;
+      Config.set("markdownShortcuts", state.markdownShortcuts);
     });
   };