Skip to content

Commit 78318cc

Browse files
authored
Merge pull request #3547 from Shopify/njo/pos-document-close
Document window.close() for pos ui extensions
2 parents 84e4168 + 1507667 commit 78318cc

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/navigation-api.doc.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ The Navigation API enables POS UI extension to navigate between screens.
2828
description: '',
2929
type: 'Navigation',
3030
},
31+
{
32+
title: 'Window',
33+
description: '',
34+
type: 'Window',
35+
},
3136
],
3237
category: 'APIs',
3338
related: [],

packages/ui-extensions/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,10 @@ export interface Navigation {
3535
*/
3636
back(): void;
3737
}
38+
39+
export interface Window {
40+
/**
41+
* The close() method of the window interface closes the extension screen.
42+
*/
43+
close(): void;
44+
}

0 commit comments

Comments
 (0)