corrections for the dashboard components

* DocWorks for editor-elements - 88 changes detected, but 81 issue detected changes: Service $w.CollapsibleText property text.examples[1] has changed body Service $w.DashboardButton has changed summary Service $w.DashboardButton has changed description Service $w.DashboardButton property isLoaderVisible has changed description Service $w.DashboardButton property isLoaderVisible.examples[0] has changed body Service $w.DashboardButton property label.examples[0] has changed title Service $w.DashboardButton property label.examples[1] has changed title Service $w.DashboardButton property link.examples[0] has changed body Service $w.DashboardButton property link.examples[3] has changed body Service $w.DashboardButton property link.examples[4] has changed body Service $w.DashboardButton property prefix has changed description Service $w.DashboardButton property prefix.examples[0] has changed title Service $w.DashboardButton property prefix.examples[1] has changed title Service $w.DashboardButton property prefix.examples[2] has changed title Service $w.DashboardButton property prefix.examples[2] has changed body Service $w.DashboardButton property prefix.examples has 2 new examples Service $w.DashboardButton property suffix has changed description Service $w.DashboardButton property suffix.examples[0] has changed title Service $w.DashboardButton property suffix.examples[1] has changed title Service $w.DashboardButton property suffix.examples[2] has changed title Service $w.DashboardButton property suffix.examples[2] has changed body Service $w.DashboardButton property suffix.examples has 2 new examples Service $w.DashboardButton operation hideLoader has changed summary Service $w.DashboardButton operation hideLoader has changed description Service $w.DashboardButton operation showLoader has changed summary Service $w.DashboardButton operation showLoader has changed description Service $w.DashboardHeading has changed summary Service $w.DashboardHeading has changed description ... * DocWorks for editor-elements - 109 changes detected, but 84 issue detected changes: Service $w.DashboardButton has changed description Service $w.DashboardButton property label has changed default value Service $w.DashboardButton property label has changed summary Service $w.DashboardButton property label has changed description Service $w.DashboardButton property label.examples[0] has changed title Service $w.DashboardButton property label.examples[1] has changed title Service $w.DashboardButton property label.examples has 1 new examples Service $w.DashboardButton property link has changed description Service $w.DashboardButton property link.examples[0] has changed title Service $w.DashboardButton property link.examples[1] has changed title Service $w.DashboardButton property link.examples[1] has changed body Service $w.DashboardButton property link.examples[2] has changed title Service $w.DashboardButton property link.examples[3] has changed title Service $w.DashboardButton property link.examples[3] has changed body Service $w.DashboardButton property link.examples[4] has changed title Service $w.DashboardButton property link.examples[4] has changed body Service $w.DashboardButton property link.examples has 2 new examples Service $w.DashboardButton property prefix has changed description Service $w.DashboardButton property suffix has changed description Service $w.DashboardButton property target has changed setter Service $w.DashboardButton property target.examples[0] has changed title Service $w.DashboardButton property target.examples[1] has changed title Service $w.DashboardButton property target.examples[2] has changed title Service $w.DashboardHeading property text.examples[0] has changed body Service $w.DashboardIconButton property link has changed description Service $w.DashboardIconButton property link.examples[2] has changed title Service $w.DashboardIconButton property link.examples[2] has changed body Service $w.DashboardIconButton property link.example ... * DocWorks for editor-elements - 25 changes detected, but 84 issue detected changes: Service $w.DashboardButton property isLoaderVisible has changed description Service $w.DashboardButton property link has changed description Service $w.DashboardButton property target has changed setter Service $w.DashboardIconButton property link has changed summary Service $w.DashboardIconButton property link has changed description Service $w.DashboardIconButton property target has changed type Service $w.DashboardIconButton property target has changed getter Service $w.DashboardIconButton property target has changed default value Service $w.DashboardIconButton property target has changed summary Service $w.DashboardIconButton property target has changed description Service $w.DashboardIconButton property target has a new link [target](#target) Service $w.DashboardIconButton property target.examples has 3 new examples Service $w.DashboardIconButton property tooltip has changed description Service $w.DashboardInput property tooltip has changed description Service $w.DashboardNumberInput property tooltip has changed description Service $w.DashboardTextButton property target has changed type Service $w.DashboardTextButton property target has changed getter Service $w.DashboardTextButton property target has changed default value Service $w.DashboardTextButton property target has changed summary Service $w.DashboardTextButton property target has changed description Service $w.DashboardTextButton property target has a new link [target](#target) Service $w.DashboardTextButton property target.examples has 3 new examples Service $w.DashboardToggleSwitch has changed description Service $w.DashboardToggleSwitch property label.examples[1] has changed title Service $w.DashboardToggleSwitch property tooltip has changed description issues: Mixin $w.HiddenCollapsedMixin not found (Breadcrumbs.js (1)) Mixin $w.ViewportMixin not found (Breadcrumbs.js (1)) Mixin $w.Element not found (CollapsibleText ... * DocWorks for editor-elements - 299 changes detected, but 84 issue detected changes: Service $w.DashboardButton has changed summary Service $w.DashboardButton has changed description Service $w.DashboardButton property isLoaderVisible has changed description Service $w.DashboardButton property isLoaderVisible.examples[0] has changed body Service $w.DashboardButton property label has changed summary Service $w.DashboardButton property label.examples[0] has changed title Service $w.DashboardButton property label.examples[0] has changed body Service $w.DashboardButton property label.examples[1] has changed title Service $w.DashboardButton property label.examples[1] has changed body Service $w.DashboardButton property label.examples[2] has changed title Service $w.DashboardButton property label.examples[2] has changed body Service $w.DashboardButton property link.examples[0] has changed title Service $w.DashboardButton property link.examples[0] has changed body Service $w.DashboardButton property link.examples[1] has changed title Service $w.DashboardButton property link.examples[1] has changed body Service $w.DashboardButton property link.examples[2] has changed title Service $w.DashboardButton property link.examples[2] has changed body Service $w.DashboardButton property link.examples[3] has changed title Service $w.DashboardButton property link.examples[3] has changed body Service $w.DashboardButton property link.examples[4] has changed title Service $w.DashboardButton property link.examples[4] has changed body Service $w.DashboardButton property link.examples[5] has changed title Service $w.DashboardButton property link.examples[5] has changed body Service $w.DashboardButton property link.examples[6] has changed title Service $w.DashboardButton property link.examples[6] has changed body Service $w.DashboardButton property prefix.examples[0] has changed title Service $w.DashboardButton property prefix.examples[0] has changed body Service $w.DashboardButton property pr ... --------- Co-authored-by: taliasa <[email protected]>
wix-incubator · Aug 15, 2023 · dc26f8e · dc26f8e
1 parent 3681c58
commit dc26f8e
Show file tree

Hide file tree

Showing 10 changed files with 668 additions and 479 deletions.
diff --git a/editor-elements/$w/CollapsibleText.service.json b/editor-elements/$w/CollapsibleText.service.json
@@ -293,7 +293,7 @@
                     {  } },
                 { "title": "Set a collapsible text element's plain-text content",
                   "body":
-                    [ "$w('#myDashboardText').text = 'Text Value';" ],
+                    [ "$w('#myCollapsibleText').text = 'Text Value';" ],
                   "extra":
                     {  } } ],
             "extra":

diff --git a/editor-elements/$w/DashboardButton.service.json b/editor-elements/$w/DashboardButton.service.json
diff --git a/editor-elements/$w/DashboardHeading.service.json b/editor-elements/$w/DashboardHeading.service.json
@@ -2,14 +2,18 @@
   "memberOf": "$w",
   "mixes":
     [ "$w.HiddenCollapsedElement" ],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "DashboardHeading.js" },
   "docs":
-    { "summary": "Sets or gets the contents of a heading element.",
+    { "summary": "An element for displaying headings on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).",
       "description":
-        [ "A text element used to display headings." ],
+        [ "The dashboard heading element is intended for use on ",
+          "[dashboard pages](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/frontend-code/dashboard-admin-pages/working-with-dashboard-pages) ",
+          "in your Wix site or in [Wix Blocks](https://support.wix.com/en/article/wix-blocks-check-out-our-articles),",
+          "but you may use it on any page." ],
       "links": [],
       "examples": [],
       "extra":
@@ -21,7 +25,7 @@
         "set": false,
         "type": "$w.CustomClassList",
         "locations":
-          [ { "lineno": 28,
+          [ { "lineno": 33,
               "filename": "DashboardHeading.js" } ],
         "docs":
           { "summary": "<b>Note: This standard element property is not relevant for this DashboardHeading.</b>",
@@ -44,31 +48,33 @@
         "extra":
           {  } },
       { "name": "text",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": true,
         "type": "string",
         "locations":
-          [ { "lineno": 10,
+          [ { "lineno": 13,
               "filename": "DashboardHeading.js" },
-            { "lineno": 22,
+            { "lineno": 27,
               "filename": "DashboardHeading.js" } ],
         "docs":
           { "summary": "Sets or gets the text of a dashboard heading element.",
             "description":
-              [ "Use the `text` property to set the content of the dashboard heading element. Any existing text is replaced. Maximum length is 1200 characters." ],
+              [ "Use the `text` property to set the content of the dashboard heading element. Any existing text is replaced. ",
+                "",
+                "Max: 1200 characters" ],
             "links": [],
             "examples":
               [ { "title": "Get the dashboard heading's text",
                   "body":
-                    [ "//Get the heading text content ",
-                      "let myContent = $w(\"#myHeading\").text; // \"Heading text\"" ],
+                    [ "let myContent = $w('#myHeading').text; // \"Heading text\"" ],
                   "extra":
                     {  } },
                 { "title": "Set the dashboard heading's text to the specified value",
                   "body":
                     [ "//Set the heading text content ",
-                      "$w(\"#myHeading\").text = \"Heading\";" ],
+                      "$w('#myHeading').text = \"Heading\";" ],
                   "extra":
                     {  } } ],
             "extra":

diff --git a/editor-elements/$w/DashboardIconButton.service.json b/editor-elements/$w/DashboardIconButton.service.json
@@ -4,19 +4,20 @@
     [ "$w.HiddenCollapsedElement",
       "$w.ClickableMixin",
       "$w.DisabledMixin" ],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "DashboardIconButton.js" },
   "docs":
-    { "summary": "An icon button on your dashboard page.",
+    { "summary": "An icon button on your [dashboard page](https://dev.wix.com/docs/build-apps/developer-tools/cli/wix-cli-for-apps/dashboard-pages).",
       "description":
-        [ "Icon buttons allow you to use vector art as clickable buttons, creating a more interesting site experience.",
-          "You can use the dashboard icon button anywhere on your Wix site, but it is intended for use on your site's dashboard pages,",
-          "or on your [Wix Blocks dashboard pages](https://support.wix.com/en/article/wix-blocks-creating-and-managing-blocks-dashboard-pages).",
+        [ "Icon buttons allow you to use vector art as clickable buttons.",
           "",
-          "> **Note:**",
-          "> [Wix Blocks](https://support.wix.com/en/article/wix-blocks-check-out-our-articles) is an editor for building Wix apps. It is currently open to a limited number of users." ],
+          "The dashboard icon button is intended for use on ",
+          "[dashboard pages](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/frontend-code/dashboard-admin-pages/working-with-dashboard-pages) ",
+          "in your Wix site or in [Wix Blocks](https://support.wix.com/en/article/wix-blocks-check-out-our-articles),",
+          "but you may use it on any page." ],
       "links": [],
       "examples": [],
       "extra":
@@ -28,7 +29,7 @@
         "set": false,
         "type": "$w.CustomClassList",
         "locations":
-          [ { "lineno": 144,
+          [ { "lineno": 152,
               "filename": "DashboardIconButton.js" } ],
         "docs":
           { "summary": "<b>Note: This standard element property is not relevant for this DashboardIconButton.</b>",
@@ -51,21 +52,22 @@
         "extra":
           {  } },
       { "name": "icon",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": true,
         "type": "string",
         "locations":
-          [ { "lineno": 42,
+          [ { "lineno": 44,
               "filename": "DashboardIconButton.js" },
-            { "lineno": 64,
+            { "lineno": 66,
               "filename": "DashboardIconButton.js" } ],
         "docs":
-          { "summary": "Sets or gets the button's icon.",
+          { "summary": "Sets or gets the dashboard icon button's icon.",
             "description":
-              [ "The `icon` property defines the vector image used as the button's icon.",
+              [ "The `icon` property defines the vector image used as the dashboard button's icon.",
                 "",
-                "Setting `icon` changes the button icon to the image indicated by the new value.",
+                "Setting `icon` changes the dashboard button icon to the image indicated by the new value.",
                 "Getting the `icon` property returns the location of the icon image file.",
                 "",
                 "The following formats are supported:",
@@ -74,14 +76,14 @@
                 " + Vector XML string: `<svg>...</svg>`" ],
             "links": [],
             "examples":
-              [ { "title": "Set icon to an image from the Media Manager",
+              [ { "title": "Get a dashboard icon button's icon",
                   "body":
-                    [ "$w(\"#myButton\").icon = \"wix:vector://v1/11062b_636dddbfd3be4d77adf4cd14fbe28a49.svg/\";" ],
+                    [ "let icon = $w('#myIconButton').icon; //wix:vector://v1/11062b_636dddbfd3be4d77adf4cd14fbe28a49.svg/" ],
                   "extra":
                     {  } },
-                { "title": "Get a button's icon",
+                { "title": "Set icon to an image from the Media Manager",
                   "body":
-                    [ "let icon = $w(\"#myIconButton\").icon; //wix:vector://v1/11062b_636dddbfd3be4d77adf4cd14fbe28a49.svg/" ],
+                    [ "$w('#myButton').icon = \"wix:vector://v1/11062b_636dddbfd3be4d77adf4cd14fbe28a49.svg/\";" ],
                   "extra":
                     {  } },
                 { "title": "Set icon with a literal value",
@@ -99,20 +101,23 @@
         "extra":
           {  } },
       { "name": "link",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": true,
         "type": "string",
         "locations":
-          [ { "lineno": 70,
+          [ { "lineno": 72,
               "filename": "DashboardIconButton.js" },
-            { "lineno": 111,
+            { "lineno": 115,
               "filename": "DashboardIconButton.js" } ],
         "docs":
-          { "summary": "Sets or gets the button's link.",
+          { "summary": "Sets or gets the dashboard icon button's link.",
             "description":
-              [ "When the button is clicked, the browser navigates to the `link` location.",
+              [ "When the dasboard icon button is clicked, the browser navigates to the `link` location.",
+                "",
                 "You can set `link` to any of the following:",
+                "",
                 "+ `/localPageURL`: another page on your site",
                 "+ `/`: your site's home page",
                 "+ `http(s)://<url>`: an external web address",
@@ -134,119 +139,131 @@
                 "contains the value of a field in your collection with spaces",
                 "has its spaces replaced with dashes (`-`).",
                 "",
-                "> **Note:** Make sure to set your button link before running (and not inside) the [`onClick()`](https://www.wix.com/velo/reference/$w/button/onclick) event handler." ],
+                "> **Note:** Make sure to set your button link before running (and not inside) the [`onClick()`](https://www.wix.com/velo/reference/$w/dashboardiconbutton/onclick) event handler." ],
             "links":
               [ "[target](#target)" ],
             "examples":
-              [ { "title": "Get the URL a button navigates to",
+              [ { "title": "Get the URL a dashboard icon button navigates to",
                   "body":
                     [ "let link = $w('#myElement').link; // https://wix.com" ],
                   "extra":
                     {  } },
-                { "title": "Set button to open your site home page",
+                { "title": "Set the dashboard icon button to open your site home page",
                   "body":
                     [ "$w('#myElement').link = \"/\";" ],
                   "extra":
                     {  } },
-                { "title": "Set button to open an external link",
+                { "title": "Set the dashboard icon button to open an external web link in a new browser page when clicked",
                   "body":
-                    [ "$w('#myElement').link = \"https://wix.com\";" ],
+                    [ "$w('#myElement').link = \"http://wix.com\";",
+                      "$w('#myElement').target = \"_blank\";" ],
                   "extra":
                     {  } },
-                { "title": "Set button to open an external web link in a new browser page when clicked",
+                { "title": "Set the dashboard icon button to open a document",
                   "body":
-                    [ "$w(\"#myElement\").link = \"http://wix.com\";",
-                      "$w(\"#myElement\").target = \"_blank\";" ],
+                    [ "$w('#myElement').link = \"wix:document://v1/9bec_52fb06ea/filename.xls\";" ],
                   "extra":
                     {  } },
-                { "title": "Set button to open a document",
+                { "title": "Set the dashboard icon button to open a new email window",
                   "body":
-                    [ "$w(\"#myElement\").link = \"wix:document://v1/9bec_52fb06ea/filename.xls\";" ],
+                    [ "$w('#myElement').link = \"mailto:[email protected]?subject=Some%20Topic\";" ],
                   "extra":
                     {  } },
-                { "title": "Set button to open a new email window",
+                { "title": "Set the dashboard icon button to make a phone call when clicked",
                   "body":
-                    [ "$w('#myElement').link = \"mailto:[email protected]?subject=Some%20Topic\";" ],
+                    [ "$w('#myElement').link = \"tel:+1-555-555-5555\";" ],
                   "extra":
                     {  } },
-                { "title": "Set button to make a phone call on click",
+                { "title": "Disable a dashboard icon button's target",
                   "body":
-                    [ "$w('#myElement').link = \"tel:+1-555-555-5555\";" ],
+                    [ "$w('#myElement').link = null; // Disable the button's link property" ],
                   "extra":
                     {  } } ],
             "extra":
               {  } },
         "extra":
           {  } },
       { "name": "target",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": true,
-        "type": "string",
+        "type":
+          [ "string",
+            "null" ],
         "defaultValue": "\"_blank\"",
         "locations":
-          [ { "lineno": 118,
+          [ { "lineno": 122,
               "filename": "DashboardIconButton.js" },
-            { "lineno": 138,
+            { "lineno": 146,
               "filename": "DashboardIconButton.js" } ],
         "docs":
-          { "summary": "Sets or gets the icon button's target.",
+          { "summary": "Sets or gets the target of the dashboard icon button's link.",
             "description":
-              [ "Setting `target` determines whether the link opens in",
-                "the current page or a new tab or window. Supported values are:",
+              [ "An element's `target` determines where its [link](#link) opens. The",
+                " target can be set so the [link](#link) opens in the current page or",
+                " in a new page.",
                 "",
-                "+ `\"_blank`\": The link opens in a new tab or window.",
-                "+ `\"_self\"`: The link opens in the same tab or window.",
+                " Supported values are:",
                 "",
-                "Any other string value will cause the code to throw an error." ],
-            "links": [],
+                " + `\"_blank\"`: The link opens in a new tab or window.",
+                " + `\"_self\"`: The link opens in the tab or window.",
+                " + `null`: Resets the `target` property to its default value." ],
+            "links":
+              [ "[target](#target)" ],
             "examples":
-              [ { "title": "Get a button's target",
+              [ { "title": "Get the button's current target",
                   "body":
-                    [ "let target = $w(\"#myElement\").target; // \"_blank\"" ],
+                    [ "let target = $w('#myElement').target; // \"_blank\"" ],
                   "extra":
                     {  } },
-                { "title": "Set a button's target",
+                { "title": "Set the button's target",
                   "body":
-                    [ "$w(\"#myElement\").target = \"_self\";" ],
+                    [ "$w('#myElement').target = \"_self\";" ],
                   "extra":
                     {  } },
-                { "title": "Set button to open an external web link in a new browser page when clicked",
+                { "title": "Reset the button's target",
                   "body":
-                    [ "$w(\"#myElement\").link = \"http://wix.com\";",
-                      "$w(\"#myElement\").target = \"_blank\";" ],
+                    [ "$w('#myElement').target = null; // Resets the target property to its default value of \"_blank\"" ],
                   "extra":
                     {  } } ],
             "extra":
               {  } },
         "extra":
           {  } },
       { "name": "tooltip",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "get": true,
         "set": true,
         "type": "string",
         "locations":
           [ { "lineno": 21,
               "filename": "DashboardIconButton.js" },
-            { "lineno": 36,
+            { "lineno": 38,
               "filename": "DashboardIconButton.js" } ],
         "docs":
-          { "summary": "Sets or gets an element's tooltip.",
+          { "summary": "Sets or gets the dashboard icon button's tooltip content.",
             "description":
-              [ "Setting the `tooltip` property defines the text that is displayed when a user hovers over the icon button.",
+              [ "Setting the `tooltip` property defines the text that is displayed when a visitor hovers over the button.",
+                "Set `tooltip` to `null` to disable. ",
                 "",
-                " The tooltip text can have a maximum length of 1200 characters." ],
+                "Max: 1200 characters" ],
             "links": [],
             "examples":
-              [ { "title": "Get an element's tooltip",
+              [ { "title": "Get the dashboard icon button's tooltip",
+                  "body":
+                    [ "let tooltip = $w('#myElement').tooltip; // \"Submit your information here\"" ],
+                  "extra":
+                    {  } },
+                { "title": "Set the dashboard icon button's tooltip",
                   "body":
-                    [ "let tooltip = $w(\"#myElement\").tooltip; // \"Submit your information here\"" ],
+                    [ "$w('#myElement').tooltip = \"Submit your information here\";" ],
                   "extra":
                     {  } },
-                { "title": "Set an element's tooltip",
+                { "title": "Disable the dashboard icon button's tooltip",
                   "body":
-                    [ "$w(\"#myElement\").tooltip = \"Submit your information here\";" ],
+                    [ "$w('#myElement').tooltip = null; // Disables the tooltip" ],
                   "extra":
                     {  } } ],
             "extra":