### Install Form.io CLI Source: https://help.form.io/dev/cli-tool.md Install the CLI globally using npm. ```bash npm install -g @formio/cli ``` -------------------------------- ### Install SDK via NPM Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Install the Form.io package using the terminal. ```bash npm install --save @formio/js ``` -------------------------------- ### Install Angular Framework Libraries Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration/angular-applications.md Install the framework-specific library for Angular integration. ```bash npm i --save @formio/angular ``` ```bash yarn add @formio/angular ``` -------------------------------- ### Install and Initialize Form.io via NPM Source: https://help.form.io/dev/javascript-development/frameworks.md Install the package and import it into your application code to initialize the renderer. ```bash npm install @formio/js ``` ```javascript import { Formio } from '@formio/js'; Formio.createForm(document.getElementById('formio'), 'https://forms.mysite.com/myproject/myform'); ``` -------------------------------- ### Install E-Sign+ module Source: https://help.form.io/dev/form.io-e-sign%2B.md Commands to install the @formio/esignature package using npm or yarn. ```bash npm i --save @formio/esignature ``` ```bash yarn add @formio/esignature ``` -------------------------------- ### Formio Submissions Examples Source: https://help.form.io/dev/cli-tool.md Examples for listing submissions and processing them through middleware. ```javascript // List all form submissions formio submissions --username user@example.com --password 12345 --key myApiKey https://forms.mysite.com/myproject/myform // middleware.js const middlewareFunc = (submission, index) => { // Do something with submission }; module.exports = middlewareFunc; // Pass every submission through middleware formio submissions --username user@example.com --password 12345 --key myApiKey https://forms.mysite.com/myproject/myform path/to/middleware.js ``` -------------------------------- ### Start Development Server Source: https://help.form.io/dev/application-development.md Launch the local development server to view the application. ```bash ng serve ``` -------------------------------- ### Install Form.io React dependencies Source: https://help.form.io/dev/frameworks.md Use NPM to install the core Form.io JavaScript library and the React wrapper. ```bash npm install --save @formio/js @formio/react ``` -------------------------------- ### Install Bootstrap Dependencies Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration/angular-applications.md Install the required Bootstrap and icon packages using npm or yarn. ```bash npm i --save bootstrap bootstrap-icons bootswatch ``` ```bash yarn add bootstrap bootstrap-icons bootswatch ``` -------------------------------- ### Initialize Angular Project Source: https://help.form.io/dev/application-development.md Install the Angular CLI and generate a new project with SCSS and routing enabled. ```bash npm install -g @angular/cli ng new eventmanager --style=scss --routing=true --strict=false ``` -------------------------------- ### Install Reporting Module Source: https://help.form.io/dev/form.io-reporting-module.md Commands to install the reporting module dependency via npm or yarn. ```bash npm install --save @formio/reporting ``` ```bash yarn add @formio/reporting ``` -------------------------------- ### Install Project Dependencies Source: https://help.form.io/dev/application-development.md Install required libraries including Bootstrap, Form.io, and Angular elements using npm or yarn. ```bash npm install --save bootstrap@4 bootstrap-icons formiojs @angular/elements ngx-bootstrap --legacy-peer-deps; npm install --save @formio/angular --tag=rc --legacy-peer-deps ``` ```bash yarn add bootstrap@4 bootstrap-icons @formio/js @angular/elements ngx-bootstrap; yarn add @formio/angular@rc ``` -------------------------------- ### Install Form.io Angular dependencies Source: https://help.form.io/dev/frameworks.md Use NPM to install the core JavaScript renderer and the Angular wrapper library. ```bash npm install --save @formio/js @formio/angular ``` -------------------------------- ### Start Admin Portal Source: https://help.form.io/dev/integrations/file-storage.md Executes the admin command within the running SeaweedFS container. ```bash docker exec -it local-seaweedfs-1 /usr/bin/weed admin ``` -------------------------------- ### Advanced Condition Context Examples Source: https://help.form.io/dev/form-development/form-evaluations.md Examples of using 'show' and 'value' variables to control component visibility and evaluation state. ```javascript show = value === 'Testing'; ``` ```javascript show = value === 5; ``` -------------------------------- ### Install Form.io Vue dependencies Source: https://help.form.io/dev/frameworks.md Use NPM to install the required Form.io JavaScript and Vue wrapper packages. ```bash npm install --save @formio/js @formio/vue ``` -------------------------------- ### Complete HTML Integration Example Source: https://help.form.io/dev/form-renderer.md A full HTML document including the form container and the Form.io renderer script. ```markup
``` -------------------------------- ### Install the Standard Template package Source: https://help.form.io/dev/form-templates/the-form.io-standard-template.md Use npm to add the standard template library to your project dependencies. ```bash npm install @formio/standard-template ``` -------------------------------- ### Install Required Peer Dependencies Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration/react-applications.md Command to install the necessary peer dependencies for the enterprise module. ```bash npm install @formio/react @formio/js ``` -------------------------------- ### Install Enterprise Form Builder Dependencies Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration/angular-applications.md Install the core Form.io libraries required for the enterprise builder module. ```bash npm i --save @formio/js @formio/premium @formio/enterprise-builder ``` ```bash yarn add @formio/js @formio/premium @formio/enterprise-builder ``` -------------------------------- ### Email Template Example Source: https://help.form.io/dev/authentication-and-authorization/email-authentication.md An example of an email message containing the token placeholder for registration completion. ```text To: john@example.com From: no-reply@form.io Subject: Register Now Message: Click here to complete your registration http://myapp.com/?token=[[token(data.email=customer)]]#register ``` ```text To: john@example.com From: no-reply@form.io Subject: Register Now Message: Click here to complete your registration http://myapp.com/?token=lkjsdlkjs90980982l3kjlkjslkjsd....#register ``` -------------------------------- ### Install the Form.io Claude Code Plugin Source: https://help.form.io/dev/ai/agentic-coding-toolset.md Command to install the Form.io plugin within the Claude Code environment. ```bash /plugin install formio-ai@formio ``` -------------------------------- ### Install Enterprise Form Builder Package Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration/react-applications.md Command to install the core enterprise form builder package for React. ```bash npm install @formio/enterprise-form-builder-react ``` -------------------------------- ### Custom Validation Context Examples Source: https://help.form.io/dev/form-development/form-evaluations.md Examples of using the 'input' and 'valid' variables to perform component validation. ```javascript valid = input === 5; ``` ```javascript valid = input === 5 ? true : 'The value must be 5!'; ``` ```javascript valid = input === data.password ? true : 'Passwords must match!'; ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://help.form.io/dev/modules.md Perform an HTTP GET request to the documentation URL to retrieve answers and excerpts based on a specific question and goal. ```http GET https://help.form.io/dev/modules.md?ask=&goal= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://help.form.io/dev/javascript-development/frameworks.md Perform an HTTP GET request to the current page URL with query parameters to retrieve specific information or context. ```http GET https://help.form.io/dev/javascript-development/frameworks.md?ask=&goal= ``` -------------------------------- ### Install Form.io NPM Dependency Source: https://help.form.io/dev/frameworks.md Install the core library via NPM for use in modern JavaScript applications. ```bash npm install @formio/js ``` -------------------------------- ### GET /dev/application-development.md Source: https://help.form.io/dev/application-development.md Queries the documentation dynamically by providing a specific question and an optional end goal. ```APIDOC ## GET /dev/application-development.md ### Description Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a natural language question. ### Method GET ### Endpoint https://help.form.io/dev/application-development.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the response context. ``` -------------------------------- ### CSV Import Data Structure Source: https://help.form.io/dev/cli-tool.md Example CSV file format for data migration. ```csv First Name, Last Name, Email Joe, Smith, joe@example.com Jane, Thompson, jane@example.com Terry, Jones, terry@example.com ``` -------------------------------- ### GET https://help.form.io/readme.md Source: https://help.form.io/dev Perform a query against the documentation index to receive a direct answer, relevant excerpts, and sources. ```APIDOC ## GET https://help.form.io/readme.md ### Description Perform an HTTP GET request on the documentation index to retrieve answers to specific questions based on the documentation corpus. ### Method GET ### Endpoint https://help.form.io/readme.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### Verify Audience URI Format Source: https://help.form.io/dev/authentication-and-authorization/saml.md Example format for the Audience URI that must match the Form.io application URL. ```arduino http://myapplicationdomain.com ``` -------------------------------- ### Verify and Reinstall Reporting Module Source: https://help.form.io/dev/form.io-reporting-module.md Use these commands to check if the @formio/reporting package is installed and to reinstall it if the module is not found. ```bash # Verify installation npm list @formio/reporting # Reinstall if needed npm install --save @formio/reporting ``` -------------------------------- ### Instantiate Formio Project SDK Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Initialize the Formio SDK by providing the project URL to the constructor. ```javascript const formio = new Formio('https://forms.mysite.com/myproject') ``` -------------------------------- ### Query Documentation via HTTP Source: https://help.form.io/dev/fetch-plugin-api.md Performs a GET request to the documentation API to retrieve information dynamically. ```http GET https://help.form.io/dev/fetch-plugin-api.md?ask=&goal= ``` -------------------------------- ### Initialize Form with Options Source: https://help.form.io/dev/form-renderer.md The standard method signature for creating a form instance with custom options. ```javascript Formio.createForm(element, src|form, options) ``` -------------------------------- ### Install ngx-toastr dependency Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration/angular-applications.md Commands to install the ngx-toastr package using npm or yarn. ```bash npm i --save ngx-toastr ``` ```bash yarn add ngx-toastr ``` -------------------------------- ### Define a custom component class Source: https://help.form.io/dev/custom-components.md Example of extending the base Input component and implementing core lifecycle and configuration methods. ```javascript const Input = Formio.Components.components.input; class MyComponent extends Input { /** * This is the default schema of your custom component. It will "derive" * from the base class "schema" and extend it with its default JSON schema * properties. The most important are "type" which will be your component * type when defining new components. * * @param extend - This allows classes deriving from this component to * override the schema of the overridden class. */ static schema(...extend) { return Input.schema({ type: 'mycomp', label: 'My Component', key: 'mycomp', }); } /** * This is the Form Builder information on how this component should show * up within the form builder. The "title" is the label that will be given * to the button to drag-and-drop on the buidler. The "icon" is the font awesome * icon that will show next to it, the "group" is the component group where * this component will show up, and the weight is the position within that * group where it will be shown. The "schema" field is used as the default * JSON schema of the component when it is dragged onto the form. */ static get builderInfo() { return { title: 'My Component', icon: 'terminal', group: 'basic', documentation: '/userguide/#textfield', weight: 0, schema: MyComponent.schema() }; } /** * Called when the component has been instantiated. This is useful to define * default instance variable values. * * @param component - The JSON representation of the component created. * @param options - The global options for the renderer * @param data - The contextual data object (model) used for this component. */ constructor(component, options, data) { super(component, options, data); } /** * Called immediately after the component has been instantiated to initialize * the component. */ init() { super.init(); } /** * For Input based components, this returns the attributes that should * be added to the input elements of the component. This is useful if you wish * to alter the "name" and "class" attributes on the elements created * within this component. * * @return - A JSON object that is the attribute information to be added to the * input element of a component. */ get inputInfo() { const info = super.inputInfo; return info; } /** * This method is used to render a component as an HTML string. This method uses * the template system (see Form Templates documentation) to take a template * and then render this as an HTML string. * * @param content - Important for nested components that receive the "contents" * of their children as an HTML string that should be injected * in the {{ content }} token of the template. * * @return - An HTML string of this component. */ render(content) { return super.render('
This is a custom component!
'); } /** * The attach method is called after "render" which takes the rendered contents * from the render method (which are by this point already added to the DOM), and * then "attach" this component logic to that html. This is where you would load * any references within your templates (which use the "ref" attribute) to assign * them to the "this.refs" component variable (see comment below). * * @param - The parent DOM HtmlElement that contains the component template. * * @return - A Promise that will resolve when the component has completed the * attach phase. */ attach(element) { /** * This method will look for an element that has the 'ref="customRef"' as an * attribute (like
) and then assign that DOM * element to the variable "this.refs". After this method is executed, the * following will point to the DOM element of that reference. * * this.refs.customRef * * For DOM elements that have multiple in the component, you would make this * say 'customRef: "multiple"' which would then turn "this.refs.customRef" into ``` -------------------------------- ### Install Offline Plugin Source: https://help.form.io/dev/offline-mode.md Command to install the required offline plugin package via NPM. ```bash npm install @formio/offline-plugin ``` -------------------------------- ### Formio.ssoInit([type], [options]) Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Initializes an SSO process, such as SAML or Okta. ```APIDOC ## Formio.ssoInit([type], [options]) ### Description Initializes an SSO processes. This is used during SAML authentication processes to instantiate and continue a SAML SSO process. ### Parameters - **type** (string) - The type of SAML sso authentication to instantiate. Either "saml" or "okta". - **options** (object) - An object of options, which depends on the type. ``` -------------------------------- ### Navigate to Project Directory Source: https://help.form.io/dev/application-development.md Change the current working directory to the newly created project folder. ```bash cd eventmanager ``` -------------------------------- ### GET / (Documentation Query) Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration/react-applications.md Performs a dynamic query against the current documentation page to retrieve answers and relevant excerpts. ```APIDOC ## GET [URL]?ask=&goal= ### Description Performs an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page. ### Method GET ### Endpoint [Current Page URL] ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - Describes the broader end goal to help tailor the response. ``` -------------------------------- ### Install and Use Protected Evaluator Source: https://help.form.io/dev/form-development/form-evaluations.md Install and apply the protected-eval library to secure form evaluations. ```bash npm install --save @formio/protected-eval ``` ```javascript import ProtectedEval from '@formio/protected-eval'; import { Formio } from '@formio/js'; Formio.use(ProtectedEval); ``` -------------------------------- ### Instantiate Formio with Form Scope Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Initializes the SDK with a specific form path. ```javascript const formio = new Formio('https://forms.mysite.com/myproject/myform'); ``` -------------------------------- ### Install Protected Evaluator via NPM Source: https://help.form.io/dev/form-development/form-evaluations/protected-evaluator.md Command to install the protected evaluation module into your project. ```bash npm install --save @formio/protected-eval ``` -------------------------------- ### Logic Trigger Examples Source: https://help.form.io/dev/form-development/form-evaluations.md Examples of using the 'result' variable to determine if a logic section should be triggered. ```javascript result = data.email === 'admin@form.io'; ``` ```javascript var total = data.grades.reduce((total, grade) => total + grade, 0); var average = total / data.grades.length; result = average < 70.0; ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://help.form.io/dev/authentication-and-authorization/oauth.md Use this request format to ask specific questions and provide context for the desired end goal. ```http GET https://help.form.io/dev/authentication-and-authorization/oauth.md?ask=&goal= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://help.form.io/dev/authentication-and-authorization/resource-based-authentication.md Use this request format to ask specific questions about resource-based authentication and provide context via the goal parameter. ```http GET https://help.form.io/dev/authentication-and-authorization/resource-based-authentication.md?ask=&goal= ``` -------------------------------- ### Configure Application Styles Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration/angular-applications.md Import Bootstrap, Bootswatch themes, and Form.io styles into the global styles file. ```scss @import "bootstrap/scss/bootstrap.scss"; @import "bootswatch/dist/cosmo/variables"; @import "bootswatch/dist/cosmo/bootstrap"; @import "@formio/js/dist/formio.full.css"; @import "bootstrap-icons/font/bootstrap-icons.scss"; ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://help.form.io/dev/accessibility.md Use this request format to query the documentation dynamically by providing an 'ask' parameter for the question and an optional 'goal' parameter. ```http GET https://help.form.io/dev/accessibility.md?ask=&goal= ``` -------------------------------- ### Set Form.io License Key Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration/angular-applications.md Initialize the library by setting the license key in your application code. ```javascript import { Formio } from '@formio/angular'; Formio.license = 'yourLibraryLicenseKey'; ``` -------------------------------- ### Deploy a Form.io project Source: https://help.form.io/dev/cli-tool.md Deploys a project from a source to a destination server. Authentication is required for both servers. ```bash formio deploy [src] [dst] ``` ```bash // A project without a server is implied from https://form.io formio deploy myproject http://myproject.localhost:3000 // Projects can be specified with a subdomain. formio deploy https://myproject.form.io http://myproject.localhost:3000 // Projects can also be referred to with their project id which will need to be looked up. formio deploy https://form.io/project/{projectId} http://localhost:3000/project/{projectId} ``` -------------------------------- ### Initialize Formio Instance Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Create a new Formio instance by providing the API endpoint and optional configuration object. ```javascript const formio = new Formio(, [options]); ``` -------------------------------- ### formio.loadProject([query], [opts]) Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Loads the project configuration using the Project Load API. ```APIDOC ## formio.loadProject([query], [opts]) ### Description Loads the project using the Project Load API. ### Parameters - **query** (object) - Optional - Query options for the request. - **opts** (object) - Optional - Fetch options for the request. ``` -------------------------------- ### attachWebform(element, instance) Source: https://help.form.io/dev/form-renderer.md Called once the webform has started its attach phase. ```APIDOC ## attachWebform(element, instance) ### Description Called once the webform has started its attach phase. The method should return the element or another DOM element used to attach the webform. ### Parameters - **element** (DOMElement) - The DOM element that the webform is attaching to. - **instance** (object) - The webform instance object. ``` -------------------------------- ### Initialize Form via NPM Source: https://help.form.io/dev/frameworks.md Import the Formio class and initialize a form within your application logic. ```javascript import { Formio } from '@formio/js'; Formio.createForm(document.getElementById('formio'), 'https://forms.mysite.com/myproject/myform'); ``` -------------------------------- ### Get Form ID Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Retrieves the unique form ID from the current context. ```javascript const formio = new Formio('https://forms.mysite.com/myproject/myform'); formio.getFormId().then((formId) => { // Prints the form id for "myform" console.log(formId); }); ``` -------------------------------- ### plugin.dequeueSubmissions(skipError, fromIndex, forceDequeue, predicate) Source: https://help.form.io/dev/offline-mode.md Starts to process the submission queue. ```APIDOC ## plugin.dequeueSubmissions(skipError, fromIndex, forceDequeue, predicate) ### Description Starts to process the submission queue. All requests in the offline submission queue will be sent in the order they were made. ### Parameters - **skipError** (boolean) - Required - Whether to skip errors. - **fromIndex** (number) - Required - The index to start processing from. - **forceDequeue** (boolean) - Required - Whether to force the dequeue process. - **predicate** (any) - Required - A predicate function to filter submissions. ``` -------------------------------- ### Check library readiness with Formio.libraryReady Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Returns a promise that resolves when a previously required library is ready for use. ```javascript Formio.libraryReady('lodash').then((_) => { // Lodash is now ready! console.log(_); }); ``` -------------------------------- ### Formio.loadProjects([query], [opts]) Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Loads all projects within the configured baseUrl of the SDK. ```APIDOC ## Formio.loadProjects([query], [opts]) ### Description A static method to load all projects within the configured baseUrl of the SDK. ### Parameters - **query** (object) - Optional query options. - **opts** (object) - Optional fetch options. ``` -------------------------------- ### Define Submission JSON Source: https://help.form.io/dev/form-renderer.md Example of submission data corresponding to the standard form structure. ```javascript { "data": { "firstName": "Joe", "lastName": "Smith" } } ``` -------------------------------- ### Querying Documentation via HTTP GET Source: https://help.form.io/dev/accessibility/about-accessibility-and-webforms.md Use this request to ask specific questions about the documentation dynamically by appending query parameters to the page URL. ```http GET https://help.form.io/dev/accessibility/about-accessibility-and-webforms.md?ask=&goal= ``` -------------------------------- ### Validate input with JSON Logic Source: https://help.form.io/dev/form-development/form-evaluations.md Examples of using the if operator for custom validation logic. ```json { "if": [ { "===": [ { "var": "input" }, "Bob" ] }, true, "Your name must be 'Bob'!" ] } ``` ```json { "if": [ { "in": [ { "var": "input" }, "form.io" ] }, true, "The email must be from 'form.io'!" ] } ``` -------------------------------- ### Evaluate Component Value Source: https://help.form.io/dev/form-development/form-evaluations.md Example of conditional logic based on the current component value. ```javascript show = value === 5; ``` -------------------------------- ### Load Project Forms Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Instantiate the Formio client with a project URL and retrieve a list of forms. ```javascript const formio = new Formio('https://forms.mysite.com/myproject'); formio.loadForms().then((forms) => { console.log(forms); }); ``` -------------------------------- ### Access Registration URL Source: https://help.form.io/dev/application-development.md Example URL structure to access registrations for a specific event. ```text http://localhost:4200/event/[EVENTID]/registrations ``` -------------------------------- ### Initialize SAML SSO Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Instantiates a SAML SSO process for configured projects. ```javascript Formio.ssoInit('saml') ``` -------------------------------- ### Configure CSS Framework Templates Source: https://help.form.io/dev/form-templates.md Use Formio.use to apply a specific CSS framework template globally. ```js import { Formio } from '@formio/js'; import { bootstrap4 } from '@formio/bootstrap'; // use the Bootstrap 4-based template instead of the default Formio.use(bootstrap4); ``` ```javascript import { Formio } from '@formio/js'; import uswds from '@formio/uswds'; // use the USWDS-based template instead of the default Formio.use(uswds); ``` -------------------------------- ### Get PDF Download URL Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Retrieve a temporary URL for downloading a submission as a PDF. ```javascript const formio = new Formio('https://forms.mysite.com/myproject/myform/submission/234234234234234'); formio.getDownloadUrl().then((url) => { // This will print the PDF download url, which also includes the temp token. console.log(url); }); ``` -------------------------------- ### Querying Documentation via HTTP GET Source: https://help.form.io/dev/form-embedding.md Use this request format to ask specific questions about the documentation and retrieve relevant excerpts. ```http GET https://help.form.io/dev/form-embedding.md?ask=&goal= ``` -------------------------------- ### GET /enterprise-form-builder-module/application-integration/react-applications/react-component-reference.md Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration/react-applications/react-component-reference.md Queries the documentation page for specific information using natural language. ```APIDOC ## GET /enterprise-form-builder-module/application-integration/react-applications/react-component-reference.md ### Description Queries the current documentation page to retrieve answers, excerpts, and sources based on a provided question. ### Method GET ### Endpoint https://help.form.io/dev/enterprise-form-builder-module/application-integration/react-applications/react-component-reference.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### Initialize the Standard Template module Source: https://help.form.io/dev/form-templates/the-form.io-standard-template.md Register the template with Formio using the standardTemplate function and a configuration object. ```javascript import { Formio } from '@formio/js'; import { standardTemplate, BOOTSTRAP_EXAMPLE } from '@formio/standard-template'; Formio.use(standardTemplate(BOOTSTRAP_EXAMPLE)); Formio.createForm(document.getElementById('formio'), 'https://forms.mysite.com/myproject/myform'); ``` -------------------------------- ### GET /dev/enterprise-form-builder-module/application-integration.md Source: https://help.form.io/dev/enterprise-form-builder-module/application-integration.md Queries the documentation for specific information by providing a question and an optional goal. ```APIDOC ## GET /dev/enterprise-form-builder-module/application-integration.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically. This allows for retrieving information not explicitly present in the page or clarifying existing content. ### Method GET ### Endpoint https://help.form.io/dev/enterprise-form-builder-module/application-integration.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - Describes the broader end goal to help tailor the answer. ``` -------------------------------- ### Formio.libraryReady(name) Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Returns a promise that resolves once a previously required library is ready for use. ```APIDOC ## Formio.libraryReady(name) ### Description Returns a promise that will resolve once the library of the provided name is ready to be used. ### Parameters - **name** (string) - The name of the library to check. ### Example ```javascript Formio.libraryReady('lodash').then((_) => { console.log(_); }); ``` ``` -------------------------------- ### Render forms in React Source: https://help.form.io/dev/frameworks.md Example showing the use of FormioProvider and the Form component to load and display forms based on user context. ```javascript import { createRoot } from 'react-dom/client'; import { useEffect, useState } from 'react'; import { useFormioContext, FormioProvider, FormType, Form, } from '@formio/react'; const FormsByUser = ({ userId }: { userId: string }) => { const { Formio, projectUrl } = useFormioContext(); const [forms, setForms] = useState([]); useEffect(() => { const fetchForms = async () => { const formio = new Formio(projectUrl); try { const forms = await formio.loadForms({ params: { type: 'form', owner: userId }, }); setForms(forms); } catch (err) { console.log( `Error while loading forms for user ${userId}:`, err, ); } }; fetchForms(); }, [Formio, projectUrl, userId]); return forms.map(function (form) { return ( <>
); }); }; const domNode = document.getElementById('root'); const root = createRoot(domNode); const root = createRoot(); root.render( , ); ``` -------------------------------- ### Custom template interpolation syntax Source: https://help.form.io/dev/form-development/form-evaluations.md Example of an alternative template syntax using angle brackets. ```text Your first name: <% data.firstName %> ``` -------------------------------- ### Custom Tooltip Template Source: https://help.form.io/dev/form.io-e-sign%2B.md Example structure for a custom e-signature tooltip containing signature metadata. ```html
eSignature {{esign.valid !== true ? 'invalid' : 'verified'}}
  • ID:<{{esign?._id || '-'}}
  • Path:{{esign?.signature?.valuePath || '-'}}
``` -------------------------------- ### GET /javascript-development/javascript-sdk.md Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Queries the documentation for specific information by providing a question and an optional end goal. ```APIDOC ## GET /javascript-development/javascript-sdk.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically. ### Method GET ### Endpoint https://help.form.io/dev/javascript-development/javascript-sdk.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### Get Current User Metadata Source: https://help.form.io/dev/javascript-development/javascript-sdk.md Retrieves user information based on the JWT stored in localStorage. ```javascript formio.currentUser().then((user) => { // The current user. console.log(user); }); ``` -------------------------------- ### Deploy SeaweedFS Container Source: https://help.form.io/dev/integrations/file-storage.md Starts the SeaweedFS container with S3 support enabled. Ensure the AWS credentials are updated from the default 'CHANGEME' values. ```bash docker run -itd \ -e "AWS_ACCESS_KEY_ID=CHANGEME" \ -e "AWS_SECRET_ACCESS_KEY=CHANGEME" \ --name formio-seaweedfs \ --restart unless-stopped \ -p 8333:8333 \ -p 23646:23646 \ -v ~/seaweedfs/data:/data \ chrislusf/seaweedfs server -s3 ``` -------------------------------- ### GET /authentication-and-authorization/oauth.md Source: https://help.form.io/dev/authentication-and-authorization/oauth.md Queries the documentation dynamically by providing a specific question and an optional end goal. ```APIDOC ## GET /authentication-and-authorization/oauth.md ### Description Perform a dynamic query against the documentation to retrieve answers, excerpts, or sources related to a specific question. ### Method GET ### Endpoint https://help.form.io/dev/authentication-and-authorization/oauth.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### GET /enterprise-form-builder-module/using-enterprise-form-builder.md Source: https://help.form.io/dev/enterprise-form-builder-module/using-enterprise-form-builder.md Performs a dynamic query against the documentation page to retrieve answers and relevant excerpts. ```APIDOC ## GET /enterprise-form-builder-module/using-enterprise-form-builder.md ### Description Performs a dynamic query on the current documentation page to retrieve a direct answer and relevant excerpts based on a provided question. ### Method GET ### Endpoint https://help.form.io/dev/enterprise-form-builder-module/using-enterprise-form-builder.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - Describes the broader end goal to help tailor the response. ```