TypeCellOS / TypeCellOS/BlockNote

Unable to programmatically select a single inline element

Open
#2,864 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug:P2
Dominant language
TypeScript
Stars
10.2k
Forks
772
Avg merge
3d 11h
Merged PRs (30d)
17

Description

What’s broken?

At OpenProject, we're building an extension to have custom work package links for the BlockNote editor.
However, currently the behaviour when clicking on such an inline link is broken:

  1. The user expects after clicking on the element that when Ctrl-C and Ctrl-V are pressed, the work package link is copied
  2. The user expects after clicking on the element and pressing "del" or "backspace" that the element is removed from the document

It would be easy to solve both expectations, if we could select a single inline block. However, this is not possible at the moment via BlockNote, because it's not possible to select a single inline content.

Furthermore, when we force selection via ProseMirror, BlockNote opens a formatting toolbar. This toolbar does not make sense in our case, since you can't e.g. change font boldness or italics on our custom inline work package link.

What did you expect to happen?

What we need is:

  1. Be able to select a single inline element via editor.setSelection
  2. Be able to pass in if we want the formatting toolbar to open or not, e.g. showFormattingToolbar: true|false
Steps to reproduce
  1. Write your own extension with inline elements
  2. Try editor.setSelection on a single inline element
BlockNote version

0.51.3

Environment

No response

Additional context
Image

We would like to solve this in a clean way 🙂 At the moment we're exploring the following options:

  • Set selection via ProseMirror (solves our requirements but opens formatting toolbar)
  • Attach our own handlers which intercept copy-paste, keypress etc. when the inline element was clicked (and remove the handlers when the focus is removed)

If you see other good ways to solve our problem, we're happy about suggestions!

Contribution
  • I'd be interested in contributing a fix for this issue
Sponsor
  • I'm a sponsor and would appreciate if you could look into this sooner than later 💖

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 packages/core/src/api/blockManipulation/selections/selection.ts and the editor.setSelection entry point mentioned in the issue. Trace how single inline selections are represented and why forcing a ProseMirror selection opens the formatting toolbar. Done means a single inline element can be selected through editor.setSelection and callers can control whether the formatting toolbar opens.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.