GrapesJS/grapesjs

[Feature]: Improve UndoManager API

Open

#3,639 opened on Jul 23, 2021

View on GitHub
 (9 comments) (1 reaction) (0 assignees)TypeScript (19,449 stars) (3,702 forks)batch import
featurehelp wanted

Description

One thing i think would add great functionality is a more detailed history stack. U can get the undo stack and build a sort of history report from it of all the edits one has made but it is a little unclear as to what each edit was (at least to me so if I am missing something please let me know). Maybe like a formulaic description that is like component [component name] added/deleted/edited at [location on page or component added to], or component [component] text edited, . . . (please excuse the general description as even i have no clue how i would phrase it) just some quick description that can give a brief overview of what that particular undo/redo history was for each item on the stack. I am aware of only the id of each history item atm, so if this is currently possible I am just unaware of how i should go about extracting this information to create a history sidebar outside of just the id so please give me a clue as what to look for

Is there an alternative at the latest version?

  • Yes (describe the alternative)
  • [ x] No

Is this related to an issue?

  • Yes (Give a link to the issue)
  • [ x] No

Contributor guide

Tech stack
typescriptjavascripthtmlcss
Domain
frontenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
Understanding of GrapesJS UndoManager APIFamiliarity with TypeScriptBasic knowledge of history/undo patterns
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Start by examining the UndoManager module in the GrapesJS source (likely src/undo manager.js or .ts). Understand how history items are currently stored (with IDs) and what data they contain. Review the comments in issue #3639 for any additional context. Consider designing a way to generate human readable descriptions for each action (e.g., 'Added component X to page Y') and propose modifications to the history stack API to expose these descriptions.
[Feature]: Improve UndoManager API · GrapesJS/grapesjs#3639 | Good First Issue