Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

We recommend familiarising yourself with how the Forms CLI works before writing your own plugin.

What is a Forms CLI Plug-in?

The Forms CLI uses a plug-in to turn a JSON definition of a Blink form into source code for a specific framework. It deals only with forms and their functionality, however you could write a plug-in pack that could build an entire project. 

Plugin API

A plug-in consists of an entry point that exposes four functions that are called at various points by the Forms CLI. The Forms CLI must expose an object of the following structure:

...

It is recommended to use the template-helper module, which provides functions to load templates from a folder, create "primed" mustache templates and a lazyWriter function that is used by the AngularJS plug-in as the return value of processForm.

For a full implementation example, see the AngularJS or JSON plug-ins.

...