enhance: link pane type setting

Author: ycnmhd

src/lang/lang.ts

@@ -303,6 +303,11 @@ export const lang = {
     settings_layout: 'Layout',
     settings_reset: 'Reset',
 
+    // general settings
+    settings_general_link_split: 'Open in a new split',
+    settings_general_link_tab: 'Open in a new tab',
+    settings_general_link_behavior: 'Default link behavior',
+
     // hotkeys
     modals_hk_input_placeholder: 'Filter',
     modals_hk_editor_cancel: 'Cancel',

src/stores/settings/default-settings.ts

@@ -37,6 +37,7 @@ export const DEFAULT_SETTINGS = (): Settings => ({
     },
     general: {
         defaultDocumentFormat: 'sections',
+        linkPaneType: 'tab',
     },
     styleRules: {
         documents: {},

src/stores/settings/settings-reducer.ts

@@ -3,6 +3,7 @@ import {
     DocumentPreferences,
     LeftSidebarTab,
     LineageDocumentFormat,
+    LinkPaneType,
     RulesTab,
     Settings,
     ViewType,
@@ -188,6 +189,12 @@ export type SettingsActions =
               id: ToolbarButton;
               hide: boolean;
           };
+      }
+    | {
+          type: 'settings/general/set-link-pane-type';
+          payload: {
+              position: LinkPaneType;
+          };
       };
 
 export type PersistCollapsedSectionsAction = {
@@ -452,6 +459,8 @@ const updateState = (store: Settings, action: SettingsActions) => {
         }
     } else if (action.type === 'settings/style-rules/set-active-tab') {
         store.styleRules.settings.activeTab = action.payload.tab;
+    } else if (action.type === 'settings/general/set-link-pane-type') {
+        store.general.linkPaneType = action.payload.position;
     } else if (action.type.startsWith('settings/style-rules')) {
         updateStyleRules(store, action);
     }

src/stores/settings/settings-type.ts

@@ -41,6 +41,7 @@ export type LeftSidebarTab = 'pinned-cards' | 'recent-cards';
 
 export type RulesTab = 'global-rules' | 'document-rules';
 
+export type LinkPaneType = 'split' | 'tab';
 export type Settings = {
     documents: Record<string, DocumentPreferences>;
     hotkeys: {
@@ -69,6 +70,7 @@ export type Settings = {
     };
     general: {
         defaultDocumentFormat: LineageDocumentFormat;
+        linkPaneType: LinkPaneType;
     };
     styleRules: {
         documents: { [path: string]: { rules: StyleRule[] } };

src/view/actions/settings/components/link-pane-type.ts

@@ -0,0 +1,35 @@
+import { SettingsStore } from 'src/main';
+import { Setting } from 'obsidian';
+import { LinkPaneType as TLinkPaneType } from 'src/stores/settings/settings-type';
+import { lang } from 'src/lang/lang';
+import { isMacLike } from 'src/view/actions/keyboard-shortcuts/helpers/keyboard-events/mod-key';
+
+export const LinkPaneType = (
+    element: HTMLElement,
+    settingsStore: SettingsStore,
+) => {
+    const settingsState = settingsStore.getValue();
+    const setting = new Setting(element).setName(
+        lang.settings_general_link_behavior,
+    );
+    setting.setDesc(
+        `Press '${isMacLike ? 'cmd' : 'control'}' to use the other option`,
+    );
+    setting.addDropdown((cb) => {
+        const value = settingsState.general.linkPaneType;
+
+        cb.addOptions({
+            split: lang.settings_general_link_split,
+            tab: lang.settings_general_link_tab,
+        } satisfies Record<TLinkPaneType, string>)
+            .setValue(value)
+            .onChange((value) => {
+                settingsStore.dispatch({
+                    type: 'settings/general/set-link-pane-type',
+                    payload: {
+                        position: value as TLinkPaneType,
+                    },
+                });
+            });
+    });
+};

src/view/actions/settings/render-settings.ts

@@ -15,12 +15,14 @@ import { ActiveBranchColor } from 'src/view/actions/settings/components/active-b
 import { AlwaysShowCardButtons } from 'src/view/actions/settings/components/always-show-card-buttons';
 import { ControlsBarButtons } from 'src/view/actions/settings/components/controls-bar-buttons/controls-bar-buttons';
 import { HeadingsFontSize } from 'src/view/actions/settings/components/headings-font-size';
+import { LinkPaneType } from 'src/view/actions/settings/components/link-pane-type';
 
 export const renderSettings = (element: HTMLElement) => {
     const view = getView();
     const settingsStore = view.plugin.settings;
     const render = () => {
         DefaultDocumentFormat(element, settingsStore);
+        LinkPaneType(element, settingsStore);
         MaintainEditMode(element, settingsStore);
         AlwaysShowCardButtons(element, settingsStore);
         ControlsBarButtons(element, view);

src/view/components/container/column/components/group/components/card/components/content/event-handlers/handle-links/block-link/handle-block-link.ts

@@ -2,7 +2,11 @@ import { LineageView } from 'src/view/view';
 import { handleLocalBlockLink } from 'src/view/components/container/column/components/group/components/card/components/content/event-handlers/handle-links/block-link/handle-local-block-link';
 import { handleGlobalBlockLink } from 'src/view/components/container/column/components/group/components/card/components/content/event-handlers/handle-links/block-link/handle-global-block-link';
 
-export const handleBlockLink = (view: LineageView, link: string) => {
+export const handleBlockLink = (
+    view: LineageView,
+    link: string,
+    modKey: boolean,
+) => {
     const viewFilePath = view.file!.basename;
     const match = /(.*)#\^(\S{4,})$/.exec(link);
     if (match) {
@@ -11,7 +15,7 @@ export const handleBlockLink = (view: LineageView, link: string) => {
         if (!file.trim() || file === viewFilePath) {
             handleLocalBlockLink(view, id);
         } else {
-            handleGlobalBlockLink(view, link);
+            handleGlobalBlockLink(view, link, modKey);
         }
     }
 };

src/view/components/container/column/components/group/components/card/components/content/event-handlers/handle-links/block-link/handle-global-block-link.ts

@@ -1,5 +1,22 @@
 import { LineageView } from 'src/view/view';
 
-export const handleGlobalBlockLink = (view: LineageView, link: string) => {
-    view.plugin.app.workspace.openLinkText(link, view.file!.basename, 'split');
+export const getLinkPaneType = (view: LineageView, modKey: boolean) => {
+    const linkPaneType = view.plugin.settings.getValue().general.linkPaneType;
+    if (modKey) {
+        return linkPaneType === 'tab' ? 'split' : 'tab';
+    } else {
+        return linkPaneType;
+    }
+};
+
+export const handleGlobalBlockLink = (
+    view: LineageView,
+    link: string,
+    modKey: boolean,
+) => {
+    view.plugin.app.workspace.openLinkText(
+        link,
+        view.file!.basename,
+        getLinkPaneType(view, modKey),
+    );
 };

src/view/components/container/column/components/group/components/card/components/content/event-handlers/handle-links/file-link/handle-file-link.ts

@@ -0,0 +1,21 @@
+import { LineageView } from 'src/view/view';
+import { openFileInExistingRightTabGroup } from 'src/view/components/container/column/components/group/components/card/components/content/event-handlers/handle-links/helpers/open-file-in-existing-right-tab-group';
+import { getLinkPaneType } from 'src/view/components/container/column/components/group/components/card/components/content/event-handlers/handle-links/block-link/handle-global-block-link';
+
+export const handleFileLink = (
+    view: LineageView,
+    link: string,
+    modKey: boolean,
+) => {
+    const path = view.file?.path;
+    if (!link || !path) return;
+    const paneType = getLinkPaneType(view, modKey);
+    if (paneType === 'tab') {
+        view.plugin.app.workspace.openLinkText(link, path, 'tab');
+    } else {
+        const success = openFileInExistingRightTabGroup(view, link, path);
+        if (!success) {
+            view.plugin.app.workspace.openLinkText(link, path, 'split');
+        }
+    }
+};