# JavaScript Frameworks

## JavaScript

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**](https://github.com/formio/formio.js). For the full documentation, please take a look at [**Form Renderer Documentation**](https://help.form.io/developers/form-development/form-renderer) 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.

### Script 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.

{% hint style="info" %}
Navigate to the following link for more information about the [**Form.io CDNs**](https://help.form.io/faq/faq#what-are-the-form.io-cdns)
{% endhint %}

```markup
<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.

```markup
<div id="builder"></div>
<script type="text/javascript">
  Formio.builder(document.getElementById('builder'), {}, {});
</script>
```

### Application Embedding

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.

```markup
npm install formiojs
```

```javascript
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.

```javascript
@import "~formiojs/dist/formio.form.min.css";
```

For more documentation on the JavaScript renderer, please check out the following links.

* [Form.io Github Page](https://github.com/formio/formio.js)
* [Wiki Documentation](https://github.com/formio/formio.js/wiki)
* [Examples and Additional Documentation](https://formio.github.io/formio.js/)

## Angular

The [**Angular**](https://angular.io/) 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.

### Angular Renderer

{% embed url="<https://github.com/formio/angular>" %}

[**Compatibility Version Matrix** ](https://github.com/formio/angular?tab=readme-ov-file#angular-versions)

To use this within your application, you will start by importing the dependencies via NPM.

```javascript
npm install --save formiojs @formio/angular
```

Once the library is imported into your Angular application, you can render a form using the following code.

```javascript
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.

```javascript
<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.

### Angular Starter Application

{% embed url="<https://github.com/formio/angular-app-starterkit>" %}

### Angular Demo Application

{% embed url="<https://github.com/formio/angular-demo>" %}

### Angular Other Resources

* [**Angular Library Github Homepage**](https://github.com/formio/angular)
* [**Wiki Documentation**](https://github.com/formio/angular/wiki)
* [**Example/Starter Application**](https://formio.github.io/angular-demo/#/)
* [**Starter Application Source Code**](https://github.com/formio/angular-demo)
* [**Walkthrough Video (using Angular 5)**](https://www.youtube.com/watch?v=zEvzW_sSXk0)

## React

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 React.

### React Renderer

{% embed url="<https://github.com/formio/react>" %}

To use this within your application, you will start by importing the dependencies via NPM.

```javascript
npm install --save formiojs @formio/react
```

Once the library is imported into your React application, you can render a form using the following code.

```javascript
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 provide many helpful properties which allow you to configure your form. Here are the most common of them.<br>

If you need to take more control of the wrapped formio Form instance (e.g., conditionally prepopulate it with some data, or control the behavior of a few components inside the form), you can use formReady prop and save the form instance using React Ref.

```javascript
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.

### React Starter Application

{% embed url="<https://github.com/formio/react-app-starterkit>" %}

### React Components vs Form.io Components

React and Form.io both use the word "components" to refer to discreet modules of reusable code, but they are distinctly different and the difference must be understood.

In React, components are UI building blocks that render elements on the page, while in Form.io, components are data-driven form elements that power dynamic forms, workflows, and APIs.  Form.io components are not just the data field UI, they define data structures, validation, and API interactions, to create a fully integrated form and data management system.

### React Wrapper

Form.io provides a React wrapper that makes embedding forms in a React application completely seamless. Developers should not try to import custom React components directly into Form.io forms. Instead, use the React wrapper to integrate the rendered forms seamlessly alongside any other React component. This allows for tight integration with React’s state management, event handling, and styling, while still benefiting from the Form.io Platform's schema-driven approach.

#### Integrating forms with the React wrapper

Rather than treating the Form.io Platform as an isolated system, the React wrapper integrates a React app and the Form.io form engine.\
Forms may trigger React state updates, listen to events, and interact with other components in the app without breaking the schema-driven approach of Form.io

This ensures:

* **Separation of concerns:** Control of the broader application’s UI is handled entirely by React, while the the form’s behavior is handled entirely with the Form.io Platform.
* **Scalabilty:** The app remains scalable without needing to modify form components at the code level.
* **Flexibility:** The Form.io Platform's JSON-driven forms stay flexible and dynamic while still aligning with the application’s design system.

## Vue

The Form.io Vue renderer allows integration with the popular [**Vue.js framework**](https://vuejs.org/).

### Vue Renderer

{% embed url="<https://github.com/formio/vue>" %}

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 provide many 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                      | [**https://examples.form.io/example**](https://examples.form.io/example)                 |
| form       | Form JSON schema, can be used instead of the src | <p>{</p><p>  type: 'form',<br>  display: 'form',</p><p>  components: \[...],</p><p>}</p> |
| submission | Submission to set when the form is loaded        | <p>{<br>   data: {...},<br>   state: 'submitted',<br>}</p>                               |
| options    | Form options                                     | <p>{<br>  readOnly: true,<br>  noAlerts: false,<br>  saveDraft: false,<br>}</p>          |

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.

### Vue Starter Application

{% embed url="<https://github.com/formio/vue-app-starterkit>" %}

## Aurelia

The Form.io Aurelia renderer allows integration with the [**Aurelia Framework.**](https://aurelia.io/)

### Aurelia Renderer

{% embed url="<https://github.com/formio/aurelia-formio>" %}

### Aurelia Starter Application

{% embed url="<https://github.com/formio/aurelia-app-starterkit>" %}

## AngularJS

The AngularJS renderer is used to support the original [**Angular JS framework**](https://angularjs.org/).

### AngularJS Renderer

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.

{% embed url="<https://github.com/formio/ngFormio>" %}

The following snippet 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.

```javascript
<formio src="'https://myapp.form.io/myform'"></formio>
```

#### Installation

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**](https://github.com/taptapship/wiredep).
* **Installation:** We recommend using [**Wiredep**](https://github.com/taptapship/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**](http://gulpjs.com/) build process using Wiredep in combination with [**Gulp UseRef**](https://github.com/jonkemp/gulp-useref).

#### Usage

Now that you have the library installed, you can then do the following to add a form to your application.

* Create an account on [https://form.io](https://form.io/)
* 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 dynamically within your application, but also automatically hooks up that form to the API backend that is provided by Form.io.

### AngularJS Form Builder

{% embed url="<https://github.com/formio/ngFormBuilder>" %}

### AngularJS Helper Libraries

{% embed url="<https://github.com/formio/ngFormioHelper>" %}

### AngularJS Submission Grid

{% embed url="<https://github.com/formio/ngFormioGrid>" %}

### AngularJS Application Starterkit

{% embed url="<https://github.com/formio/ng-app-starterkit>" %}

## Angular Material

This library introduces the powerful Form.io JSON forms into the [**Angular Material framework**](https://material.angular.io/).

{% embed url="<https://github.com/formio/angular-material>" %}

#### Installation

To install this library into your application, you will need to run the following.

```javascript
npm install formiojs @formio/angular @formio/angular-material
```

Then, you will need to add the following to your codebase.

```javascript
import { MatFormioModule } from '@formio/angular-material';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    MatFormioModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }
```

#### Using this library

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**](https://github.com/formio/angular-formio). 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.

```javascript
<mat-formio src="https://examples.form.io/kitchensink"></mat-formio>
```

You can also use this to render JSON forms as follows.

```javascript
<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>
```