This module interfaces with the FieldList state to create a new state. The module will merge groups with fields into a central form summary that can be used by other modules to show the status of the form and the fields/groups that it consists of.
Example
var FormSummary = require('form-summary.js');
// a generic Viewer constructor
function Viewer(opts) {
var myFormSummary = FormSummary(this);
}
Fires:
Listens to Events:
-
module:event-store#event:StateModified for the "FieldList" state.
(require("form-summary"))(viewer)
Creates the form summary module.
Parameters:
Name | Type | Description |
---|---|---|
viewer |
Core |
The core viewer to which the module will attach. |
Methods
destroy()
Destroys the module.