To help you get started, we've collected the most common ways that enketo-core is being used within popular public projects.

kobotoolbox / enketo-express / public / js / src / module / controller-webform.js View on Github

.then( record => {
            if ( !data.instanceStr && record && record.xml ) {
                records.setActive( records.getAutoSavedKey() );
                data.instanceStr = record.xml;
            }

            if ( data.instanceAttachments ) {
                fileManager.setInstanceAttachments( data.instanceAttachments );
            }

            form = new Form( formSelector, data, formOptions );
            loadErrors = form.init();

            // Remove loader. This will make the form visible.
            // In order to aggregate regular loadErrors and GoTo loaderrors,
            // this is placed in between form.init() and form.goTo().
            $( '.main-loader' ).remove();

            if ( settings.goTo && location.hash ) {
                console.log( 'going to ', location.hash.substring( 1 ) );
                loadErrors = loadErrors.concat( form.goTo( location.hash.substring( 1 ) ) );
            }

            if ( form.encryptionKey && !encryptor.isSupported() ) {
                loadErrors.unshift( t( 'error.encryptionnotsupported' ) );
            }

View more ways to use enketo-core

Enketo Core

The engine that powers Enketo Express and various third party tools including this selection.

Enketo's form engine is compatible with tools in the ODK ecosystem and complies with its XForms specification though not all features in that specification have been implemented yet.

This repo is meant to be used as a building block for any Enketo-powered application. See this page for a schematic overview of a real-life full-fledged data collection application and how Enketo Core fits into this.

Browser support

The following browsers are officially supported:

• latest Android webview on latest Android OS
• latest WKWebView on latest iOS
• latest version of Chrome/Chromium on Mac OS, Linux, Windows, Android and iOS
• latest version of Firefox on Mac OS, Windows, Linux, Android and iOS
• latest version of Safari on Mac OS, Windows, and on the latest version of iOS
• latest version of Microsoft Edge

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.

Performance (live)

See graphs

Usage as a library

1. Install with npm install enketo-core --save or include as a git submodule.
2. Develop a way to perform an XSL Transformation on OpenRosa-flavoured XForms inside your app. The transformation will output an XML instance and a HTML form. See enketo-transformer for an available library/app to use or develop your own.
3. Add themes to your stylesheet build system (2 stylesheets per theme, 1 is for media="print").
4. Override the files under "browser", e.g. using aliasify with your app-specific versions.
5. Main methods illustrated in code below:

// assumes the enketo-core package is mapped from the node_modules folder
import { Form } from '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