Skip to main content

BoxBox

Wolfram Kernel
Execution environment
wljs-editor
Package
Notebook`EditorUtils`
Context

Used to decorate Wolfram Expression with custom HTML elements

(*BB[*)(expr)(*,*)(*view*)(*]BB*)

This is used by Ket, Frame and other editable decorations

  • the expression is editable
  • a common WL editor is spawned inside
  • only the container of the editor can be decorated (see Head)

There is a helper function to prevent an editor from rendering, if you want to write using this low-level representation

BoxBox[expr_Boxes | _String, decorator_, opts___]

it will substitute expr into a subeditor and decorate it using decorator expression executed on WLJS Interpreter.

Options​

Provides a head symbol of the wrapper expression, that will be hidden from the inner editor. It comes handy when you need to preserve the original from of the expression during the editing

tip

Use Head option to keep the wrapping expression

"String"​

Default is false. If it is set to True, double quotes will be cut and a simplified version of a widget will be used.

"HeadString"​

Works only if "String" -> True. Specifies the opening sequence of a string, that will not be shown in the view.

"TailString"​

Works only if "String" -> True. The same as above, but for the ending sequence.

Examples​

Change the display value and call arbitrary WLJS function​

This is a dummy example

special /: MakeBoxes[special, StandardForm] := BoxBox["1+1", Alert["Hi"]]


special

Styling expression using JS​

One can define its own style of cells boxes

.js
core.Styler = async (args, env) => {
  env.element.style.boxShadow = "1px 1px 5px black";
}
wrapper /: MakeBoxes[wrapper[expr_], StandardForm] := BoxBox[MakeBoxes[expr, StandardForm], Styler, Head->wrapper]

and then try

wrapper[1/2]

Result

The neat thing is you can edit the inner expression

note

This is how Ket, Bra are implemented for instance

Last updated on