Module: fill-progress

Shows the progress of how many fields have been filled and how many are remaining. If there are required fields, a progress bar indicates the progress of required fields that have been filled. If there are optional fields, text below the progress bar indicates how many optional fields are left.

(require("fill-progress"))(viewer, options)

Creates the fill progress UI module.

Parameters:

Name Type Description

viewer

Core

The core viewer to which the module will attach.

options

Object

An options object.

Properties

Name	Type	Description
`elem`	HTMLElement	The element in which the module UI will be inserted.

Listens to Events:

module:event-store#event:StateModified for "FieldList" state.

Example

var FillProgress = require('fill-progress.js');

// a generic Viewer constructor
function Viewer(opts) {
    var myFillProgress = FillProgress(this, {
        elem: document.getElementById('myFillProgress')
    });
}

Methods

destroy()

Destroys the module.