@medic/enketo-core
Advanced tools
Extensible Enketo core containing the form logic engine and responsive form styling
The engine that powers Enketo Smart Paper and various third party tools including these.
This repo is meant to use as a building block for any enketo-powered application.
Follow the Enketo blog or Enketo on twitter to stay up to date.
npm install enketo-core --save or include as a git submodule.media="print").
var Form = require('enketo-core');
// The XSL transformation result contains a HTML Form and XML instance.
// These can be obtained dynamically on the client, or at the server/
// In this example we assume the HTML was injected at the server and modelStr
// was injected as a global variable inside a <script> tag.
// required string of the jquery selector of the HTML Form DOM element
var formSelector = 'form.or:eq(0)';
// required object containing data for the form
var data = {
// required string of the default instance defined in the XForm
modelStr: globalXMLInstance,
// optional string of an existing instance to be edited
instanceStr: null,
// optional boolean whether this instance has ever been submitted before
submitted: false,
// optional array of external data objects containing:
// {id: 'someInstanceId', xmlStr: '<root>external instance content</root>'}
external: [],
// optional object of session properties
// 'deviceid', 'username', 'email', 'phonenumber', 'simserial', 'subscriberid'
session: {}
};
// form-specific configuration
var options = {
clearIrrelevantImmediately: true // this is the default, it can be omitted
}
// instantiate a form, with 2 parameters
var form = new Form( formSelector, data, options);
// initialize the form and capture any load errors
var loadErrors = form.init();
// submit button handler for validate button
$( '#submit' ).on( 'click', function() {
// clear irrelevant questions and validate
form.validate()
.then(function (valid){
if ( !valid ) {
alert( 'Form contains errors. Please see fields marked in red.' );
} else {
// Record is valid!
var record = form.getDataStr();
// reset the form view
form.resetView();
// reinstantiate a new form with the default model and no options
form = new Form( formSelector, { modelStr: modelStr }, {} );
// do what you want with the record
}
});
} );
The following browsers are officially supported:
We have to admit we do not test on all of these, but are committed to fixing browser-specific bugs that are reported for these browsers. Naturally, older browsers versions will often work as well - they are just not officially supported. Note that some applications using Enketo Core (e.g. Enketo Express) may have more limited browser support.
Global configuration (per app) is done in config.json which is meant to be overriden by a config file in your own application (e.g. by using aliasify).
The maps configuration can include an array of Mapbox TileJSON objects (or a subset of these with at least a name, tiles (array) and an attribution property, and optionally maxzoom and minzoom). You can also mix and match Google Maps layers. Below is an example of a mix of two map layers provided by OSM (in TileJSON format) and Google maps.
[ {
"name": "street",
"tiles": [ "http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png" ],
"attribution": "Map data © <a href=\"http://openstreetmap.org\">OpenStreetMap</a> contributors"
}, {
"name": "satellite",
"tiles": "GOOGLE_SATELLITE"
} ]
For GMaps layers you have the four options as tiles values: "GOOGLE_SATELLITE", "GOOGLE_ROADMAP", "GOOGLE_HYBRID", "GOOGLE_TERRAIN". You can also add other TileJSON properties, such as minZoom, maxZoom, id to all layers.
The Google API key that is used for geolocation (in the geo widgets' search box). Can be obtained here. Make sure to enable the GeoCoding API service. If you are using Google Maps layers, the same API key is used. Make sure to enable the Google Maps JavaScript API v3 service as well in that case (see next item).
This setting with the default false value determines whether Enketo should validate questions immediately if a related value changes. E.g. if question A has a constraint that depends on question B, this mode would re-validate question A if the value for question B changes. This mode will slow down form traversal. When set to false that type of validation is only done at the end when the Submit button is clicked or in Pages mode when the user clicks Next.
This setting with default true value determines whether the Next button should trigger validation of the current page and block the user from moving to the next page if validation fails.
Per-form configuration is done by adding an (optional) options object as 3rd parameter when instantiating a form.
new Form(formselector, data, {
clearIrrelevantImmediately: false
});
If clearIrrelevantImmediately is set to true or not set at all, Enketo will clear the value of a question as soon as it becomes irrelevant, after loading (so while the user traverses the form). If it is set to false Enketo will leave the values intact (and just hide the question).
In the second case the irrelevant values will not be cleared until form.validate() is called (usually when the user marks a record as complete).
npm installgruntgrunt developTo create new widgets, we recommend using this plugin template. The option {touch: [boolean]}, is added automatically to all widgets to indicate whether the client is using a touchscreen device.
Each widget needs to fulfill following requirements:
widget css class to any new elements it adds to the DOM (but not to their children)ignore classdestroy(element) to totally destroy widgets in repeat groups/questions when these groups/questions are cloned This may be an empty function if:
$.clone(true, true) of the widget (incl data and eventhandlers) works without problems (problems are likely!)enable() to enable the widget when a disabled ancestor gets enabled. This may be an empty function if that happens automatically.disable() This may be an empty function if the widgets gets disabled automatically cross-browser when its branch becomes irrelevant.update() to update the widget when called after the content used to instantiate it has changed (language or options). In its simplest form this could simply call destroy() and then re-initialize the widget, or be an empty function if language changes are handled automatically and it is not a <select> widget.this.namespace){ touch: [boolean] } is passed to the plugin by default. If your widget requires tweaks for mobile, you could create an all-in-one widget using the options.touch check or you could create separate widgets for desktop and mobile (as done with select-desktop and select-mobile widgets)fakefocus and fakeblur event to the original input when the widget gets focus or looses it (see select-desktop)grunt develop to automatically compile (sass and js) when a source file changes, serve, and refreshtouch=true and reducing the window size allows you to simulate mobile touchscreenstest task. You can also manually run grunt jsbeautifier:fix to fix style issues.grunt karma, headless: grunt karma:headless, browsers: grunt karma:browsers)The core can be fairly easily extended with alternative themes. See the plain, the grid, and the formhub themes already included in /src/sass. We would be happy to discuss whether your contribution should be a part of the core, the default theme or be turned into a new theme.
For custom themes that go beyond just changing colors and fonts, keep in mind all the different contexts for a theme:
The development of this app and enketo-core was sponsored by:
See change log
See graphs
See license document.
In addition, any product that uses enketo-core is required to have a "Powered by Enketo" footer, according to the specifications below, on all screens in which enketo-core or parts thereof, are used, unless explicity exempted from this requirement by Enketo LLC in writing. Partners and sponsors of the Enketo Project, listed on https://enketo.org/#about and on this page are exempted from this requirements and so are contributors listed in package.json.
The aim of this requirement is to force adopters to give something back to the Enketo project, by at least spreading the word and thereby encouraging further adoption.
Specifications:
Example:
Powered by 
FAQs
Extensible Enketo core containing the form logic engine and responsive form styling
The npm package @medic/enketo-core receives a total of 2 weekly downloads. As such, @medic/enketo-core popularity was classified as not popular.
We found that @medic/enketo-core demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.