Skip to content

added canNavigateToPosScreen function to Navigation API #3094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

added canNavigateToPosScreen function to Navigation API #3094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/hot-suits-marry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/ui-extensions': minor
---

Added canNavigateToPosScreen function to the Navigation API
7 changes: 7 additions & 0 deletions packages/ui-extensions/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ export interface NavigationApiContent {
* @returns A promise that resolves when the POS screen is opened, rejects when an error occurs like an unsupported GID or POS screen.
*/
open(url: string | URL): Promise<void>;

/**
* Check if a POS screen can be opened with `open` due to staff permissions and the current location's plan.
* @param url - The POS screen to check
* @returns A boolean indicating if the POS screen can be opened
*/
canOpen(url: string | URL): boolean;
}

/**
Expand Down