Feedback: New WYSIWYG Editor Development API

[ssddanbrown]

Description

This issue is intended to gather feedback for the new WYSIWYG Editor Development API, introduced in BookStack v25.12 (The API, the editor was introduced a while before).

Initially the API is very thin to test the structure and documentation.
I've only implemented a few very common abilities used for customizations.

Going forward, instead of increasing the API surface area based upon guessing what folks may need, I'd prefer it to be driven by user requests, so please let me know what you need to achieve, and what abilities you think are currently missing to be able to achieve it.

[joaquinrovira]

Hi Dan! I am currently using BookStack to host a wiki for a D&D campaign with my friends. I've been attempting to replicate the 5e rulebook aesthetic and have been relying heavily on the Visual Theme System to achieve this with a custom theme.

First things first, I love what you have built. The thoughtfulness and work that has gone into the project is very impressive.

I have been using the beta WYSIWYG editor and have found no issues. My feedback is with regards to the documentation. I am trying to add custom functionality. I want to add a button to "gridify" and existing table so it can better adapt to smaller screens that will:

• Apply width: 100% to the <table> element
• Set the <table> display to grid with display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
• Add display: none to the <colgroup> element
• Add display: contents to all <tbody> and <tr> elements of the table

From what I see in the docs there should be support for calling api.ui.createButton(). Using the browser terminal to inspect the api object I get the following: Uncaught ReferenceError: api is not defined.

I understand then that the code to add custom functionality to the lexical-based editor should be run elsewhere?

For reference, I am running the latest container image lscr.io/linuxserver/bookstack:version-v25.11.6.

[ssddanbrown]

Hi @joaquinrovira,
The API is due to be introduced for the next feature release (likely v25.12), so you won't find it in current releases right now.
Just a warning for when the new API is available: The new editor is backed by a more strict content structure, so it may be more limiting in customizing existing elements/content, although allowing customization to the structure and content is something we can explore as the API progresses.

[ssddanbrown]

BookStack is now managed on Codeberg.

As part of this change, we're closing all existing GitHub issues and pull requests.
You'll instead find this issue on Codeberg here:
https://codeberg.org/bookstack/bookstack/issues/5937

Any further discussion for this will now be done on Codeberg.
Therefore this GitHub thread will be locked.