Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions wix-dashboard/wix-dashboard.service.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
[ "string" ] },
"doc": "Fulfilled - The URL of the dashboard page." },
"locations":
[ { "lineno": 15,
[ { "lineno": 19,
"filename": "navigation.js" } ],
"docs":
{ "summary": "Gets the full URL for a dashboard page.",
Expand All @@ -99,7 +99,8 @@
"extra":
{ } },
{ "name": "navigate",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "destination",
Expand All @@ -115,7 +116,11 @@
"description":
[ "> This function can only be used in page code files for dashboard pages created in the [Wix Editor](https://support.wix.com/en/article/velo-working-with-dashboard-pages) or with [Wix Blocks](https://support.wix.com/en/article/wix-blocks-creating-and-managing-blocks-dashboard-pages).",
"",
"If a `destination` object with an invalid `pageId` value is passed to this function, a **Page Not Found** message is displayed in the dashboard." ],
"You can identify the page to navigate to using its [page ID](#dashboard-page-ids).",
"If a `destination` object with an invalid `pageId` value is passed to this function, a **Page Not Found** message is displayed in the dashboard.",
"",
">**Note:** Currently, you can only use `navigate()` to navigate to dashboard pages created in the [Wix Dev Center](https://dev.wix.com/docs/build-apps/developer-tools/extensions/dashboard-extensions/dashboard-page#create-a-wix-dashboard) or with the [Wix CLI](https://dev.wix.com/docs/build-apps/developer-tools/cli/get-started/about-the-wix-cli-for-apps). ",
"You can't use it to navigate to pages created with [Wix Blocks](https://dev.wix.com/docs/build-apps/wix-blocks/getting-started/welcome-to-wix-blocks) or to [dashboard pages created with the Wix Editor](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/frontend-code/dashboard-admin-pages/working-with-dashboard-pages)." ],
"links": [],
"examples":
[ { "title": "Navigate to the dashboard home page",
Expand Down Expand Up @@ -170,8 +175,7 @@
"extra":
{ } },
{ "name": "onBeforeUnload",
"labels":
[ "new" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "callback",
Expand Down Expand Up @@ -514,8 +518,7 @@
"extra":
{ } },
{ "name": "onBeforeUnloadCallback",
"labels":
[ "new" ],
"labels": [],
"nameParams": [],
"params":
[ { "name": "event",
Expand Down Expand Up @@ -661,7 +664,7 @@
"labels": [] },
{ "name": "Destination",
"locations":
[ { "lineno": 30,
[ { "lineno": 34,
"filename": "navigation.js" } ],
"docs":
{ "summary": "Destination Object",
Expand All @@ -672,14 +675,15 @@
"members":
[ { "name": "pageId",
"type": "string",
"doc": "ID of the page to link to. Use the [Dashboard Page IDs](#dashboard-page-ids) table to find the appropriate ID." },
"doc": "ID of the page to link to. See [Dashboard Page IDs](#dashboard-page-ids) to find the appropriate ID." },
{ "name": "relativeUrl",
"type": "string",
"doc": "URL segment to append to the base URL of the selected page. Can include path segments, a query string, and a fragment identifier.",
"optional": true } ],
"extra":
{ },
"labels": [] },
"labels":
[ "changed" ] },
{ "name": "Document",
"locations":
[ { "lineno": 70,
Expand Down Expand Up @@ -1113,8 +1117,7 @@
"doc": "Prevents the page from unloading. Opens a dialog with a warning that there may be unsaved data on the page." } ],
"extra":
{ },
"labels":
[ "new" ] },
"labels": [] },
{ "name": "onBeforeUnloadReturn",
"locations":
[ { "lineno": 23,
Expand All @@ -1130,8 +1133,7 @@
"doc": "Removes the `onBeforeUnload` event handler." } ],
"extra":
{ },
"labels":
[ "new" ] },
"labels": [] },
{ "name": "openMediaManagerReturn",
"locations":
[ { "lineno": 37,
Expand Down