Skip to content

Commit d450901

Browse files
committed
update examples
1 parent e1389f4 commit d450901

File tree

3 files changed

+45
-25
lines changed

3 files changed

+45
-25
lines changed

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

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,30 @@
11
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
2-
import {generateCodeBlock} from '../helpers/generateCodeBlock';
2+
import {generateJsxCodeBlock} from '../helpers/generateCodeBlock';
3+
import {TargetLink} from '../types/ExtensionTargetType';
4+
5+
const generateJsxCodeBlockForCashDrawerApi = (
6+
title: string,
7+
fileName: string,
8+
) => generateJsxCodeBlock(title, 'cash-drawer-api', fileName);
39

410
const data: ReferenceEntityTemplateSchema = {
511
name: 'Cash Drawer API',
612
description: `
7-
The Cash Drawer API is an API exposed to extensions for cash drawer functionality, specifically allowing UI extensions to control cash drawer operations.`,
13+
The Cash Drawer API is an API exposed to extensions for cash drawer functionality, specifically allowing UI extensions to control cash drawer operations.
14+
15+
#### Supporting targets
16+
- ${TargetLink.PosHomeTileRender}
17+
- ${TargetLink.PosHomeModalRender}
18+
- ${TargetLink.PosPurchasePostActionMenuItemRender}
19+
- ${TargetLink.PosPurchasePostActionRender}
20+
- ${TargetLink.PosPurchasePostBlockRender}
21+
- ${TargetLink.PosReturnPostActionMenuItemRender}
22+
- ${TargetLink.PosReturnPostActionRender}
23+
- ${TargetLink.PosReturnPostBlockRender}
24+
- ${TargetLink.PosExchangePostActionMenuItemRender}
25+
- ${TargetLink.PosExchangePostActionRender}
26+
- ${TargetLink.PosExchangePostBlockRender}
27+
`,
828
isVisualComponent: false,
929
type: 'APIs',
1030
definitions: [
@@ -20,9 +40,8 @@ The Cash Drawer API is an API exposed to extensions for cash drawer functionalit
2040
description: 'Examples of using the Cash Drawer API',
2141
examples: [
2242
{
23-
codeblock: generateCodeBlock(
24-
'Cash Drawer API',
25-
'cash-drawer-api',
43+
codeblock: generateJsxCodeBlockForCashDrawerApi(
44+
'Open the cash drawer',
2645
'default.example',
2746
),
2847
},
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import {render} from 'preact';
2+
3+
export default async () => {
4+
render(<Extension />, document.body);
5+
};
6+
7+
const Extension = () => {
8+
return (
9+
<s-page heading="Cash Drawer API">
10+
<s-scroll-box>
11+
<s-button
12+
onClick={() =>
13+
shopify.cashDrawer.open()
14+
}
15+
>
16+
Open cash drawer
17+
</s-button>
18+
</s-scroll-box>
19+
</s-page>
20+
);
21+
};

packages/ui-extensions/docs/surfaces/point-of-sale/reference/examples/cash-drawer-api/default.example.ts

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)