Editor's Path Properties has 'Path Properties' but no 'Notes' field per path — user wanting to leave a comment (e.g., 'this is the outline of the leaf') on a path has no place to write it #378

New issue

Closed

opened 2026-10-04 03:59:53 +00:00 by Mark · 1 comment

Mark commented

2026-10-04 03:59:53 +00:00

Owner

Finding

grep -rn 'pathNote\|pathComment' src/components/editor/ returns 0. The editor has no path notes.

A user with 30 paths:

Wants to label them ("outline of leaf", "vein of leaf", "stem")
The auto-name (per #327) is one approach, but limited
A free-text note is more flexible

The fix is a path notes field.

Where

Path Properties: src/components/editor/EditorRightPanel.tsx
No notes: grep -rn 'pathNote' src/components/editor/ returns 0
The StitchPath type: src/components/editor/types.ts (no note field)

Suggested fix shape

Type: add note: string to the StitchPath type.
UI: a small textarea in the Path Properties section:

<textarea
  value={p.note}
  onChange={(e) => onUpdateNote(p.id, e.target.value)}
  placeholder="Note (e.g., 'outline of leaf')"
  rows={2}
  className="w-full text-[11px] border rounded p-1"
/>

Display: the path list row shows the first 30 characters of the note as a subtitle.
Search: the right panel's path search (per #248) can search the note text.
Use cases:

Documentation
Collaboration
Future reference

Severity**

Low. The user can use the design's overall description. Power users with complex designs notice.

Discovered by

Gap analysis (2026-10-02) of editor path properties.

The rename (per #310) is the short identifier. The note is the longer description.
The reference (per #372) is a more structured attachment. The note is the simple version.
Figma's "Description" on layers is the parallel.

## Finding `grep -rn 'pathNote\|pathComment' src/components/editor/` returns 0. The editor has no path notes. A user with 30 paths: - Wants to label them ("outline of leaf", "vein of leaf", "stem") - The auto-name (per #327) is one approach, but limited - A free-text note is more flexible The fix is a path notes field. ## Where - Path Properties: `src/components/editor/EditorRightPanel.tsx` - No notes: `grep -rn 'pathNote' src/components/editor/` returns 0 - The StitchPath type: `src/components/editor/types.ts` (no `note` field) ## Suggested fix shape 1. **Type**: add `note: string` to the StitchPath type. 2. **UI**: a small textarea in the Path Properties section: ```tsx <textarea value={p.note} onChange={(e) => onUpdateNote(p.id, e.target.value)} placeholder="Note (e.g., 'outline of leaf')" rows={2} className="w-full text-[11px] border rounded p-1" /> ``` 3. **Display**: the path list row shows the first 30 characters of the note as a subtitle. 4. **Search**: the right panel's path search (per #248) can search the note text. 5. **Use cases**: - Documentation - Collaboration - Future reference ## Severity** Low. The user can use the design's overall description. Power users with complex designs notice. ## Discovered by Gap analysis (2026-10-02) of editor path properties. ## Related** - The rename (per #310) is the short identifier. The note is the longer description. - The reference (per #372) is a more structured attachment. The note is the simple version. - Figma's "Description" on layers is the parallel.

Mark added the

feature-request

triage-approved

labels

2026-10-04 03:59:53 +00:00

Mark referenced this issue from a commit

2026-10-05 17:38:19 +00:00

feat(#378): per-path note textarea in editor Path Properties

Mark commented

2026-10-05 17:38:34 +00:00

Author

Owner

feat(#378) shipped on origin/main (commit c38d938).

StitchPath.note?: string added with back-compat comment.
2-row textarea at the top of Path Properties (PathNoteField widget), commits on blur / Ctrl+Enter (single-commit semantics — long notes don't generate one history entry per keystroke). Escape reverts. Mixed-select renders disabled "Mixed (primary ...)" label.
30-character subtitle on the comfortable-view path list row, with ellipsis when the note is longer. Hidden when the note is empty / whitespace-only.
Path-list search now also matches note text in addition to the path name (#248).
Editor-only metadata — pathsToStitchObjects does not see the field, so the note persists with the design JSON but never reaches the PES file.

13 new tests in issue-378.test.tsx all pass; closest-sibling test files (issue-372-panel, issue-372-modal, issue-374) also still green; tsc / eslint clean on the changed files.

feat(#378) shipped on origin/main (commit c38d938). - `StitchPath.note?: string` added with back-compat comment. - 2-row textarea at the top of Path Properties (PathNoteField widget), commits on blur / Ctrl+Enter (single-commit semantics — long notes don't generate one history entry per keystroke). Escape reverts. Mixed-select renders disabled "Mixed (primary ...)" label. - 30-character subtitle on the comfortable-view path list row, with ellipsis when the note is longer. Hidden when the note is empty / whitespace-only. - Path-list search now also matches note text in addition to the path name (#248). - Editor-only metadata — pathsToStitchObjects does not see the field, so the note persists with the design JSON but never reaches the PES file. 13 new tests in issue-378.test.tsx all pass; closest-sibling test files (issue-372-panel, issue-372-modal, issue-374) also still green; tsc / eslint clean on the changed files.

Mark closed this issue

2026-10-05 17:38:37 +00:00

Mark referenced this issue from a commit

2026-10-05 18:11:03 +00:00

feat(#381): path color reference in editor Path Properties — shows which catalog entry matches the path's hex