codex-team/editor.js

this.Editor.BlockManager.clear() should be awaited in renderFromHTML()

Open

#2,641 opened on Feb 28, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (26,602 stars) (1,985 forks)batch import
good first issue

Description

I believe this.Editor.BlockManager.clear() should be awaited in renderFromHTML() to prevent errors.

The following example highlights the issue: data.blocks will often be empty as a result of not awaiting clear().

await $editorApi.blocks.renderFromHTML(html);
const data = await $editorApi.saver.save();

Contributor guide

Tech stack
typescript
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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.
clear
Prerequisites
async/await in TypeScriptbasic knowledge of Editor.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue points to the file `src/components/modules/api/blocks.ts` at line 209, where `BlockManager.clear()` is called without `await`. The fix is to add `await` before that call. There are no linked PRs or assignees, so this is open for a newcomer. The issue also provides a clear reproduction example.
this.Editor.BlockManager.clear() should be awaited in renderFromHTML() · codex-team/editor.js#2641 | Good First Issue