\n```\n\n\n### Date Question\n\n#### JSON\n\n\n```json\n{\n \"type\": \"date\",\n \"title\": \"What is your birthdate?\",\n \"description\": \"This is required to determine eligibility.\",\n \"required\": true,\n \"read_only\": false\n}\n```\n\n\n#### HTML\n\n\n```html\n
\n \n Please provide the name given on your birth certificate.\n
\n
\n
\n \n \n
\n
\n \n \n
\n
\n \n \n
\n
\n \n \n
\n
\n \n \n
\n
\n
\n
\n```\n\n\n### Phone Question\n\n#### JSON\n\n\n```json\n{\n \"type\": \"phone\",\n \"title\": \"Home Phone\",\n \"description\": \"This will be used in case of any emergencies.\",\n \"required\": true,\n \"read_only\": false,\n \"show_extension\": true,\n \"intl\": false\n}\n```\n\n\n#### HTML\n\n\n```html\n
\n \n This will be used in case of any emergencies.\n
\n
\n
\n \n
\n
\n \n
\n \n
\n
\n
\n
\n
\n```\n\n\n### Radio Question\n\n#### JSON\n\n\n```json\n{\n \"type\": \"radio\",\n \"title\": \"Have you participated in this program before?\",\n \"description\": \"\",\n \"required\": false,\n \"read_only\": false,\n \"default_value\": null,\n \"possible_answers\": [{\n \"id\": \"childcare_possible_answer-103473\",\n \"value\": \"Yes\",\n \"display_value\": \"Yes\"\n },\n {\n \"id\": \"childcare_possible_answer-103474\",\n \"value\": \"No\",\n \"display_value\": \"No\"\n }\n ],\n \"hide_empty_option\": false,\n \"empty_value\": \"\"\n}\n```\n\n\n#### HTML\n\n\n```html\n
\n \n \n
\n
\n \n \n
\n
\n
\n```\n\n\n### Text Question\n\n#### JSON\n\n\n```json\n{\n \"type\": \"text\",\n \"title\": \"Please specify any food allergies\",\n \"description\": \"For example, peanuts, dairy, eggs, gluten, wheat, etc.\",\n \"required\": false,\n \"read_only\": false,\n \"max_length\": 50\n}\n```\n\n\n#### HTML\n\n\n```html\n
\n \n For example, peanuts, dairy, eggs, gluten, wheat, etc.\n
\n\n\n\n## DxpQuestions\n**Kind**: global class \n\n* [DxpQuestions](#dxpquestions)\n * [new DxpQuestions()](#new_DxpQuestions_new)\n * _instance_\n * [.render()](#DxpQuestions+render)\n * [.requestSubmit()](#DxpQuestions+requestSubmit)\n * [.setAnswers()](#DxpQuestions+setAnswers)\n * _static_\n * [.init(params)](#DxpQuestions.init) ⇒ Object\n\n\n\n### new DxpQuestions()\nDxpQuestions class\n\n\n\n### dxpQuestions.render()\nRenders the form\n\n**Kind**: instance method of [DxpQuestions](#dxpquestions) \n**Example** \n```js\nvar form = DxpQuestions.init(// params);\nform.render();\n```\n\n\n### dxpQuestions.requestSubmit()\nWhen called, calls the function that submits the form\n\n**Kind**: instance method of [DxpQuestions](#dxpquestions) \n**Example** \n```js\nvar form = DxpQuestions.init(// params);\nform.requestSubmit();\n```\n\n\n### dxpQuestions.setAnswers()\nSets answers in the form.\n\n**Kind**: instance method of [DxpQuestions](#dxpquestions) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| params.answers | Object | The answer key/value pairs to set |\n| param.replaceAll | bool | Set to true to replace all answer values, false to only replace values that have a key in params.answers. Defaults to false. |\n\n**Example** \n```js\nvar form = DxpQuestions.init(// params);\nvar values = {};\nvalues['my_field_1234'] = 'Some value';\nform.setAnswers({ answers: values, replaceAll: false });\n```\n\n\n### DxpQuestions.init(params) ⇒ Object\nInitialize a new form that will render questions and answers\n\n**Kind**: static method of [DxpQuestions](#dxpquestions) \n**Returns**: Object - An instance of the form \n\n| Param | Type | Description |\n| --- | --- | --- |\n| params | Object | The parameters used to initialize the form |\n| params.questions | Array | A list of questions to render |\n| params.answers | Array | A list of answers to render |\n| params.container | Object | The HTML element that will contain the rendered form |\n| params.onFieldValidate | Object | Mapping of question id to custom validation function |\n| params.onFieldChange | Object | Mapping of question id to custom on change function |\n| params.onValidate | [onValidate](#onValidate) | A callback function that is called everytime an answer is validated |\n| params.onSubmit | [onSubmit](#onSubmit) | A callback function that is called when the `submitRequest()` method is called on the form |\n\n**Example** \n```js\nvar form = DxpQuestions.init({\n questions: // questions object here,\n answers: // answers object here,\n container: document.getElementById('container'),\n onFieldValidate: {\n 'custom_field_id-12345': function(context) {\n var errors = {};\n if (context.answer.indexOf('@gmail.com') < 0) {\n errors['_summary'] = 'must be a gmail adress';\n }\n context.setErrors({ errors: errors })\n }\n },\n onFieldChange: function(context) {\n 'custom_field_id-56789': function(context) {\n context.setExtraHtml('This is a calculated value of ' + context.answer);\n }\n },\n onValidate: function (result) { \n // show error if result.valid === false\n },\n onSubmit: function (result) {\n // make API call with result.answers\n }\n})\n```\n\n\n## onValidate : function\n**Kind**: global typedef \n\n| Param | Type | Description |\n| --- | --- | --- |\n| result | Object | A callback when a validation event has occurred |\n| result.valid | bool | Indicates if the all questions in the form are valid |\n\n\n\n## onSubmit : function\n**Kind**: global typedef \n\n| Param | Type | Description |\n| --- | --- | --- |\n| result | Object | A callback that is executed when `requestSubmit()` is called |\n| result.valid | bool | Indicates if the all questions in the form are valid |\n| result.answers | Object | The list of all the answers |\n| result.errors | Object | The lsit of all the errors |\n\n\n\n","maintainers":[{"email":"loftin.adam@gmail.com","name":"aloftin"},{"email":"caleb.mail@gmail.com","name":"calebt"},{"email":"keystone@daxko.com","name":"daxkoadmin"},{"email":"higgisp@gmail.com","name":"higgisp"},{"email":"ssubramanian@daxko.com","name":"ssubramanian"}],"time":{"modified":"2022-04-30T17:01:24.446Z","created":"2017-10-25T20:49:16.327Z","0.1.0":"2017-10-25T20:49:16.327Z","0.1.0-prerelease.3":"2017-10-25T20:49:24.712Z","0.1.1-prerelease.0":"2017-12-07T20:48:59.156Z","0.1.1-prerelease.1":"2017-12-07T20:49:12.345Z","0.1.1":"2017-12-07T20:50:22.557Z","0.1.2":"2017-12-11T15:36:03.425Z","0.1.2-prerelease.0":"2017-12-11T15:36:18.325Z","0.1.3-prerelease.0":"2017-12-11T20:37:30.697Z","0.1.3":"2017-12-11T20:38:01.137Z","0.1.4-prerelease.0":"2017-12-11T21:01:43.945Z","0.1.4":"2017-12-11T21:01:57.363Z","0.1.5-prerelease.0":"2017-12-11T21:07:52.405Z","0.1.5":"2017-12-11T21:08:28.595Z","0.1.6-prerelease.0":"2017-12-11T21:26:46.690Z","0.1.6":"2017-12-11T21:27:54.459Z","0.1.7-prerelease.0":"2017-12-12T19:46:01.523Z","0.1.7":"2017-12-12T19:46:01.745Z","0.1.9-prerelease.0":"2018-01-04T19:39:14.000Z","0.1.9":"2018-01-04T19:39:18.094Z","0.1.10":"2018-01-12T21:42:54.518Z","0.1.10-prerelease.0":"2018-01-12T21:43:22.600Z","0.1.11":"2018-01-12T22:32:29.445Z","0.1.11-prerelease.0":"2018-01-12T22:33:15.948Z","0.1.12":"2018-01-12T22:36:44.149Z","0.1.12-prerelease.0":"2018-01-12T22:39:34.151Z","0.1.13-prerelease.0":"2018-01-12T22:40:47.970Z","0.1.13":"2018-01-12T22:41:50.039Z","0.1.14-prerelease.1":"2018-02-22T17:20:47.701Z","0.1.14":"2018-02-22T17:20:55.133Z","0.1.14-prerelease.2":"2018-02-22T17:21:27.373Z","0.1.15-prerelease.0":"2018-02-22T18:32:11.857Z","0.1.15":"2018-02-22T18:32:39.846Z","0.1.16-prerelease.0":"2018-03-02T21:54:58.527Z","0.1.16":"2018-03-02T21:55:35.354Z","0.1.17-prerelease.0":"2018-03-15T16:12:55.476Z","0.1.17":"2018-03-15T16:12:59.497Z","0.1.18":"2018-08-13T19:10:03.254Z","0.1.19":"2018-08-13T19:17:33.064Z"},"homepage":"http://www.daxko.com","keywords":["daxko","questions","answers","api"],"repository":{"type":"git","url":"git+https://github.com/daxko/dxp-questions-ui.git"},"author":{"name":"Daxko"},"bugs":{"url":"https://github.com/daxko/dxp-questions-ui/issues"},"license":"BSD-2-Clause","readmeFilename":"README.md"}