@formio/js 5.0.2-rc.3 → 5.1.0-dev.5936.fa0f253

package/lib/mjs/Webform.d.ts

@@ -34,10 +34,10 @@
  */
 /**
  * @typedef {object} ButtonSettings
- * @property {boolean} [showPrevious] - Show the "Previous" button.
- * @property {boolean} [showNext] - Show the "Next" button.
- * @property {boolean} [showCancel] - Show the "Cancel" button.
- * @property {boolean} [showSubmit] - Show the "Submit" button.
+ * @property {boolean} [showPrevious] - Show the 'Previous' button.
+ * @property {boolean} [showNext] - Show the 'Next' button.
+ * @property {boolean} [showCancel] - Show the 'Cancel' button.
+ * @property {boolean} [showSubmit] - Show the 'Submit' button.
  */
 /**
  * @typedef {object} FormOptions
@@ -190,7 +190,10 @@ declare class Webform extends NestedDataComponent {
     get language(): string;
     root: this;
     localRoot: this;
+    beforeInit(): void;
+    executeFormController: any;
     get emptyValue(): null;
+    get shouldCallFormController(): any;
     get shadowRoot(): any;
     /**
      * Add a language for translations
@@ -257,7 +260,7 @@ declare class Webform extends NestedDataComponent {
     get ready(): Promise<any>;
     /**
      * Set the loading state for this form, and also show the loader spinner.
-     * @param {boolean} loading - If this form should be "loading" or not.
+     * @param {boolean} loading - If this form should be 'loading' or not.
      */
     set loading(loading: boolean);
     /**
@@ -330,6 +333,13 @@ declare class Webform extends NestedDataComponent {
      * @returns {object} - The submission object.
      */
     get submission(): object;
+    /**
+     * Sets the submission value
+     * @param {object|null|undefined} submission - The submission to set.
+     * @param {object|null|undefined} flags - Any flags to apply when setting the submission.
+     * @returns {void}
+     */
+    onSetSubmission(submission: object | null | undefined, flags?: object | null | undefined): void;
     /**
      * Sets a submission and returns the promise when it is ready.
      * @param {any} submission - The submission to set.
@@ -353,16 +363,16 @@ declare class Webform extends NestedDataComponent {
      * @returns {Promise} - The promise that is triggered when the form is built.
      */
     init(): Promise<any>;
-    executeFormController(): false | undefined;
+    _executeFormController(): void;
     build(element: any): Promise<any>;
     getClassName(): string;
-    render(): import("./components/_classes/field/Field").default;
+    render(): string;
     redraw(): Promise<void> | Promise<boolean>;
     attach(element: any): Promise<boolean>;
     hasRequiredFields(): boolean;
     /**
      * Sets a new alert to display in the error dialog of the form.
-     * @param {string} type - The type of alert to display. "danger", "success", "warning", etc.
+     * @param {string} type - The type of alert to display. 'danger', 'success', 'warning', etc.
      * @param {string} message - The message to show in the alert.
      * @param {object} options - The options for the alert.
      */
@@ -419,7 +429,7 @@ declare class Webform extends NestedDataComponent {
      */
     cancel(noconfirm: boolean): boolean;
     setMetadata(submission: any): void;
-    submitForm(options?: {}): Promise<any>;
+    submitForm(options?: {}, local?: boolean): Promise<any>;
     setServerErrors(error: any): void;
     serverErrors: any;
     executeSubmit(options: any): Promise<object>;
@@ -445,7 +455,7 @@ declare class Webform extends NestedDataComponent {
      */
     submit(before?: boolean, options?: any): Promise<any>;
     submitUrl(URL: any, headers: any): void;
-    triggerCaptcha(): void;
+    triggerCaptcha(components?: null): void;
     _nosubmit: any;
     get conditions(): any;
     get variables(): any;
@@ -540,19 +550,19 @@ export type SanitizeConfig = {
 };
 export type ButtonSettings = {
     /**
-     * - Show the "Previous" button.
+     * - Show the 'Previous' button.
      */
     showPrevious?: boolean | undefined;
     /**
-     * - Show the "Next" button.
+     * - Show the 'Next' button.
      */
     showNext?: boolean | undefined;
     /**
-     * - Show the "Cancel" button.
+     * - Show the 'Cancel' button.
      */
     showCancel?: boolean | undefined;
     /**
-     * - Show the "Submit" button.
+     * - Show the 'Submit' button.
      */
     showSubmit?: boolean | undefined;
 };
@@ -732,5 +742,5 @@ export type FormOptions = {
      */
     zoom?: number | undefined;
 };
-import NestedDataComponent from "./components/_classes/nesteddata/NestedDataComponent";
-import EventEmitter from "./EventEmitter";
+import NestedDataComponent from './components/_classes/nesteddata/NestedDataComponent';
+import EventEmitter from './EventEmitter';