Skip to content

Commit

Permalink
Merge branch 'master' into add-new-dashboard-api-doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@ryangec
ryangec authored Jun 27, 2024
2 parents b074f1d + 9802e3c commit 80149d7
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 76 deletions.
78 changes: 35 additions & 43 deletions editor-elements/$w/WixFormsV2.service.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,20 @@
"",
"Note the following when working with the `WixFormsV2` element:",
"",
"* The ID number that is shown when you hover over the form is actually a widget ID. You can change the widget ID in the Properties & Events tab. Example of a widget ID: `#371Ee199389C4A93849Ee35B8A15B7Ca2`. ",
"* The ID that is shown when you hover over the form is actually an element ID. You can change the ID at any time using the Properties & Events panel. Example of a default element ID: `#form1`. ",
"",
"> **Note:** ",
"> Before a certain date, the element ID was a long string such as `#371Ee199389C4A93849Ee35B8A15B7Ca2`. Now, that element ID is like `#form1`.",
"",
"* To get the form ID, call [`querySubmissionsByNamespace()`](https://www.wix.com/velo/reference/wix-forms-v2/submissions/querysubmissionsbynamespace). Example of a form ID: `21bcb6c7-02b3-4ed1-b6db-7856094fac03`.",
"",
"* If you have several widgets with the same form (for example, you copy-pasted a form on the same site), the functions applied to a form ID will run on all widgets.",
"* If you have several elements based on the same form (for example, you copy-pasted a form on the same site), the functions applied to a form ID will run on all elements.",
"",
"* You can only use the default field name keys in the Velo code. To check the key name, click on the form field in the form edit mode and then the **Advanced** tab.",
"",
"* You need at least a [Standard Premium](https://support.wix.com/en/article/choosing-a-premium-plan) plan to be able to upload files in your form. Also, different premium plans allow you to have different quantity of fields, rules, and pages you can add.",
"",
"* You can see the submissions both in the form dashboard and Wix Forms collection. The collection is read-only. You can manage submissions only in the form dashboard.",
"* You can see the submissions both in the form dashboard and Wix Forms collection. The collection is read-only. You can manage submissions only in the **Forms & Submissions** dashboard page under **Customer & Leads** in the menu.",
"",
"",
"### Event Handling",
Expand Down Expand Up @@ -90,14 +93,13 @@
"properties": [],
"operations":
[ { "name": "getFieldValues",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params": [],
"ret":
{ "type": "$w.WixFormsV2.FormValues" },
"locations":
[ { "lineno": 95,
[ { "lineno": 98,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Gets Wix Form field values.",
Expand All @@ -123,14 +125,13 @@
"extra":
{ } },
{ "name": "getStepCount",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params": [],
"ret":
{ "type": "number" },
"locations":
[ { "lineno": 170,
[ { "lineno": 173,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Gets the total number of steps in a Wix Form.",
Expand All @@ -146,14 +147,13 @@
"extra":
{ } },
{ "name": "getStepNumber",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params": [],
"ret":
{ "type": "number" },
"locations":
[ { "lineno": 178,
[ { "lineno": 181,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Gets the current step number of a Wix Form. Counting starts from 1.",
Expand All @@ -169,8 +169,7 @@
"extra":
{ } },
{ "name": "navigateToStep",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "stepNumber",
Expand All @@ -179,7 +178,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 186,
[ { "lineno": 189,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Navigates to the given Wix Form step. If an invalid number is passed, `navigateToStep()` doesn't run.",
Expand All @@ -195,8 +194,7 @@
"extra":
{ } },
{ "name": "onFieldValueChange",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "callback",
Expand All @@ -205,7 +203,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 103,
[ { "lineno": 106,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Runs a callback when a site visitor changes Wix Form field values.",
Expand All @@ -232,8 +230,7 @@
"extra":
{ } },
{ "name": "onStepNumberChange",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "callback",
Expand All @@ -242,7 +239,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 195,
[ { "lineno": 198,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Runs a callback when a Wix Form navigates to another step.",
Expand Down Expand Up @@ -275,8 +272,7 @@
"extra":
{ } },
{ "name": "onSubmit",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "callback",
Expand All @@ -285,7 +281,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 112,
[ { "lineno": 115,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Runs a callback when a site visitor starts to submit a Wix Form yet before the form is actually submitted and sent to the server.",
Expand Down Expand Up @@ -314,8 +310,7 @@
"extra":
{ } },
{ "name": "onSubmitFailure",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "callback",
Expand All @@ -324,7 +319,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 130,
[ { "lineno": 133,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Runs a callback when a site visitor is not able to successfully submit a Wix Form to the server.",
Expand Down Expand Up @@ -358,8 +353,7 @@
"extra":
{ } },
{ "name": "onSubmitSuccess",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "callback",
Expand All @@ -368,7 +362,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 121,
[ { "lineno": 124,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Runs a callback when a site visitor submits a Wix Form and it is successfully received by the server.",
Expand All @@ -386,8 +380,7 @@
"extra":
{ } },
{ "name": "setFieldValues",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "values",
Expand All @@ -396,7 +389,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 85,
[ { "lineno": 88,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Sets Wix Form field values. \nSetting the invalid field values fires the `onFieldValuesChange()` callback. The callback returns fields with the valid values previously set.",
Expand All @@ -414,8 +407,7 @@
"extra":
{ } },
{ "name": "submit",
"labels":
[ "changed" ],
"labels": [],
"nameParams": [],
"params": [],
"ret":
Expand All @@ -425,7 +417,7 @@
[ "$w.WixFormsV2.FormValues" ] },
"doc": "Fulfilled - When submission is successful.\nRejected - Error message." },
"locations":
[ { "lineno": 148,
[ { "lineno": 151,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "Submits a Wix Form.",
Expand Down Expand Up @@ -481,7 +473,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 205,
[ { "lineno": 208,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "A callback for a form field value change.",
Expand All @@ -501,7 +493,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 236,
[ { "lineno": 239,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "A callback for a changed form step number.",
Expand All @@ -521,7 +513,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 213,
[ { "lineno": 216,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "A callback for a form submission.",
Expand All @@ -541,7 +533,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 228,
[ { "lineno": 231,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "A callback for a failed form submission.",
Expand All @@ -558,7 +550,7 @@
"ret":
{ "type": "void" },
"locations":
[ { "lineno": 221,
[ { "lineno": 224,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "A callback for a successful form submission.",
Expand All @@ -571,7 +563,7 @@
"messages":
[ { "name": "FormValues",
"locations":
[ { "lineno": 244,
[ { "lineno": 247,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "An object containing information about an input field in a form.",
Expand All @@ -588,7 +580,7 @@
"labels": [] },
{ "name": "SubmissionError",
"locations":
[ { "lineno": 250,
[ { "lineno": 253,
"filename": "WixForms.js" } ],
"docs":
{ "summary": "An object containing information about the error.",
Expand Down
8 changes: 3 additions & 5 deletions wix-dashboard/wix-dashboard.service.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"operations":
[ { "name": "addSitePlugin",
"labels":
[ "new" ],
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "pluginId",
Expand Down Expand Up @@ -676,8 +676,7 @@
"doc": "Information about the slot in which you want to add the plugin. Learn more about the [slots that are available on Wix app pages](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-plugins/supported-wix-app-pages/about-slots)." } ],
"extra":
{ },
"labels":
[ "new" ] },
"labels": [] },
{ "name": "Archive",
"locations":
[ { "lineno": 90,
Expand Down Expand Up @@ -1133,8 +1132,7 @@
"doc": "ID of the slot." } ],
"extra":
{ },
"labels":
[ "new" ] },
"labels": [] },
{ "name": "Serializable",
"locations":
[ { "lineno": 39,
Expand Down
Loading

0 comments on commit 80149d7

Please sign in to comment.