Page cover

Plugin Setup

Excalidraw Docs

How to setup the Plugin:

  1. Add the Whiteboard Element to the page.

  2. Adjust the General Settings, and optionally the Other settings. Initial Data should be the pure JSON output, if nothing is provided it shows the default screen.

  3. When the canvas changes, the event "Value Updated" is fired so you can sync the new data. The most recent Canvas state can be accessed from the element state "Value".

General Settings

Main Settings

Initial Data: The initial value of the Canvas.

Autofocus: To focus to the nearest element when loading the Canvas

Editor Language: See Available options here.

Name: A Unique name of the Canvas

Editor Theme: Options: Light/Dark

Other Settings

View Only: The Canvas will be Read Only

Enable Zen Mode: This will hide most options, to have a minimalist canvas.

Enable Grid Mode: This will add grids to the canvas.

Enable Background Color Picker: This will add an option to the Menu to choose a different background color.

Enable Saving File to Disk: Option to export the Canvas as open format.

Enable Loading Scene: Can import a canvas

Enable Toggling Theme: Option inside Menu to toggle between light/dark.

Enable Saving as Image: Ability to export to Image.

Enable Global Keyboard: How the Keyboard shortcuts should work.

Color Settings

Color Options to override the primary colors for both Light and Dark mode.

Last updated