Skip to content

Commit 3ecd23a

Browse files
NathanJollyNathanJolly
committed
Updates for 2025-07 release
1 parent 0928780 commit 3ecd23a

File tree

1 file changed

+26
-241
lines changed
  • packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages

1 file changed

+26
-241
lines changed

‎packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts

Lines changed: 26 additions & 241 deletions
Original file line numberDiff line numberDiff line change
@@ -13,69 +13,40 @@ const data: LandingTemplateSchema = {
1313
mobileImage: '/assets/landing-pages/templated-apis/hero.png',
1414
mobileDarkImage: '/assets/landing-pages/templated-apis/hero-dark.png',
1515
sections: [
16-
{
17-
type: 'Generic',
18-
anchorLink: 'compatibility-policy',
19-
title: 'Compatibility Policy',
20-
sectionContent: '',
21-
sectionNotice: [
22-
{
23-
title: 'End of Compatibility Plan',
24-
type: 'Warning',
25-
sectionContent: `
26-
To ensure the best possible ongoing POS UI Extension development experience, starting in April 2025, we will end compatibility for versions on a one-year rolling basis. This means that POS will no longer run extensions using removed versions. This table details the end of compatibility schedule.
27-
28-
|released version|removed versions|
29-
|---:|---|
30-
|2025-04|1.0.0, 1.0.1, 1.1.2, 1.2.0, 1.3.0, 1.4.0, 1.5.1, 1.6.0, 1.7.0, 2024-04|
31-
|2025-07|2024-07|
32-
|2025-10|2024-10|
33-
|2026-01|2025-01|
34-
|2026-04|2025-04|
35-
36-
Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more information.`,
37-
},
38-
],
39-
},
4016
{
4117
type: 'Generic',
4218
anchorLink: '202507',
4319
title: '2025.07',
44-
sectionNotice: [
45-
{
46-
type: 'critical',
47-
title: 'Not yet supported',
48-
sectionContent: `This version is not yet compatible with POS. Extensions targeting this version will be rejected by POS and will not run. Please wait for a compatible POS update before deploying extensions targeting this version.`,
49-
},
50-
],
5120
sectionContent: `
52-
- Added in POS version: N/A
53-
- Removed in POS version: N/A
54-
- Release day: N/A
21+
- Added in POS version: 10.6
22+
- Release day: 07/03/2025
5523
56-
## Important Fixes
24+
## Breaking Changes
5725
58-
- Update pos.draft-order-details.block.render allowed components to \`BlockComponents\`.
59-
- Added support for a product variant id field in the \`ProductApi\` interface.
26+
- Removed the deprecated \`FormattedTextField\` component. Use the [TextField](/docs/api/pos-ui-extensions/components/textfield) component instead. It will continue to work in POS 10.6.0, but will no longer function in POS 10.7.0.
6027
61-
### Breaking Changes
28+
## Deprecations
6229
63-
- Removed the deprecated \`FormattedTextField\` component. Use the \`TextField\` component instead.
30+
- Deprecated \`'minor'\`, \`'major'\`, \`'spot'\`, \`'caption'\`, \`'badge'\` as values for the \`size\` prop in the [Icon](/docs/api/pos-ui-extensions/components/icon) component. Use \`'s'\`, \`'m'\`, \`'l'\`, \`'xl'\` instead.
31+
- Deprecated \`'arrow'\`, \`'available-at-other-locations'\`, \`'collections'\`, \`'connectivity-warning'\`, \`'delivery'\`, \`'home'\`, \`'image-placeholder'\`, \`'internet'\`, \`'menu'\`, \`'orders'\`, \`'products'\`, \`'shipment'\` as values for the \`name\` prop in the [Icon](/docs/api/pos-ui-extensions/components/icon) component. See valid values for [\`IconName\`](/docs/api/pos-ui-extensions/latest/components/icon#icon-propertydetail-name).
32+
33+
## Important Fixes
34+
35+
- Updated [pos.draft-order-details.block.render](https://shopify.dev/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-block-render) to allow the proper set of components, called \`BlockComponents\`. Previously, this target erroneously accepted \`ActionComponents\`, which are intended for targets like \`pos.draft-order-details.action.render\`.
6436
6537
### Features
6638
67-
- Added required \`posVersion\` property to \`Session\` interface.
68-
- Added optional \`currency\` property to \`Discount\` interface.
69-
- Added \`executedAt\` property to \`BaseTransactionComplete\` interface.
70-
- Added optional \`exchangeId\` and \`returnId\` property to \`ReturnTransactionData\` interface.
71-
- Added required \`variantId\` property to \`ProductApi\` interface.
72-
- Added optional \`taxLines\` property to \`ShippingLine\` interface.
73-
- Added optional \`onBlur\` handler to \`SearchBar\` component.
74-
- Added optional \`tone\` property to \`Icon\` component and expanded \`name\` and \`size\` options.
75-
- Deprecated \`'minor'\`, \`'major'\`, \`'spot'\`, \`'caption'\`, \`'badge'\` as values for the \`size\` prop in the [Icon](/docs/api/pos-ui-extensions/components/icon) component. Use \`'s'\`, \`'m'\`, \`'l'\`, \`'xl'\` instead.
76-
- Deprecated \`'arrow'\`, \`'available-at-other-locations'\`, \`'collections'\`, \`'connectivity-warning'\`, \`'delivery'\`, \`'home'\`, \`'image-placeholder'\`, \`'internet'\`, \`'menu'\`, \`'orders'\`, \`'products'\`, \`'shipment'\` as values for the \`name\` prop in the [Icon](/docs/api/pos-ui-extensions/components/icon) component. See the available icon list names in the \`name\` prop documentation.
39+
- Added required \`posVersion\` property to [Session](/docs/api/pos-ui-extensions/apis/session-api) interface.
40+
- Added optional \`currency\` property to [Discount](/docs/api/pos-ui-extensions/apis/cart-line-item-api#cartlineitemapi-propertydetail-cartlineitem) interface.
41+
- Added \`executedAt\` property to [BaseTransactionComplete](/docs/api/pos-ui-extensions/targets/receipts/pos-receipt-footer-block-render#transactioncompletewithreprintdata-propertydetail-transaction) interface.
42+
- Added optional \`exchangeId\` and \`returnId\` property to [ReturnTransactionData](/docs/api/pos-ui-extensions/targets/receipts/pos-receipt-footer-block-render#transactioncompletewithreprintdata-propertydetail-transaction) interface.
43+
- Added required \`variantId\` property to [ProductApi](/docs/api/pos-ui-extensions/apis/product-api#productapi-propertydetail-variantid) interface.
44+
- Added optional \`taxLines\` property to [ShippingLine](/docs/api/pos-ui-extensions/targets/post-transaction/pos-transaction-complete-event-observe#transactioncompletedata-propertydetail-transaction) interface.
45+
- Added optional \`onBlur\` handler to [SearchBar](/docs/api/pos-ui-extensions/components/searchbar) component.
46+
- Added optional \`tone\` property to [Icon](/docs/api/pos-ui-extensions/components/icon) component and expanded \`name\` and \`size\` options.
47+
48+
### Developer Preview
7749
78-
**Developer Preview**:
7950
- Introduced a [Storage API](/docs/api/pos-ui-extensions/apis/storage-api). The Storage API gives the UI Extension access to store data on the POS device that the extension is running on.
8051
`,
8152
},
@@ -85,8 +56,7 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
8556
title: '2025.04',
8657
sectionContent: `
8758
- Added in POS version: 9.31
88-
- Removed in POS version: N/A
89-
- Release day: N/A
59+
- Release day: 04/01/2025
9060
9161
## Important Fixes
9262
@@ -121,7 +91,6 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
12191
title: '2025.01',
12292
sectionContent: `
12393
- Added in POS version: 9.26.0
124-
- Removed in POS version: N/A
12594
- Release day: 1/6/2025
12695
12796
## Important Fixes
@@ -189,8 +158,7 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
189158
title: '2024.10.1',
190159
sectionContent: `
191160
- Added in POS version: 9.22.0
192-
- Removed in POS version: N/A
193-
- Release day: 11/11/2024.
161+
- Release day: 11/11/2024
194162
195163
## Important Fixes
196164
@@ -219,8 +187,7 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
219187
title: '2024.10',
220188
sectionContent: `
221189
- Added in POS version: 9.19.0
222-
- Removed in POS version: N/A
223-
- Release day: 10/1/2024.
190+
- Release day: 10/1/2024
224191
225192
## Important Fixes
226193
@@ -256,8 +223,7 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
256223
title: '2024.07',
257224
sectionContent: `
258225
- Added in POS version: 9.15.0
259-
- Removed in POS version: N/A
260-
- Release day: 08/14/2024.
226+
- Release day: 08/14/2024
261227
262228
## Important Fixes
263229
@@ -300,194 +266,13 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
300266
],
301267
sectionContent: `
302268
- Added in POS version: 9.11.0
303-
- Removed in POS version: 9.31.0
304-
- Release day: 06/10/2024.
269+
- Release day: 06/10/2024
305270
306271
### Features
307272
308273
- Added support for the ${TargetLink.PosPurchasePostActionMenuItemRender} and ${TargetLink.PosPurchasePostActionRender} targets.
309274
`,
310275
},
311-
{
312-
type: 'Generic',
313-
anchorLink: '170',
314-
title: '1.7.0',
315-
sectionNotice: [
316-
{
317-
sectionContent: `This is the final version using the \`retail-ui-extensions(-react)\` package. Please see the [migration guide](/docs/api/pos-ui-extensions/migrating) for more information.`,
318-
title: 'Note',
319-
type: 'Info',
320-
},
321-
],
322-
sectionContent: `
323-
- Added in POS version: 9.4.0
324-
- Removed in POS version: 9.31.0
325-
- Release day: 03/13/2024.
326-
327-
### Features
328-
329-
- Added \`discounts\` property to the [Cart](/docs/api/pos-ui-extensions/apis/cart-api) object in the Cart API.
330-
- Added \`addCartCodeDiscount\` function to the [Cart API](/docs/api/pos-ui-extensions/apis/cart-api#cartapi-propertydetail-addcartcodediscount).
331-
- Added \`removeAllDiscounts\` function to the [Cart API](/docs/api/pos-ui-extensions/apis/cart-api#cartapi-propertydetail-removealldiscounts).
332-
- Added \`listHeaderComponent\` property to the [List](/docs/api/pos-ui-extensions/components/list#list-propertydetail-listheadercomponent) component.
333-
`,
334-
},
335-
{
336-
type: 'Generic',
337-
anchorLink: '160',
338-
title: '1.6.0',
339-
sectionContent: `
340-
- Added in POS version: 9.2.0
341-
- Removed in POS version: 9.31.0
342-
- Release day: 02/15/2024.
343-
344-
### Features
345-
346-
- Added \`bannerProps\` prop to [CameraScanner](/docs/api/pos-ui-extensions/components/camerascanner#camerascanner-propertydetail-bannerprops).
347-
- Added \`fetchPaginatedProductVariantsWithProductId\` to [ProductSearch](/docs/api/pos-ui-extensions/api/productsearch-api#productsearchapi-propertydetail-fetchpaginatedproductvariantswithproductid).
348-
`,
349-
},
350-
{
351-
type: 'Generic',
352-
anchorLink: '151',
353-
title: '1.5.1',
354-
sectionContent: `
355-
- Added in POS version: 8.22.0
356-
- Removed in POS version: 9.31.0
357-
- Release day: 11/13/2023.
358-
359-
### Features
360-
361-
- Added \`isGiftCard\` prop to [lineItem](/docs/api/pos-ui-extensions/apis/cart-api) in the Cart API.
362-
- Deprecated \`DiscountType\` and introduced \`CartDiscountType\` and \`LineItemDiscountType\` in the Cart API.
363-
`,
364-
},
365-
{
366-
type: 'Generic',
367-
anchorLink: '150',
368-
title: '1.5.0',
369-
sectionContent: `
370-
- Added in POS version: 8.21.0
371-
- Removed in POS version: 9.31.0
372-
- Release day: 10/30/2023.
373-
374-
### Features
375-
376-
- Added \`bulkAddLineItemProperties\` to the [Cart API](/docs/api/pos-ui-extensions/apis/cart-api), which allows updating multiple line item properties in one call.
377-
- Added \`bulkSetLineItemDiscounts\` to the [Cart API](/docs/api/pos-ui-extensions/apis/cart-api), which allows updating multiple line item discounts in one call.
378-
`,
379-
},
380-
{
381-
type: 'Generic',
382-
anchorLink: '140',
383-
title: '1.4.0',
384-
sectionContent: `
385-
- Added in POS version: 8.18.0
386-
- Removed in POS version: 9.31.0
387-
- Release day: 9/27/2023.
388-
389-
### Features
390-
391-
- Added optional \`BadgeStatus\` prop to the [Badge component](/docs/api/pos-ui-extensions/components/badge).
392-
- Added \`isDevice\` function to the [Device API](/docs/api/pos-ui-extensions/apis/device-api).
393-
- Introduced a [\`Connectivity API\`](/docs/api/pos-ui-extensions/apis/connectivity-api). The Connectivity API gives the UI extension access to the information about the device connectivity.
394-
- Added optional \`overrideNavigateBack\` prop to the [Screen component](/docs/api/pos-ui-extensions/components/screen).`,
395-
},
396-
{
397-
type: 'Generic',
398-
anchorLink: '130',
399-
title: '1.3.0',
400-
sectionContent: `
401-
- Added in POS version: 8.15.0
402-
- Removed in POS version: 9.31.0
403-
- Release day: 8/16/2023.
404-
405-
### Features
406-
407-
Introduced the following components:
408-
409-
- [\`DatePicker\`](/docs/api/pos-ui-extensions/components/datepicker): Used to select dates.
410-
- [\`TimePicker\`](/docs/api/pos-ui-extensions/components/timepicker): Used to select times.
411-
- [\`DateField\`](/docs/api/pos-ui-extensions/components/datefield): Used to select dates using a text input.
412-
- [\`TimeField\`](/docs/api/pos-ui-extensions/components/timefield): Used to select times using a text input.
413-
- [\`TextArea\`](/docs/api/pos-ui-extensions/components/textarea): A text field to allow merchants to input or modify multiline text.
414-
- [\`NumberField\`](/docs/api/pos-ui-extensions/components/numberfield): A text field to capture numerical values.
415-
- [\`EmailField\`](/docs/api/pos-ui-extensions/components/emailfield): A text field to capture email addresses.
416-
- [\`TextField\`](/docs/api/pos-ui-extensions/components/textfield): A updated text field supporting text input.
417-
- [\`Tile component\`](/docs/api/pos-ui-extensions/components/tile): Updated to support \`badgeValue\`. The \`enabled\` and \`onPress\` properties are now optional.
418-
`,
419-
},
420-
{
421-
type: 'Generic',
422-
anchorLink: '120',
423-
title: '1.2.0',
424-
sectionContent: `
425-
- Added in POS version: 8.12.0
426-
- Removed in POS version: 9.31.0
427-
- Release day: 6/26/2023.
428-
429-
### Features
430-
431-
- Introduced a [PinPad component](/docs/api/pos-ui-extensions/components/pinpad). It can be used to authenticate or identify individuals through a standardized number pad.
432-
- Introduced [Product Search API](/docs/api/pos-ui-extensions/apis/productsearch-api). The Product Search API gives the UI Extension access to the native product search and fetching functionality of Shopify POS.
433-
- Added a function for setting an attributed staff to the cart and line items to [Cart API](/docs/api/pos-ui-extensions/api/cart-api).
434-
- The [Navigator component](/docs/api/pos-ui-extensions/components/navigator) now supports a new prop called \`initialScreenName\`. It can be used to set the name of the \`Screen\` to initialize to.
435-
- Introduced a [Device API](/docs/api/pos-ui-extensions/apis/device-api). The Device API gives the UI Extension access to the information about the device that the extension is running on.
436-
- The [List component](/docs/api/pos-ui-extensions/components/list) was updated to support \`badge\` property for \`leftSide\` image, and \`toggleSwitch\` property for \`rightSide\`.
437-
`,
438-
},
439-
{
440-
type: 'Generic',
441-
anchorLink: '112',
442-
title: '1.1.2',
443-
sectionContent: `
444-
- Added in POS version: 8.9.0
445-
- Removed in POS version: 9.31.0
446-
- Release day: 5/15/2023.
447-
448-
### Features
449-
450-
- Introduces new \`CameraScanner\` component.
451-
- Introduces new \`Scanner\` API.
452-
`,
453-
},
454-
{
455-
type: 'Generic',
456-
anchorLink: '101',
457-
title: '1.0.1',
458-
sectionContent: `
459-
- Added in POS version: 8.8.1
460-
- Removed in POS version: 9.31.0
461-
- Release day: 5/3/2023.
462-
463-
### Fixes
464-
465-
- Addresses a problem where certain published extensions could not be launched on POS.
466-
`,
467-
},
468-
{
469-
type: 'Generic',
470-
anchorLink: '100',
471-
title: '1.0.0',
472-
sectionContent: `
473-
- Added in POS version: 8.8.0
474-
- Removed in POS version: 9.31.0
475-
- Release day: 5/1/2023.
476-
477-
### Features
478-
479-
- The \`Banner\` component now can hide the action button.
480-
- The \`Stepper\` component now has \`minimumValue\`, \`maximumValue\`, and \`value\` props.
481-
482-
### Fixes
483-
484-
- An unremovable scanning icon was removed from \`SearchBar\`.
485-
- Icon sizes were adjusted for \`SearchBar\` to avoid cropping.
486-
- \`FormattedTextField\` now doesn't crash on \`currency\` value for \`inputType\`.
487-
- Removed multiple broken \`inputType\` values for \`FormattedTextField\`.
488-
- Resolved multiple path issues with the package.
489-
`,
490-
},
491276
],
492277
};
493278

0 commit comments

Comments
 (0)