JavaScript Frameworks
A list of all the Progressive Web Application frameworks supported by the Form.io platform.
At its core, the Form.io platform uses a plain JavaScript (aka Vanilla JavaScript) renderer to render the forms within an application. This renderer, as well as all documentation can be found on Github @ https://github.com/formio/formio.js. For the full documentation, please take a look at Form Renderer Documentation in the help guides.
This renderer is able to easily render a form using the following code within your application either via Script embedding or application embedding.
This allows the embedding of a form directly within an HTML application using the script tags within the header. The scripts and CSS that need to be included are as follows.
<link rel='stylesheet' href='https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css'>
<link rel='stylesheet' href='https://cdn.form.io/formiojs/formio.full.min.css'>
<script src='https://cdn.form.io/formiojs/formio.full.min.js'></script>
<div id='formio'></div>
<script type='text/javascript'>
Formio.createForm(
document.getElementById('formio'),
'https://examples.form.io/example'
);
</script>
The Form Builder can also be embedded using the following code.
<div id="builder"></div>
<script type="text/javascript">
Formio.builder(document.getElementById('builder'), {}, {});
</script>
The form renderer can also be embedded within an application by first including the formiojs renderer as an NPM dependency and then using the following code.
npm install formiojs
import { Formio } from 'formiojs';
Formio.createForm(document.getElementById('formio'), 'https://examples.form.io/example');
And the following CSS should also be included in your application SASS file.
@import "~formiojs/dist/formio.form.min.css";
For more documentation on the JavaScript renderer, please check out the following links.
The Angular framework is a very popular PWA framework offered by Google. The Form.io integration libraries provide a simple wrapper around the JavaScript renderer library, but expose a number of helper components and modules that enable rapid application development within the Angular framework.
To use this within your application, you will start by importing the dependencies via NPM.
npm install --save formiojs @formio/angular
Once the library is imported into your Angular application, you can render a form using the following code.
import { FormioModule } from '@formio/angular';
@NgModule({
imports: [
...,
FormioModule
],
...
})
export class AppModule { }
And then the following can be used within your templates to render a form.
<formio src='https://examples.form.io/example'></formio>
There are many other modules and helper components within the Angular library, so we recommend checking out the list of other documentation and examples at the following links.
The React is a popular JavaScript library for building PWA applications. It is maintained by Facebook. The Form.io integration libraries provide a simple wrapper around the JavaScript renderer library, but expose a number of helper components and modules that enable rapid application development within the React.
To use this within your application, you will start by importing the dependencies via NPM.
npm install --save formiojs @formio/react
Once the library is imported into your React application, you can render a form using the following code.
import React from 'react';
import { Form } from '@formio/react';
const App = () => (
<div className="container" id="main">
<Form src="https://examples.form.io/example" />
</div>
);
Form components provides a lot of helpful properties which allow you to configure your form. Here are the most common of them.
Property | Description | Value example |
src | An embed URL to load a form | |
form | Form JSON schema, can be used instead of the src | { type: 'form',
display: 'form', components: [...], } |
submission | Submission to set when the form is loaded | {
data: {...},
state: 'submitted',
} |
options | Form options | {
readOnly: true,
noAlerts: false,
saveDraft: false,
} |
formReady | A hook which will be called once the form instance is created and ready for use. Use this to take more control over the form. | (formInstance) => { formRef.current = formInstance;
} |
formioform | You can pass a custom Form class using this prop | |
on${formioEventKey} | Use this template to subscribe to any event exposed by formio. | |
If you need to take more control of the the wrapped formio Form instance (e.g, conditionally prepopulate it with some data, or control the behavior of few components inside the form), you can use formReady prop and save form instance using React Ref.
import React from 'react';
import { Form } from '@formio/react';
const App = () => {
const formRef = React.useRef(null);
const onFormReady = React.useCallback((form) => {
formRef.current = form;
}, []);
return (
<div className="container" id="main">
<Form src="https://examples.form.io/example" />
</div>
);
};
There are many other modules and helper components within the React library, so we recommend checking out the list of other documentation and examples at the following links.
To use this within your application, you will start by importing the dependencies via NPM.
npm install --save @formio/vue
Once the library is imported into your Vue application, you can render a form using the following code.
<template>
<formio :src="formUrl" @submit="onSubmitMethod" />
</template>
<script>
import { Form } from 'vue-formio';
export default {
data: function() {
// Load these from vuex or some other state store system.
return {
formUrl: "https://examples.form.io/example"
}
},
components: {
formio: Form
},
methods: {
onSubmitMethod: function(submission) {
console.log(submission);
}
}
};
</script>
Form components provides a lot of helpful properties which allow you to configure your form. Here are the most common of them.
Property | Description | Value example |
|---|---|---|
src | An embed URL to load a form | |
form | Form JSON schema, can be used instead of the src | { type: 'form',
display: 'form', components: [...], } |
submission | Submission to set when the form is loaded | {
data: {...},
state: 'submitted',
} |
options | Form options | {
readOnly: true,
noAlerts: false,
saveDraft: false,
} |
There are many other modules and helper components within the Vue library, so we recommend checking out the list of other documentation and examples at the following links.
This library is meant to be used in conjunction with Form.io to provide dynamic JSON form rendering capabilities. This allows you to render any form using the schemas provided by Form.io.
The following snippit of code will dynamically render the form within Form.io, as well as automatically hook that form up to the REST API generated from the same schema.
<formio src="'https://myapp.form.io/myform'"></formio>
There are several ways to add this library to your application. Each of these installation types are for specific use cases.
Full Installation
- Includes: Everything including Angular.js and jQuery.
- Usage: Use this installation if your application does not already have Angular and jQuery and you wish to display a single form on a page.
- Installation: Place the following within your application.
<link rel="stylesheet" href="https://rawgit.com/formio/ngFormio/master/dist/formio-full.min.css" />
<script src="https://rawgit.com/formio/ngFormio/master/dist/formio-full.min.js"></script>
Complete Installation
- Includes: Everything except Angular.js and jQuery
- Usage: Use this if you are embedding a form within an application that already has Angular.js and jQuery installed.
- Installation: Place the following within your application.
<link rel="stylesheet" href="https://rawgit.com/formio/ngFormio/master/dist/formio-complete.min.css" />
<script src="https://rawgit.com/formio/ngFormio/master/dist/formio-complete.min.js"></script>
Basic Installation: (Bower Installation)
- Includes: Only the ngFormio renderer library with no dependencies.
- Usage: When you wish to explicitely include all of the dependencies like when you are using Wiredep.
- Installation: We recommend using Wiredep for the Basic installation since it will wire up all the dependencies for you. You just need to place the following within your application.First install the dependency using Bower
bower install --save ng-formio
Then, you can add the following to your application.
<html>
<head>
<!-- bower:css -->
<!-- endbower -->
</head>
<body>
<!-- bower:js -->
<!-- endbower -->
</body>
</html>
Then run Wiredep to wire it up.
$ node
> require('wiredep')({ src: 'index.html' });
We also recommend using this within a Gulp build process using Wiredep in combination with Gulp UseRef.
Now that you have the library installed, you can then do the following to add a form to your application.
- Create a new project.
- Create a Form within your project. This will then give you an API url like the following.
https://myapp.form.io/myform. - You can then embed this form within your application by providing the following.
<formio src="'https://myapp.form.io/myform'"></formio>This not only renders the form dyanmically within your application, but also automatically hooks up that form to the API backend that is provided from Form.io.
To install this library into your application, you will need to run the following.
npm install formiojs @formio/angular @formio/angular-material
Then, you will need to add the following to your codebase.
import { MatFormioModule } from '@formio/angular-material';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
BrowserAnimationsModule,
MatFormioModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
This library can be used to render dynamic JSON powered forms within any Angular Material application. This uses the exact same syntax as the
<formio> component within the Angular Form.io Library. The only difference is that you will use the <mat-formio> directive instead.For example, the following will render a dynamic JSON form within your application.
<mat-formio src="https://examples.form.io/kitchensink"></mat-formio>
You can also use this to render JSON forms as follows.
<mat-formio [form]="{
components: [
{
type: 'textfield',
label: 'First Name',
key: 'firstName'
},
{
type: 'textfield',
label: 'Last Name',
key: 'lastName'
},
{
type: 'button',
action: 'submit',
label: 'Submit',
key: 'submit'
}
]
}" (submit)="onSubmit($event)"></mat-formio>
Last modified 8d ago