codex-team/editor.js

TypeError: Cannot read properties of undefined (reading 'isInternal')

Open

#2,563 opened on Dec 16, 2023

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

Description

Hello! I'm trying to create a block tune for one of my apps, here is the code:

class MyBlockTune {
  constructor({ api }) {
    this.api = api;
  }

  isTune() {
    return true
  }

  render() {
    return [
      {
        icon: '<svg>...</svg>',
        label: 'Tune label',
        onActivate: () => { }
      }
    ]
  }
}

After activating it with:

{
  tools: {
    myBlockTune: MyBlockTune,
  },
  tunes: ['myBlockTune'],
}

Editor instance crashes with a following exception thrown:

Which is this line:

After investigating this line a bit with debugger, i can see that this.tunes.myBlockTune is not an instance of anything but is undefined instead.

Editor.js version: 2.28.2

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.
2
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Investigate the block tune initialization in the editor core. Specifically, look at the line where `this.tunes.myBlockTune.isInternal` is called (as shown in the issue screenshot). Ensure that tunes are properly registered and instantiated before use. A potential fix could add a check for the existence of the tune in the tunes object, or ensure the tunes array includes only valid tune instances.
TypeError: Cannot read properties of undefined (reading 'isInternal') · codex-team/editor.js#2563 | Good First Issue