> For the complete documentation index, see [llms.txt](https://docs.relevat.hu/excalidraw-whiteboard/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.relevat.hu/excalidraw-whiteboard/plugin-setup.md).

# Plugin Setup

{% embed url="<https://docs.excalidraw.com/>" %}
Excalidraw Docs
{% endembed %}

How to setup the Plugin:<br>

1. Add the Whiteboard Element to the page.<br>
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.<br>
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

<figure><img src="https://215762747-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fpbyr2izBTIBIhkjJJsUz%2Fuploads%2FNiqXaN9HQlx4HPCjEX7n%2Fimage.png?alt=media&amp;token=682a3de7-f61a-4208-80b4-2f8af36f8e65" alt=""><figcaption><p>Main Settings</p></figcaption></figure>

Initial Data: The initial value of the Canvas.&#x20;

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

Editor Language: See Available options [here](https://github.com/excalidraw/excalidraw/blob/master/src/i18n.ts#L15).

Name: A Unique name of the Canvas

Editor Theme: Options: Light/Dark

### Other Settings

<figure><img src="https://215762747-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fpbyr2izBTIBIhkjJJsUz%2Fuploads%2FXhPLbO4mMoDYGigw1TY5%2Fimage.png?alt=media&amp;token=e9a1eb68-372b-498e-b854-e1a828546ba0" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://215762747-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fpbyr2izBTIBIhkjJJsUz%2Fuploads%2F4PJu95DQjyVGlwygtwIK%2Fimage.png?alt=media&amp;token=4efa82fc-61c1-46cc-8617-3e576126f5a7" alt=""><figcaption></figcaption></figure>

Color Options to override the primary colors for both Light and Dark mode.&#x20;