@formio/js 5.0.0-rc.52 → 5.0.0-rc.53

package/lib/cjs/utils/utils.js

@@ -403,14 +403,13 @@ function checkCondition(component, row, data, form, instance) {
 exports.checkCondition = checkCondition;
 /**
  * Test a trigger on a component.
- * @param component
- * @param action
- * @param trigger
- * @param data
- * @param row
- * @param form
- * @param instance
- * @returns {mixed}
+ * @param {import('@formio/core').Component} component - The component to test the trigger against.
+ * @param {import('@formio/core').LogicTrigger} trigger - The trigger configuration.
+ * @param {import('@formio/core').DataObject} row - The contextual row data.
+ * @param {import('@formio/core').DataObject} data - The root data object.
+ * @param {import('@formio/core').Form} form - The form object.
+ * @param {any} instance - The component that is performing the trigger.
+ * @returns {boolean} - TRUE if the trigger should fire; FALSE otherwise.
  */
 function checkTrigger(component, trigger, row, data, form, instance) {
     // If trigger is empty, don't fire it
@@ -431,13 +430,14 @@ function checkTrigger(component, trigger, row, data, form, instance) {
 }
 exports.checkTrigger = checkTrigger;
 /**
- *
- * @param component
- * @param action
- * @param result
- * @param row
- * @param data
- * @param instance
+ * Sets a property on a component via an executed Logic action.
+ * @param {import('@formio/core').Component} component - The component to set the property on.
+ * @param {import('@formio/core').LogicAction} action - The action to perform on the component.
+ * @param {string} result - The name of the variable in the evaulation to use as the result.
+ * @param {import('@formio/core').DataObject} row - The contextual row data.
+ * @param {import('@formio/core').DataObject} data - The full submission data.
+ * @param {any} instance - The component instance.
+ * @returns {import('@formio/core').Component} - The modified component.
  */
 function setActionProperty(component, action, result, row, data, instance) {
     const property = action.property.value;
@@ -473,8 +473,8 @@ function setActionProperty(component, action, result, row, data, instance) {
 exports.setActionProperty = setActionProperty;
 /**
  * Unescape HTML characters like &lt, &gt, &amp and etc.
- * @param str
- * @returns {string}
+ * @param {string} str - The string to unescape.
+ * @returns {string} - The unescaped string.
  */
 function unescapeHTML(str) {
     if (typeof window === 'undefined' || !('DOMParser' in window)) {
@@ -486,14 +486,9 @@ function unescapeHTML(str) {
 exports.unescapeHTML = unescapeHTML;
 /**
  * Make HTML element from string
- * @param str
- * @param selector
- * @returns {HTMLElement}
- */
-/**
- *
- * @param str
- * @param selector
+ * @param {string} str - The string to convert to an HTML element.
+ * @param {string} selector - The selector to use to get the element once it is created.
+ * @returns {HTMLElement} - The HTML element that was created.
  */
 function convertStringToHTMLElement(str, selector) {
     const doc = new window.DOMParser().parseFromString(str, 'text/html');
@@ -502,10 +497,10 @@ function convertStringToHTMLElement(str, selector) {
 exports.convertStringToHTMLElement = convertStringToHTMLElement;
 /**
  * Make a filename guaranteed to be unique.
- * @param name
- * @param template
- * @param evalContext
- * @returns {string}
+ * @param {string} name - The original name of the file.
+ * @param {string} template - The template to use for the unique name.
+ * @param {object} evalContext - The context to use for the evaluation.
+ * @returns {string} - A unique filename.
  */
 function uniqueName(name, template, evalContext) {
     template = template || '{{fileName}}-{{guid}}';
@@ -530,7 +525,8 @@ function uniqueName(name, template, evalContext) {
 }
 exports.uniqueName = uniqueName;
 /**
- *
+ * Returns a GUID
+ * @returns {string} - A GUID.
  */
 function guid() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
@@ -544,8 +540,8 @@ function guid() {
 exports.guid = guid;
 /**
  * Return a translated date setting.
- * @param date
- * @returns {(null|Date)}
+ * @param {string|Date} date - The date to translate.
+ * @returns {(null|Date)} - The translated date.
  */
 function getDateSetting(date) {
     if (lodash_1.default.isNil(date) || lodash_1.default.isNaN(date) || date === '') {
@@ -588,8 +584,9 @@ function getDateSetting(date) {
 }
 exports.getDateSetting = getDateSetting;
 /**
- *
- * @param date
+ * Returns true if the date is a valid date. False otherwise.
+ * @param {Date|string} date - The date to check for validity.
+ * @returns {boolean} - TRUE if the date is valid; FALSE otherwise.
  */
 function isValidDate(date) {
     return lodash_1.default.isDate(date) && !lodash_1.default.isNaN(date.getDate());
@@ -597,7 +594,7 @@ function isValidDate(date) {
 exports.isValidDate = isValidDate;
 /**
  * Get the current timezone string.
- * @returns {string}
+ * @returns {string} - The current timezone.
  */
 function currentTimezone() {
     if (moment_timezone_1.default.currentTimezone) {
@@ -609,9 +606,9 @@ function currentTimezone() {
 exports.currentTimezone = currentTimezone;
 /**
  * Get an offset date provided a date object and timezone object.
- * @param date
- * @param timezone
- * @returns {Date}
+ * @param {Date} date - The date to offset.
+ * @param {string} timezone - The timezone to offset the date to.
+ * @returns {Date} - The offset date.
  */
 function offsetDate(date, timezone) {
     if (timezone === 'UTC') {
@@ -629,7 +626,7 @@ function offsetDate(date, timezone) {
 exports.offsetDate = offsetDate;
 /**
  * Returns if the zones are loaded.
- * @returns {boolean}
+ * @returns {boolean} - TRUE if the zones are loaded; FALSE otherwise.
  */
 function zonesLoaded() {
     return moment_timezone_1.default.zonesLoaded;
@@ -637,8 +634,8 @@ function zonesLoaded() {
 exports.zonesLoaded = zonesLoaded;
 /**
  * Returns if we should load the zones.
- * @param timezone
- * @returns {boolean}
+ * @param {string} timezone - The timezone to check if we should load the zones.
+ * @returns {boolean} - TRUE if we should load the zones; FALSE otherwise.
  */
 function shouldLoadZones(timezone) {
     if (timezone === currentTimezone() || timezone === 'UTC') {
@@ -649,9 +646,9 @@ function shouldLoadZones(timezone) {
 exports.shouldLoadZones = shouldLoadZones;
 /**
  * Externally load the timezone data.
- * @param url
- * @param timezone
- * @returns {Promise<any> | *}
+ * @param {string} url - The URL to load the timezone data from.
+ * @param {string} timezone - The timezone to load.
+ * @returns {Promise<any> | *} - Resolves when the zones for this timezone are loaded.
  */
 function loadZones(url, timezone) {
     if (timezone && !shouldLoadZones(timezone)) {
@@ -676,10 +673,10 @@ function loadZones(url, timezone) {
 exports.loadZones = loadZones;
 /**
  * Get the moment date object for translating dates with timezones.
- * @param value
- * @param format
- * @param timezone
- * @returns {*}
+ * @param {string|Date} value - The value to convert into a moment date.
+ * @param {string} format - The format to convert the date to.
+ * @param {string} timezone - The timezone to convert the date to.
+ * @returns {Date} - The moment date object.
  */
 function momentDate(value, format, timezone) {
     const momentDate = (0, moment_timezone_1.default)(value);
@@ -697,12 +694,12 @@ function momentDate(value, format, timezone) {
 exports.momentDate = momentDate;
 /**
  * Format a date provided a value, format, and timezone object.
- * @param timezonesUrl
- * @param value
- * @param format
- * @param timezone
- * @param flatPickrInputFormat
- * @returns {string}
+ * @param {string} timezonesUrl - The URL to load the timezone data from.
+ * @param {string|Date} value - The value to format.
+ * @param {string} format - The format to format the date to.
+ * @param {string} timezone - The timezone to format the date to.
+ * @param {string} flatPickrInputFormat - The format to use for flatpickr input.
+ * @returns {string} - The formatted date.
  */
 function formatDate(timezonesUrl, value, format, timezone, flatPickrInputFormat) {
     const momentDate = (0, moment_timezone_1.default)(value, flatPickrInputFormat || undefined);
@@ -736,12 +733,12 @@ function formatDate(timezonesUrl, value, format, timezone, flatPickrInputFormat)
 exports.formatDate = formatDate;
 /**
  * Pass a format function to format within a timezone.
- * @param timezonesUrl
- * @param formatFn
- * @param date
- * @param format
- * @param timezone
- * @returns {string}
+ * @param {string} timezonesUrl - The URL to load the timezone data from.
+ * @param {Function} formatFn - The format function to use.
+ * @param {Date|string} date - The date to format.
+ * @param {string} format - The format to format the date to.
+ * @param {string} timezone - The timezone to format the date to.
+ * @returns {string} - The formatted date.
  */
 function formatOffset(timezonesUrl, formatFn, date, format, timezone) {
     if (timezone === currentTimezone()) {
@@ -762,8 +759,9 @@ function formatOffset(timezonesUrl, formatFn, date, format, timezone) {
 }
 exports.formatOffset = formatOffset;
 /**
- *
- * @param locale
+ * Returns the local date format information.
+ * @param {Intl.LocalesArgument} locale - The locale to get the date format for.
+ * @returns {object} - The local date format information.
  */
 function getLocaleDateFormatInfo(locale) {
     const formatInfo = {};
@@ -776,8 +774,8 @@ function getLocaleDateFormatInfo(locale) {
 exports.getLocaleDateFormatInfo = getLocaleDateFormatInfo;
 /**
  * Convert the format from the angular-datepicker module to flatpickr format.
- * @param format
- * @returns {string}
+ * @param {string} format - The format to convert.
+ * @returns {string} - The converted format.
  */
 function convertFormatToFlatpickr(format) {
     return format
@@ -808,8 +806,8 @@ function convertFormatToFlatpickr(format) {
 exports.convertFormatToFlatpickr = convertFormatToFlatpickr;
 /**
  * Convert the format from the angular-datepicker module to moment format.
- * @param format
- * @returns {string}
+ * @param {string} format - The format to convert.
+ * @returns {string} - The converted format.
  */
 function convertFormatToMoment(format) {
     return format
@@ -826,8 +824,9 @@ function convertFormatToMoment(format) {
 }
 exports.convertFormatToMoment = convertFormatToMoment;
 /**
- *
- * @param format
+ * Convert the format from the angular-datepicker module to mask format.
+ * @param {string} format - The format to convert.
+ * @returns {string} - The converted format.
  */
 function convertFormatToMask(format) {
     return format
@@ -889,10 +888,11 @@ function getInputMask(mask, placeholderChar) {
 }
 exports.getInputMask = getInputMask;
 /**
- *
- * @param value
- * @param mask
- * @param placeholderChar
+ * Unmasks a value using the provided mask and placeholder characters.
+ * @param {string} value - The value to unmask.
+ * @param {string} mask - The mask to use for unmasking.
+ * @param {string} placeholderChar - The placeholder character to use for unmasking.
+ * @returns {string} - The unmasked value.
  */
 function unmaskValue(value, mask, placeholderChar) {
     if (!mask || !value || value.length > mask.length) {
@@ -911,9 +911,10 @@ function unmaskValue(value, mask, placeholderChar) {
 }
 exports.unmaskValue = unmaskValue;
 /**
- *
- * @param value
- * @param inputMask
+ * Returns true if the value matches the input mask format.
+ * @param {string} value - The value to check.
+ * @param {string} inputMask - The input mask to check against.
+ * @returns {boolean} - TRUE if the value matches the input mask; FALSE otherwise.
  */
 function matchInputMask(value, inputMask) {
     if (!inputMask) {
@@ -934,8 +935,9 @@ function matchInputMask(value, inputMask) {
 }
 exports.matchInputMask = matchInputMask;
 /**
- *
- * @param lang
+ * Returns the number separators (i.e. 1,000) for the provided language.
+ * @param {string} lang - The language code to get the number separators for.
+ * @returns {{delimiter: string, decimalSeparator: string}} - The number separators.
  */
 function getNumberSeparators(lang = 'en') {
     const formattedNumberString = (12345.6789).toLocaleString(lang);
@@ -953,9 +955,10 @@ function getNumberSeparators(lang = 'en') {
 }
 exports.getNumberSeparators = getNumberSeparators;
 /**
- *
- * @param component
- * @param defaultLimit
+ * Returns the number for the maximum amount of decimal places for a number.
+ * @param {import('@formio/core').Component} component - The component to check for decimal limits.
+ * @param {number} defaultLimit - The default limit to use if none is provided in the component.
+ * @returns {number} - The number of decimal places allowed.
  */
 function getNumberDecimalLimit(component, defaultLimit) {
     if (lodash_1.default.has(component, 'decimalLimit')) {
@@ -974,12 +977,13 @@ function getNumberDecimalLimit(component, defaultLimit) {
 }
 exports.getNumberDecimalLimit = getNumberDecimalLimit;
 /**
- *
- * @param root0
- * @param root0.currency
- * @param root0.decimalLimit
- * @param root0.decimalSeparator
- * @param root0.lang
+ * Returns the currency affixes for a specific language.
+ * @param {object} arg0 - The arguments object.
+ * @param {string} arg0.currency - The currency code to get the affixes for.
+ * @param {number} arg0.decimalLimit - The number of decimal places to use.
+ * @param {string} arg0.decimalSeparator - The decimal separator to use.
+ * @param {string} arg0.lang - The language code to use.
+ * @returns {{prefix: string, suffix: string}} - The currency affixes.
  */
 function getCurrencyAffixes({ currency, decimalLimit, decimalSeparator, lang, }) {
     // Get the prefix and suffix from the localized string.
@@ -1003,9 +1007,9 @@ function getCurrencyAffixes({ currency, decimalLimit, decimalSeparator, lang, })
 exports.getCurrencyAffixes = getCurrencyAffixes;
 /**
  * Fetch the field data provided a component.
- * @param data
- * @param component
- * @returns {*}
+ * @param {import('@formio/core').DataObject} data - The data object to fetch the field data from.
+ * @param {import('@formio/core').Component} component - The component to fetch the field data for.
+ * @returns {*} - The field data.
  */
 function fieldData(data, component) {
     if (!data) {
@@ -1052,10 +1056,10 @@ function fieldData(data, component) {
 exports.fieldData = fieldData;
 /**
  * Delays function execution with possibility to execute function synchronously or cancel it.
- * @param fn Function to delay
- * @param delay Delay time
- * @param {...any} args
- * @returns {*}
+ * @param {Function} fn - Function to delay
+ * @param {number} delay - Delay time
+ * @param {...any} args - Arguments to pass to the function
+ * @returns {*} - Function to cancel the delay
  */
 function delay(fn, delay = 0, ...args) {
     const timer = setTimeout(fn, delay, ...args);
@@ -1066,7 +1070,8 @@ function delay(fn, delay = 0, ...args) {
         clearTimeout(timer);
     }
     /**
-     *
+     * Execute the function early.
+     * @returns {*} - The result of the function.
      */
     function earlyCall() {
         cancel();

package/lib/mjs/Form.d.ts

@@ -1,27 +1,298 @@
 export default class Form extends Element {
     static embed(embed: any): Promise<any>;
+    constructor(elementOrForm: any, formOrOptions: any, options?: {});
+    /**
+     * Represents a JSON value.
+     * @typedef {(string | number | boolean | null | JSONArray | JSONObject)} JSON
+     */
+    /**
+     * Represents a JSON array.
+     * @typedef {Array<JSON>} JSONArray
+     */
+    /**
+     * Represents a JSON object.
+     * @typedef {{[key: string]: JSON}} JSONObject
+     */
+    /**
+     * @typedef {object} FormioHooks
+     * @property {Function} [beforeSubmit]
+     * @property {Function} [beforeCancel]
+     * @property {Function} [beforeNext]
+     * @property {Function} [beforePrev]
+     * @property {Function} [attachComponent]
+     * @property {Function} [setDataValue]
+     * @property {Function} [addComponents]
+     * @property {Function} [addComponent]
+     * @property {Function} [customValidation]
+     * @property {Function} [attachWebform]
+     */
+    /**
+     * @typedef {object} SanitizeConfig
+     * @property {string[]} [addAttr]
+     * @property {string[]} [addTags]
+     * @property {string[]} [allowedAttrs]
+     * @property {string[]} [allowedTags]
+     * @property {string[]} [allowedUriRegex]
+     * @property {string[]} [addUriSafeAttr]
+     */
+    /**
+     * @typedef {object} ButtonSettings
+     * @property {boolean} [showPrevious]
+     * @property {boolean} [showNext]
+     * @property {boolean} [showCancel]
+     * @property {boolean} [showSubmit]
+     */
+    /**
+     * @typedef {object} FormOptions
+     * @property {boolean} [saveDraft] - Enable the save draft feature.
+     * @property {number} [saveDraftThrottle] - The throttle for the save draft feature.
+     * @property {boolean} [readOnly] - Set this form to readOnly.
+     * @property {boolean} [noAlerts] - Disable the alerts dialog.
+     * @property {{[key: string]: string}} [i18n] - The translation file for this rendering.
+     * @property {string} [template] - Custom logic for creation of elements.
+     * @property {boolean} [noDefaults] - Exclude default values from the settings.
+     * @property {any} [fileService] - The file service for this form.
+     * @property {EventEmitter} [events] - The EventEmitter for this form.
+     * @property {string} [language] - The language to render this form in.
+     * @property {{[key: string]: string}} [i18next] - The i18next configuration for this form.
+     * @property {boolean} [viewAsHtml] - View the form as raw HTML.
+     * @property {'form' | 'html' | 'flat' | 'builder' | 'pdf'} [renderMode] - The render mode for this form.
+     * @property {boolean} [highlightErrors] - Highlight any errors on the form.
+     * @property {string} [componentErrorClass] - The error class for components.
+     * @property {any} [templates] - The templates for this form.
+     * @property {string} [iconset] - The iconset for this form.
+     * @property {import('@formio/core').Component[]} [components] - The components for this form.
+     * @property {{[key: string]: boolean}} [disabled] - Disabled components for this form.
+     * @property {boolean} [showHiddenFields] - Show hidden fields.
+     * @property {{[key: string]: boolean}} [hide] - Hidden components for this form.
+     * @property {{[key: string]: boolean}} [show] - Components to show for this form.
+     * @property {Formio} [formio] - The Formio instance for this form.
+     * @property {string} [decimalSeparator] - The decimal separator for this form.
+     * @property {string} [thousandsSeparator] - The thousands separator for this form.
+     * @property {FormioHooks} [hooks] - The hooks for this form.
+     * @property {boolean} [alwaysDirty] - Always be dirty.
+     * @property {boolean} [skipDraftRestore] - Skip restoring a draft.
+     * @property {'form' | 'wizard' | 'pdf'} [display] - The display for this form.
+     * @property {string} [cdnUrl] - The CDN url for this form.
+     * @property {boolean} [flatten] - Flatten the form.
+     * @property {boolean} [sanitize] - Sanitize the form.
+     * @property {SanitizeConfig} [sanitizeConfig] - The sanitize configuration for this form.
+     * @property {ButtonSettings} [buttonSettings] - The button settings for this form.
+     * @property {object} [breadcrumbSettings] - The breadcrumb settings for this form.
+     * @property {boolean} [allowPrevious] - Allow the previous button (for Wizard forms).
+     * @property {string[]} [wizardButtonOrder] - The order of the buttons (for Wizard forms).
+     * @property {boolean} [showCheckboxBackground] - Show the checkbox background.
+     * @property {number} [zoom] - The zoom for PDF forms.
+     */
     /**
      * Creates an easy to use interface for embedding webforms, pdfs, and wizards into your application.
-     * @param {object} element - The DOM element you wish to render this form within.
-     * @param {object | string} form - Either a Form JSON schema or the URL of a hosted form via. form.io.
-     * @param {object} options - The options to create a new form instance.
-     * @param {boolean} options.readOnly - Set this form to readOnly
-     * @param {boolean} options.noAlerts - Set to true to disable the alerts dialog.
-     * @param {boolean} options.i18n - The translation file for this rendering. @see https://github.com/formio/formio.js/blob/master/i18n.js
-     * @param {boolean} options.template - Provides a way to inject custom logic into the creation of every element rendered within the form.
-     * @param {...any} args
+     * @param {object} elementOrForm - The DOM element you wish to render this form within, or the form definition.
+     * @param {object | string | FormOptions} formOrOptions - A Form JSON schema, the URL of a hosted form, or the form options.
+     * @param {FormOptions} [options] - The options to create a new form instance.
      * @example
      * import Form from '@formio/js/Form';
      * const form = new Form(document.getElementById('formio'), 'https://examples.form.io/example');
      * form.build();
      */
-    constructor(...args: any[]);
+    /**
+     * @type {FormOptions} - the options for this Form.
+     */
+    options: {
+        /**
+         * - Enable the save draft feature.
+         */
+        saveDraft?: boolean | undefined;
+        /**
+         * - The throttle for the save draft feature.
+         */
+        saveDraftThrottle?: number | undefined;
+        /**
+         * - Set this form to readOnly.
+         */
+        readOnly?: boolean | undefined;
+        /**
+         * - Disable the alerts dialog.
+         */
+        noAlerts?: boolean | undefined;
+        /**
+         * - The translation file for this rendering.
+         */
+        i18n?: {
+            [key: string]: string;
+        } | undefined;
+        /**
+         * - Custom logic for creation of elements.
+         */
+        template?: string | undefined;
+        /**
+         * - Exclude default values from the settings.
+         */
+        noDefaults?: boolean | undefined;
+        /**
+         * - The file service for this form.
+         */
+        fileService?: any;
+        /**
+         * - The EventEmitter for this form.
+         */
+        events?: any;
+        /**
+         * - The language to render this form in.
+         */
+        language?: string | undefined;
+        /**
+         * - The i18next configuration for this form.
+         */
+        i18next?: {
+            [key: string]: string;
+        } | undefined;
+        /**
+         * - View the form as raw HTML.
+         */
+        viewAsHtml?: boolean | undefined;
+        /**
+         * - The render mode for this form.
+         */
+        renderMode?: "builder" | "form" | "html" | "flat" | "pdf" | undefined;
+        /**
+         * - Highlight any errors on the form.
+         */
+        highlightErrors?: boolean | undefined;
+        /**
+         * - The error class for components.
+         */
+        componentErrorClass?: string | undefined;
+        /**
+         * - The templates for this form.
+         */
+        templates?: any;
+        /**
+         * - The iconset for this form.
+         */
+        iconset?: string | undefined;
+        /**
+         * - The components for this form.
+         */
+        components?: import("@formio/core").Component[] | undefined;
+        /**
+         * - Disabled components for this form.
+         */
+        disabled?: {
+            [key: string]: boolean;
+        } | undefined;
+        /**
+         * - Show hidden fields.
+         */
+        showHiddenFields?: boolean | undefined;
+        /**
+         * - Hidden components for this form.
+         */
+        hide?: {
+            [key: string]: boolean;
+        } | undefined;
+        /**
+         * - Components to show for this form.
+         */
+        show?: {
+            [key: string]: boolean;
+        } | undefined;
+        /**
+         * - The Formio instance for this form.
+         */
+        formio?: any;
+        /**
+         * - The decimal separator for this form.
+         */
+        decimalSeparator?: string | undefined;
+        /**
+         * - The thousands separator for this form.
+         */
+        thousandsSeparator?: string | undefined;
+        /**
+         * - The hooks for this form.
+         */
+        hooks?: {
+            beforeSubmit?: Function | undefined;
+            beforeCancel?: Function | undefined;
+            beforeNext?: Function | undefined;
+            beforePrev?: Function | undefined;
+            attachComponent?: Function | undefined;
+            setDataValue?: Function | undefined;
+            addComponents?: Function | undefined;
+            addComponent?: Function | undefined;
+            customValidation?: Function | undefined;
+            attachWebform?: Function | undefined;
+        } | undefined;
+        /**
+         * - Always be dirty.
+         */
+        alwaysDirty?: boolean | undefined;
+        /**
+         * - Skip restoring a draft.
+         */
+        skipDraftRestore?: boolean | undefined;
+        /**
+         * - The display for this form.
+         */
+        display?: "form" | "pdf" | "wizard" | undefined;
+        /**
+         * - The CDN url for this form.
+         */
+        cdnUrl?: string | undefined;
+        /**
+         * - Flatten the form.
+         */
+        flatten?: boolean | undefined;
+        /**
+         * - Sanitize the form.
+         */
+        sanitize?: boolean | undefined;
+        /**
+         * - The sanitize configuration for this form.
+         */
+        sanitizeConfig?: {
+            addAttr?: string[] | undefined;
+            addTags?: string[] | undefined;
+            allowedAttrs?: string[] | undefined;
+            allowedTags?: string[] | undefined;
+            allowedUriRegex?: string[] | undefined;
+            addUriSafeAttr?: string[] | undefined;
+        } | undefined;
+        /**
+         * - The button settings for this form.
+         */
+        buttonSettings?: {
+            showPrevious?: boolean | undefined;
+            showNext?: boolean | undefined;
+            showCancel?: boolean | undefined;
+            showSubmit?: boolean | undefined;
+        } | undefined;
+        /**
+         * - The breadcrumb settings for this form.
+         */
+        breadcrumbSettings?: object | undefined;
+        /**
+         * - Allow the previous button (for Wizard forms).
+         */
+        allowPrevious?: boolean | undefined;
+        /**
+         * - The order of the buttons (for Wizard forms).
+         */
+        wizardButtonOrder?: string[] | undefined;
+        /**
+         * - Show the checkbox background.
+         */
+        showCheckboxBackground?: boolean | undefined;
+        /**
+         * - The zoom for PDF forms.
+         */
+        zoom?: number | undefined;
+    };
     ready: Promise<any>;
     readyResolve: (value: any) => void;
     readyReject: (reason?: any) => void;
     instance: any;
     element: any;
-    options: any;
     display: string;
     createElement(tag: any, attrs: any, children: any): any;
     set loading(load: any);