-
Notifications
You must be signed in to change notification settings - Fork 7
ENG-2038 Add admin-flagged node card context menu to Obsidian tldraw #1255
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sid597
wants to merge
5
commits into
main
Choose a base branch
from
eng-2038-add-admin-flagged-node-card-context-menu-to-obsidian-tldraw
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b13ee4c
ENG-2038 Add admin-flagged node card context menu
sid597 b6f04e1
ENG-2038 Tighten node card context menu scope
sid597 84237b9
ENG-2038 Remove Obsidian test scaffolding
sid597 91862c1
ENG-2038 Tighten node card context menu
sid597 fe0df5a
ENG-2038 Remove redundant menu wrapper
sid597 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
apps/obsidian/src/components/canvas/NodeCardContextMenu.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| import { createElement, useEffect, useState, type ComponentType } from "react"; | ||
| import type { TFile } from "obsidian"; | ||
| import { | ||
| DefaultStylePanel, | ||
| DefaultStylePanelContent, | ||
| useEditor, | ||
| useRelevantStyles, | ||
| useValue, | ||
| type TLUiStylePanelContentProps, | ||
| type TLUiStylePanelProps, | ||
| } from "tldraw"; | ||
| import type DiscourseGraphPlugin from "~/index"; | ||
| import type { DiscourseNodeShape } from "./shapes/DiscourseNodeShape"; | ||
| import { RelationsPanel } from "./overlays/RelationPanel"; | ||
|
|
||
| type NodeCardContextMenuProps = TLUiStylePanelProps & { | ||
| plugin: DiscourseGraphPlugin; | ||
| canvasFile: TFile; | ||
| }; | ||
|
|
||
| const NODE_CARD_CONTEXT_MENU_TABS = [ | ||
| { id: "context", label: "Context" }, | ||
| { id: "styling", label: "Styling" }, | ||
| ] as const; | ||
|
|
||
| type NodeCardContextMenuTab = | ||
| (typeof NODE_CARD_CONTEXT_MENU_TABS)[number]["id"]; | ||
|
|
||
| const DefaultStylePanelComponent = | ||
| DefaultStylePanel as unknown as ComponentType<TLUiStylePanelProps>; | ||
| const DefaultStylePanelContentComponent = | ||
| DefaultStylePanelContent as unknown as ComponentType<TLUiStylePanelContentProps>; | ||
|
|
||
| export const NodeCardContextMenu = ({ | ||
| plugin, | ||
| canvasFile, | ||
| isMobile, | ||
| }: NodeCardContextMenuProps) => { | ||
| const editor = useEditor(); | ||
| const styles = useRelevantStyles(); | ||
| const isEnabled = plugin.settings.nodeCardContextMenuEnabled ?? false; | ||
| const selectedShape = useValue( | ||
| "selected shape for node card context menu", | ||
| () => editor.getOnlySelectedShape(), | ||
| [editor], | ||
| ); | ||
| const selectedNode = | ||
| isEnabled && selectedShape?.type === "discourse-node" | ||
| ? (selectedShape as DiscourseNodeShape) | ||
| : null; | ||
| const [activeTab, setActiveTab] = useState<NodeCardContextMenuTab>("context"); | ||
|
|
||
| useEffect(() => { | ||
| setActiveTab("context"); | ||
| }, [selectedNode?.id]); | ||
|
|
||
| if (!selectedNode) { | ||
| return createElement(DefaultStylePanelComponent, { isMobile }); | ||
| } | ||
|
|
||
| return createElement( | ||
| DefaultStylePanelComponent, | ||
| { isMobile }, | ||
| <div className="dg-node-card-menu"> | ||
| <div className="grid grid-cols-2 border-b border-[var(--color-divider)] bg-[var(--color-panel)]"> | ||
| {NODE_CARD_CONTEXT_MENU_TABS.map(({ id, label }) => ( | ||
| <button | ||
| key={id} | ||
| type="button" | ||
| aria-pressed={activeTab === id} | ||
| className={[ | ||
| "border-b-2 px-3 py-2 text-xs font-semibold", | ||
| activeTab === id | ||
| ? "border-[var(--color-selected)] text-[var(--color-selected)]" | ||
| : "border-transparent text-[var(--color-text-3)]", | ||
| ].join(" ")} | ||
| onClick={() => setActiveTab(id)} | ||
| > | ||
| {label} | ||
| </button> | ||
| ))} | ||
| </div> | ||
|
|
||
| {activeTab === "context" ? ( | ||
| <RelationsPanel | ||
| plugin={plugin} | ||
| canvasFile={canvasFile} | ||
| nodeShape={selectedNode} | ||
| embedded | ||
| includeAllDirections | ||
| /> | ||
| ) : ( | ||
| createElement(DefaultStylePanelContentComponent, { styles }) | ||
| )} | ||
| </div>, | ||
| ); | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔴 Selecting a node card silently edits the canvas note and can append duplicate link blocks
The relations list is now shown automatically whenever a single node card is selected (
RelationsPanelatapps/obsidian/src/components/canvas/NodeCardContextMenu.tsx:85-91), and merely showing it writes new link blocks into the canvas note, so users get unexpected file edits just by clicking a card.Impact: Clicking a node card can modify the saved canvas note without any user action, and repeated re-renders while dragging can append the same link text over and over.
How rendering the relations list triggers vault writes
Each listed related file is rendered as a
RelationFileItem, whose mount effect callscheckExistingRelation(apps/obsidian/src/components/canvas/overlays/RelationPanel.tsx:76-90).checkExistingRelationcallsensureBlockRefForFile(apps/obsidian/src/components/canvas/overlays/RelationPanel.tsx:269-273), which, when no existing block ref points at the target file, appends[[link]]\n^uuidto the canvas markdown viaapp.vault.process(apps/obsidian/src/components/canvas/stores/assetStore.ts:143-155).Previously this only ran after the user explicitly opened the floating Relations panel via the overlay button (
apps/obsidian/src/components/canvas/overlays/RelationOverlay.tsx:80-101). With the new style-panel menu the panel mounts on every single-node selection.Additionally,
checkExistingRelationis re-created on everyRelationsPanelrender and is in the effect's dependency array, andNodeCardContextMenure-renders whenever the selected shape record changes (e.g. while dragging, viauseValueatapps/obsidian/src/components/canvas/NodeCardContextMenu.tsx:42-46). Because Obsidian'smetadataCacheupdates asynchronously, consecutive invocations can miss the just-written block and append another duplicate block for the same file.Prompt for agents
Was this helpful? React with 👍 or 👎 to provide feedback.