Roadmap to stable v2

[philippkuehn]

Hey, it’s amazing how far tiptap v2 beta has already made it. Thanks a lot for your support. 🙌

I'm trying to make a list here of features we still want to implement until stable v2.
This list is not final. If you have any wishes, please comment below.

Features

• Autolink on type Autolink #1209
• Find a better implementation of getCharacterCount, CharacterCount.limit does not match getCharacterCount() or state.doc.content.size #1839

Breaking Changes

• Add custom implementation of InputRule, Integrate input rules and paste rules into the core #1997
• Replace defaultOptions with addOptions() for extensions, Replace defaultOptions with addOptions #2088
• Refactor core commands (possibly simplify, merge, find clearer names, etc.)
• Use the new storage feature in CharacterCount
• Use the new storage feature in CollaborationCursor

QA

• Add at least one test for every example

Docs

• Add docs for missing commands

Misc

• Switch setup from yarn to npm

[sereneinserenade]

Will #2075 be a part of stable v2?

edit: people searching for search-n-replace extension, take a look at https://github.com/sereneinserenade/tiptap-search-n-replace-demo

[mhmttosun]

Will more complete image extension (like resizeable, custom upload, Caption, paste image) be part of stable version?

[cadars]

My wish would be to improve the general text editing experience: a more consistent behaviour to be able to exit all node types, and delete them with backspace when empty?

Some examples:

• when last in the document, <hr> creates an extra node, table uses the gapcursor extension, and code blocks are only escapable with shift + enter (which is not possible on mobile, so the trailing node extension is needed).
• when first in the document, backspace can delete an empty blockquote, but not an empty heading.

[hanspagel]

We won’t tie the stable release to any extension release, but we’ll definitely focus more on extension development for the next months. ✌️

[rezaffm]

Great to see that it is progressing. Working with the current version already in production and all good so far.

[pdmwxy]

We won’t tie the stable release to any extension release, but we’ll definitely focus more on extension development for the next months. ✌️

My wish is to add the function of change tracking. At present, the project urgently needs this function. Can you reply whether there is a plan to add this function, or whether it is available in the pro version?

[yellow1912]

I think you need to document these BreakingChanges and what to do as well. I had to track down the issues to understand what went wrong and the changes needed.

[hanspagel]

Thanks for sharing, but this is really off topic. If there are more questions related to title/subtitle documents, please open a new question under discussions.

[rezaffm]

True, looking forward to your stable release guys

[felix-berlin]

Will more complete image extension (like resizeable, custom upload, Caption, paste image) be part of stable version?

That's exactly what I want too!

[sereneinserenade]

Here's the repo https://github.com/sereneinserenade/tiptap-media-resize. You can try it out here https://sereneinserenade.github.io/tiptap-media-resize/ and here's a demo video.

Screen.Recording.2022-07-09.at.23.20.25.mov

[creatorrr]

Thanks for the awesome work, @philippkuehn ! Quick question: I got a bunch of errors from the typescript compiler when I tried building my tiptap project for @tiptap/core. Still trying to figure out if I am doing something wrong but I thought I'd report these anyway.

(...clipped)

node_modules/@tiptap/core/src/helpers/isList.ts:20:59 - error TS2339: Property 'group' does not exist on type 'NodeConfig<any, any>'.

20   const group = callOrReturn(getExtensionField<NodeConfig['group']>(extension, 'group', context))
                                                             ~~~~~~~

node_modules/@tiptap/core/src/pasteRules/nodePasteRule.ts:31:12 - error TS2339: Property 'deleteRange' does not exist on type 'ChainedCommands'.

31           .deleteRange(range)
              ~~~~~~~~~~~


Found 190 errors in 61 files.

Errors  Files
     1  node_modules/@tiptap/core/src/Editor.ts:103
    28  node_modules/@tiptap/core/src/Extension.ts:70
    18  node_modules/@tiptap/core/src/ExtensionManager.ts:57
    28  node_modules/@tiptap/core/src/Mark.ts:76
    29  node_modules/@tiptap/core/src/Node.ts:76
     2  node_modules/@tiptap/core/src/NodeView.ts:243
     1  node_modules/@tiptap/core/src/commands/blur.ts:14
     1  node_modules/@tiptap/core/src/commands/clearContent.ts:14
     1  node_modules/@tiptap/core/src/commands/clearNodes.ts:16
     2  node_modules/@tiptap/core/src/commands/command.ts:5
     1  node_modules/@tiptap/core/src/commands/createParagraphNear.ts:16
     1  node_modules/@tiptap/core/src/commands/deleteNode.ts:17
     1  node_modules/@tiptap/core/src/commands/deleteRange.ts:14
     1  node_modules/@tiptap/core/src/commands/deleteSelection.ts:16

(...clipped)

npx tsc --version                                                                                                                                                      3s
Version 4.8.2

[bdbch]

Hey @creatorrr what are your Tiptap package versions? It seems like you have some mismatching of Prosemirror versions going on which results in Typescript errors.

[bdbch]

I am going to close this issue for now.

Everything from the original list for 2.0.0 is done by now, but I have found a few weird editor behaviors (thanks to @rfgamaral) that I would like to fix before 2.0.0 including weird joining of nodes when backspace or delete is used that is not in line with expected behaviors from Google Docs, Dropbox Paper and Co. (which are usually the solutions people would expect from a text editor).

We also have some open issues about NodeViews that we should fix before releasing a stable version.

We have a 2.0.0 Milestone for now and will plan out potential open issues for our stable release in there.

[rfgamaral]

Hey @bdbch, I want to propose a few additional issues for the v2.0.0 milestone. I am a bit biased on these, yes, but I believe that most of these are just as important for a stable v2. Please note that all the issues linked below have been closed by the stale bot, but they are still issues.

Most of them are related to the suggestion utility, which, IMO, needs a lot of improvement and is currently a bit buggy:

• Quit suggestions and remove decoration #214
• [Suggestion extension]: Can't espace suggestion mode when allowSpaces is enabled #2159
• [Suggestion Utility] Tippy.js: Potential memory leak with the mentions extension #2547
• [Suggestion Utility] Late promise resolutions should be ignored if the rendered was destroyed #2592
• Suggestion menu appears when clicking on potential mention #2680

Then, a few others with lower priority:

• HorizontalRule extension: inconsistent behavior #1964
• Hash character with the suggestion utility conflicts with heading Markdown shortcut #2570