Home

Materia Widget Development Kit

The MWDK is designed to allow widgets to be developed independent of the Materia platform, with live reloading and a handful of additional features to facilitate faster development. Additional documentation related to Materia itself is available on the Materia repo.

Installation

MWDK must be listed under the dependencies section of your widget's package.json:

"dependencies": {
    "materia-widget-development-kit": "3.0.0"
  }

Note that this is a required dependency of all Materia widgets.

NPM vs Yarn

While both may work, we do not maintain a NPM lockfile (package-lock.json or npm-shrinkwrap.json`) in the repo. Therefore, we recommend using yarn.

Starting your widget

Run yarn start in the widget's root directory. The widget will be available at localhost:8118.

Installing to Materia

Use the Download Package option on either the Player or Creator page to either download a compiled .wigt file locally (it's just a .zip file, but renamed) or install directly to your local instance of Materia. This requires a currently running local instance of Materia in Docker.

Widget Authoring

Visit the Developing Materia Widgets section of our docs site for comprehensive documentation related to authoring a widget.

Updating from MWDK versions < 3.0

Visit our page detailing the changes required to implement MWDK v3.x in your widget.