Skip to content

Commit 0258454

Browse files
committed
linting
1 parent 4d53488 commit 0258454

File tree

8 files changed

+13
-35
lines changed

8 files changed

+13
-35
lines changed

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,7 @@ const data: ReferenceEntityTemplateSchema = {
4141
'Retrieve the unique identifier for the device running your extension. This example accesses the device ID, enabling device-specific tracking, settings synchronization, or associating actions with specific POS terminals for audit trails and analytics.',
4242
},
4343
{
44-
codeblock: generateCodeBlockForDeviceApi(
45-
'Get the device name',
46-
'name',
47-
),
44+
codeblock: generateCodeBlockForDeviceApi('Get the device name', 'name'),
4845
description:
4946
"Retrieve the human-readable name of the device running your extension. This example accesses the device's name, which can be useful for debugging, analytics, device-specific customization, or displaying device information to staff members.",
5047
},

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ const data: ReferenceEntityTemplateSchema = {
2222
related: [],
2323
examples: {
2424
description:
25-
'Learn how to access locale information and internationalize your extension based on the merchant\'s language settings.',
25+
"Learn how to access locale information and internationalize your extension based on the merchant's language settings.",
2626
examples: [
2727
{
2828
codeblock: generateCodeBlockForLocaleApi(

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,19 @@ const data: ReferenceEntityTemplateSchema = {
4343
},
4444
{
4545
codeblock: generateCodeBlockForScannerApi(
46-
'Subscribe to scan events',
47-
'subscribable-events',
46+
'Monitor available scanner hardware',
47+
'subscribable-sources',
4848
),
4949
description:
50-
'Subscribe to scan events to process barcode and QR code data as it arrives. This example shows how to listen for scans from any available scanner source (camera, external scanner, or embedded hardware), enabling you to add products to cart, look up information, or trigger custom workflows based on scanned codes.',
50+
'Subscribe to scanner source changes to detect which scanning methods are available on the device. This example demonstrates tracking available scanner sources (camera, external, embedded) in real time, allowing you to adapt your UI and functionality based on hardware capabilities.',
5151
},
5252
{
5353
codeblock: generateCodeBlockForScannerApi(
54-
'Monitor available scanner hardware',
55-
'subscribable-sources',
54+
'Subscribe to scan events',
55+
'subscribable-events',
5656
),
5757
description:
58-
'Subscribe to scanner source changes to detect which scanning methods are available on the device. This example demonstrates tracking available scanner sources (camera, external, embedded) in real time, allowing you to adapt your UI and functionality based on hardware capabilities.',
58+
'Subscribe to scan events to process barcode and QR code data as it arrives. This example shows how to listen for scans from any available scanner source (camera, external scanner, or embedded hardware), enabling you to add products to cart, look up information, or trigger custom workflows based on scanned codes.',
5959
},
6060
],
6161
},

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/Button.doc.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ const data: ReferenceEntityTemplateSchema = {
2828
thumbnail: 'button-thumbnail.png',
2929
defaultExample: {
3030
image: 'button-default.png',
31-
codeblock: generateCodeBlockForButton(
32-
'Show a button',
33-
'default.example',
34-
),
31+
codeblock: generateCodeBlockForButton('Show a button', 'default.example'),
3532
description:
3633
'Display a button that responds to user interactions. This example shows a button that displays a toast notification when pressed, demonstrating how to handle button taps and provide immediate feedback to merchants.',
3734
},

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/Icon.doc.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,7 @@ const data: ReferenceEntityTemplateSchema = {
3636
],
3737
defaultExample: {
3838
image: 'icon-default.png',
39-
codeblock: generateCodeBlock(
40-
'Show icons',
41-
'icon',
42-
'default-example',
43-
),
39+
codeblock: generateCodeBlock('Show icons', 'icon', 'default-example'),
4440
description:
4541
'Show icons from the POS catalog to represent actions or statuses consistently. This example demonstrates rendering icons that enhance navigation, provide visual context alongside text, and maintain visual consistency across the interface with automatic scaling for different screen densities.',
4642
},

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/Image.doc.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@ const data: ReferenceEntityTemplateSchema = {
1919
related: [],
2020
defaultExample: {
2121
image: 'image-default.png',
22-
codeblock: generateCodeBlock(
23-
'Show an image',
24-
'image',
25-
'default-example',
26-
),
22+
codeblock: generateCodeBlock('Show an image', 'image', 'default-example'),
2723
description:
2824
'Show images within your extension interface with customizable presentation. This example demonstrates rendering images with proper sizing, loading states, and error handling, ideal for showcasing products, illustrating concepts, or providing visual context in POS workflows.',
2925
},

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/List.doc.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,7 @@ const data: ReferenceEntityTemplateSchema = {
2727
thumbnail: 'list-thumbnail.png',
2828
defaultExample: {
2929
image: 'list-default.png',
30-
codeblock: generateCodeBlock(
31-
'Show a list of items',
32-
'list',
33-
'products',
34-
),
30+
codeblock: generateCodeBlock('Show a list of items', 'list', 'products'),
3531
description:
3632
'Present organized information with rich content in a consistent format. This example shows how to create a List with labels, subtitles, badges, images, and interactive elements, ideal for displaying products, orders, customers, or other structured data with tap interactions.',
3733
},

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/TextField.doc.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,7 @@ const data: ReferenceEntityTemplateSchema = {
2020
thumbnail: 'text-field-thumbnail.png',
2121
defaultExample: {
2222
image: 'text-field-default.png',
23-
codeblock: generateCodeBlock(
24-
'Capture text input',
25-
'text-field',
26-
'name',
27-
),
23+
codeblock: generateCodeBlock('Capture text input', 'text-field', 'name'),
2824
description:
2925
'Collect short, free-form text information with validation support. This example shows how to implement a TextField with labels, placeholders, character limits, and error states for capturing names, references, or other single-line data in forms and data entry workflows.',
3026
},

0 commit comments

Comments
 (0)