GrapesJS/grapesjs

[Feature]: Improve UndoManager API

Open

#3,639 opened on Jul 23, 2021

View on GitHubContributor guide
 (9 comments) (1 reaction) (0 assignees)TypeScript (3,702 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (19,449 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Explore the UndoManager source code in grapesjs/src/undo manager to understand how the history stack is built. Look at the current structure of history items (which only store ids) and identify where you could add descriptive information such as component name, action type (added/deleted/edited), and location. Consider creating a new field or modifying the existing history item object to store a human readable description. After researching, propose a minimal API change and submit a pull request.
Tech stack
javascripttypescript
Domain
frontend
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitJavaScriptUndoManager API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60