tinymce / tinymce/tinymce

I can't find what I'm looking for: api/tinymce/tinymce.undomanager.html

Open
#6,824 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
16.3k
Forks
2.3k
PR merge metrics
No merged PRs in 30d

Description

I've tried to understand how to use the undo manager when authoring a TinyMCE plugin. I don't understand the overall philosophy:

  • What is an Undo Level (add) vs.
  • What is an Undo Bookmark (beforeChange)
  • What is the best practice for using the api if I am supplying the user a button that styles content, mutates the document?
  • Do I need to always use transact to call my mutator function? Or is it a option? What's the best practice?

For example, my plugin provides an interface for selecting text and wrapping it with a so they can markup the human language changes in the text. It does that by applying a format. I've tried every combo I can imagine to make it work with undo to no avail.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with api/tinymce/tinymce.undomanager.html and review how it defines Undo Levels, Undo Bookmarks, and transact. Clarify the recommended workflow for a plugin that applies a format to selected text, including when each API should be used and what the resulting undo behavior should be.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
documentation, frontend
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.