codex-team/editor.js

Inline tool from the documentation doesn't work in latest version

Open

#2,827 opened on Sep 23, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (26,602 stars) (1,985 forks)batch import
good first issueissue for docs

Description

Hi,

I'm following the tutorial from the docs to create a marker inline tool. With the exact same code, when I click on the marker button, the color picker is quickly displayed, then disappears, so it can't be used. The doc was last updated several years ago, and works fine with older versions of Editor.js, but not with latest ones. It makes it harder to create my own inline tool.

Steps to reproduce:

  1. Try this code sandbox with the tool code from the docs https://codesandbox.io/p/sandbox/editor-js-forked-pyk98w
  2. Add some text and add a mark from inline tool image
  3. Color picker is diplayed but disappears.
  4. Go to package.json and change editorjs version to 2.15.1 "@editorjs/editorjs": "2.15.1",
  5. If you try again, the color picker of the marker works well.

Editor.js version: 2.30.6

The color plugin I use doesn't work anymore since latest Editor.js updates, see these issues: https://github.com/flaming-cl/editorjs-text-color-plugin/issues/36 https://github.com/flaming-cl/editorjs-text-color-plugin/issues/35#issuecomment-1948699329

So I don't know how to implement a color picker with Editor.js v2.30+.

Thanks

Contributor guide

Tech stack
javascripttypescript
Domain
frontenddocumentation
Issue type
bug
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-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of Editor.jsUnderstanding of inline tool APIJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the difference in behavior between Editor.js versions 2.15.1 and 2.30.6 for the inline tool interaction. Check the changelog at https://github.com/codex team/editor.js/releases for breaking changes. Update the documentation example to use the current API, possibly by adjusting how the color picker is rendered or by using the new lifecycle methods. Any successful fix should be tested against the provided CodeSandbox reproduction.
Inline tool from the documentation doesn't work in latest version · codex-team/editor.js#2827 | Good First Issue