Repository files navigation

FormKiQ Client SDK - JavaScript

Note: This Initial Version comes with CommonJS and ES6 versions

npm i formkiq-client-sdk-javascript

FormKiQ Client SDK should now be available as part of yournode_modules.

Note: while these instructions are for including this SDK in a script tag, you can also use the ES6 version for frameworks such as Angular and React JS: ./node_modules/formkiq-client-sdk-javascript/dist/formkiq-client-sdk-es6.js

<scripttype="text/javascript"src="./node_modules/formkiq-client-sdk-javascript/dist/web-cjs/formkiq-client-sdk-cjs.js"></script><scripttype="text/javascript">letformkiqClient;window.onload=()=>{// specify Host, Cognito User Pool Id, and Cognito Client IdformkiqClient=newFormkiqClient('<ID>.execute-api.<REGION>.amazonaws.com','{userPoolId}','{clientId}');// obviously this would not be hard-coded for non-public creds// NOTE: these public credentials for demo@formkiq.com are for read-only accessformkiqClient.login('{email}','{password}');// get current version of FormKiQformkiqClient.VersionApi.getVersion().then((response)=>{console.log(response);});}</script>

Example:Contact Form

Example (with attachments):Job Application Form

To add processing to any web form using FormKiQ, add the class "fkq-form" to your HTML FORM tag:

<formclass="fkq-form">

No action or onsubmit is required or desired, as FormKiQ Web Form Handler will automatically create the submission action.

A submit button is expected, to trigger the onsubmit event that the Web Form Handler uses to submit the form:

<inputtype="submit"value="Submit Your Fake Application"/>

NOTE: You can use any input type, includingtext inputs,passwords,checkboxes,radio buttons, orfile uploads.Selects (dropdowns, whether single value or multiple) andtextareas are also available for use by the Web Form Handler.

There are two callbacks included in the Web Form Handler:

• onFormSubmitted(formName)
• onFormCompleted(formName, response: {})

Any input fields that should be required should include a "required" HTML Attribute, and those will prevent the form from submitting. To create custom validation rules, you should submit the form manually usingonsubmit, and add extra validation in the triggered submit function.

You can submit the form manually usingformkiqClient.webFormsHandler.submitFormkiqForm(thisForm);