🥜
Peanut for Wordpress
  • Introducing Peanut for Wordpress!
  • Getting Started
    • Quickstart
    • Coding Examples
    • CLI Reference
  • Building Elements
    • Components
    • Blocks
    • Plugins
    • Themes
  • Configuration
    • JSON Configuration
    • Webpack
    • ESLint
    • Wordpress
  • Whiteboard
    • Tutorial
  • Framework
    • Javascript SDK
    • REST API
  • SWP Labs
    • About Us
    • Support Us
Powered by GitBook
On this page
  1. Whiteboard

Tutorial

PreviousWordpressNextJavascript SDK

Last updated 7 months ago

Whiteboard is a tool built for use with Peanut for Wordpress that creates a "playground" for quickly developing and testing your components. (i.e. like Storybook for React, except for Peanut)

Within the interface, you can update component arguments dynamically and immediately see the results of your changes.

As we continue to build out this tool, it is currently only available by running Peanut for Wordpress via the .

To enable the Whiteboard feature during development, run the CLI script in the root directory of the source code repo and add the "-w" flag to the "develop" command:

node ./cli.js develop -s path/to/peanut/elements/source/folder -d -w
node ./cli.js develop -s path/to/the/repo/peanut-examples -d -w

If you'd like a quick way to try it all out, download the from the repo link mentioned previously as well as our and use the following command syntax.

source code
"peanut-examples" elements repo
source code at the GitHub repository
Viewing a featured header component within Whiteboard tool.