Skip to content

Commit 99a8de6

Browse files
NathanJollyNathanJolly
authored
Merge pull request #3018 from Shopify/njo/2025-07/doc-prep
Updates for 2025-07 release
2 parents 8e96f10 + ff20649 commit 99a8de6

File tree

1 file changed

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

1 file changed

+26
-242
lines changed

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

Lines changed: 26 additions & 242 deletions
Original file line numberDiff line numberDiff line change
@@ -13,70 +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.
77-
- Deprecated \`max\` and \`min\` props in the [NumberField](/docs/api/pos-ui-extensions/components/numberfield) component. Implement validation logic instead.
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
7849
79-
**Developer Preview**:
8050
- 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.
8151
- Added support for the ${TargetLink.PosExchangePostActionMenuItemRender}, ${TargetLink.PosExchangePostActionRender}, ${TargetLink.PosExchangePostBlockRender} targets.
8252
- Added support for the ${TargetLink.PosReturnPostActionMenuItemRender}, ${TargetLink.PosReturnPostActionRender}, ${TargetLink.PosReturnPostBlockRender} targets.
@@ -88,8 +58,7 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
8858
title: '2025.04',
8959
sectionContent: `
9060
- Added in POS version: 9.31
91-
- Removed in POS version: N/A
92-
- Release day: N/A
61+
- Release day: 04/01/2025
9362
9463
## Important Fixes
9564
@@ -124,7 +93,6 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
12493
title: '2025.01',
12594
sectionContent: `
12695
- Added in POS version: 9.26.0
127-
- Removed in POS version: N/A
12896
- Release day: 1/6/2025
12997
13098
## Important Fixes
@@ -192,8 +160,7 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
192160
title: '2024.10.1',
193161
sectionContent: `
194162
- Added in POS version: 9.22.0
195-
- Removed in POS version: N/A
196-
- Release day: 11/11/2024.
163+
- Release day: 11/11/2024
197164
198165
## Important Fixes
199166
@@ -222,8 +189,7 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
222189
title: '2024.10',
223190
sectionContent: `
224191
- Added in POS version: 9.19.0
225-
- Removed in POS version: N/A
226-
- Release day: 10/1/2024.
192+
- Release day: 10/1/2024
227193
228194
## Important Fixes
229195
@@ -259,8 +225,7 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
259225
title: '2024.07',
260226
sectionContent: `
261227
- Added in POS version: 9.15.0
262-
- Removed in POS version: N/A
263-
- Release day: 08/14/2024.
228+
- Release day: 08/14/2024
264229
265230
## Important Fixes
266231
@@ -303,194 +268,13 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
303268
],
304269
sectionContent: `
305270
- Added in POS version: 9.11.0
306-
- Removed in POS version: 9.31.0
307-
- Release day: 06/10/2024.
271+
- Release day: 06/10/2024
308272
309273
### Features
310274
311275
- Added support for the ${TargetLink.PosPurchasePostActionMenuItemRender} and ${TargetLink.PosPurchasePostActionRender} targets.
312276
`,
313277
},
314-
{
315-
type: 'Generic',
316-
anchorLink: '170',
317-
title: '1.7.0',
318-
sectionNotice: [
319-
{
320-
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.`,
321-
title: 'Note',
322-
type: 'Info',
323-
},
324-
],
325-
sectionContent: `
326-
- Added in POS version: 9.4.0
327-
- Removed in POS version: 9.31.0
328-
- Release day: 03/13/2024.
329-
330-
### Features
331-
332-
- Added \`discounts\` property to the [Cart](/docs/api/pos-ui-extensions/apis/cart-api) object in the Cart API.
333-
- Added \`addCartCodeDiscount\` function to the [Cart API](/docs/api/pos-ui-extensions/apis/cart-api#cartapi-propertydetail-addcartcodediscount).
334-
- Added \`removeAllDiscounts\` function to the [Cart API](/docs/api/pos-ui-extensions/apis/cart-api#cartapi-propertydetail-removealldiscounts).
335-
- Added \`listHeaderComponent\` property to the [List](/docs/api/pos-ui-extensions/components/list#list-propertydetail-listheadercomponent) component.
336-
`,
337-
},
338-
{
339-
type: 'Generic',
340-
anchorLink: '160',
341-
title: '1.6.0',
342-
sectionContent: `
343-
- Added in POS version: 9.2.0
344-
- Removed in POS version: 9.31.0
345-
- Release day: 02/15/2024.
346-
347-
### Features
348-
349-
- Added \`bannerProps\` prop to [CameraScanner](/docs/api/pos-ui-extensions/components/camerascanner#camerascanner-propertydetail-bannerprops).
350-
- Added \`fetchPaginatedProductVariantsWithProductId\` to [ProductSearch](/docs/api/pos-ui-extensions/api/productsearch-api#productsearchapi-propertydetail-fetchpaginatedproductvariantswithproductid).
351-
`,
352-
},
353-
{
354-
type: 'Generic',
355-
anchorLink: '151',
356-
title: '1.5.1',
357-
sectionContent: `
358-
- Added in POS version: 8.22.0
359-
- Removed in POS version: 9.31.0
360-
- Release day: 11/13/2023.
361-
362-
### Features
363-
364-
- Added \`isGiftCard\` prop to [lineItem](/docs/api/pos-ui-extensions/apis/cart-api) in the Cart API.
365-
- Deprecated \`DiscountType\` and introduced \`CartDiscountType\` and \`LineItemDiscountType\` in the Cart API.
366-
`,
367-
},
368-
{
369-
type: 'Generic',
370-
anchorLink: '150',
371-
title: '1.5.0',
372-
sectionContent: `
373-
- Added in POS version: 8.21.0
374-
- Removed in POS version: 9.31.0
375-
- Release day: 10/30/2023.
376-
377-
### Features
378-
379-
- Added \`bulkAddLineItemProperties\` to the [Cart API](/docs/api/pos-ui-extensions/apis/cart-api), which allows updating multiple line item properties in one call.
380-
- Added \`bulkSetLineItemDiscounts\` to the [Cart API](/docs/api/pos-ui-extensions/apis/cart-api), which allows updating multiple line item discounts in one call.
381-
`,
382-
},
383-
{
384-
type: 'Generic',
385-
anchorLink: '140',
386-
title: '1.4.0',
387-
sectionContent: `
388-
- Added in POS version: 8.18.0
389-
- Removed in POS version: 9.31.0
390-
- Release day: 9/27/2023.
391-
392-
### Features
393-
394-
- Added optional \`BadgeStatus\` prop to the [Badge component](/docs/api/pos-ui-extensions/components/badge).
395-
- Added \`isDevice\` function to the [Device API](/docs/api/pos-ui-extensions/apis/device-api).
396-
- 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.
397-
- Added optional \`overrideNavigateBack\` prop to the [Screen component](/docs/api/pos-ui-extensions/components/screen).`,
398-
},
399-
{
400-
type: 'Generic',
401-
anchorLink: '130',
402-
title: '1.3.0',
403-
sectionContent: `
404-
- Added in POS version: 8.15.0
405-
- Removed in POS version: 9.31.0
406-
- Release day: 8/16/2023.
407-
408-
### Features
409-
410-
Introduced the following components:
411-
412-
- [\`DatePicker\`](/docs/api/pos-ui-extensions/components/datepicker): Used to select dates.
413-
- [\`TimePicker\`](/docs/api/pos-ui-extensions/components/timepicker): Used to select times.
414-
- [\`DateField\`](/docs/api/pos-ui-extensions/components/datefield): Used to select dates using a text input.
415-
- [\`TimeField\`](/docs/api/pos-ui-extensions/components/timefield): Used to select times using a text input.
416-
- [\`TextArea\`](/docs/api/pos-ui-extensions/components/textarea): A text field to allow merchants to input or modify multiline text.
417-
- [\`NumberField\`](/docs/api/pos-ui-extensions/components/numberfield): A text field to capture numerical values.
418-
- [\`EmailField\`](/docs/api/pos-ui-extensions/components/emailfield): A text field to capture email addresses.
419-
- [\`TextField\`](/docs/api/pos-ui-extensions/components/textfield): A updated text field supporting text input.
420-
- [\`Tile component\`](/docs/api/pos-ui-extensions/components/tile): Updated to support \`badgeValue\`. The \`enabled\` and \`onPress\` properties are now optional.
421-
`,
422-
},
423-
{
424-
type: 'Generic',
425-
anchorLink: '120',
426-
title: '1.2.0',
427-
sectionContent: `
428-
- Added in POS version: 8.12.0
429-
- Removed in POS version: 9.31.0
430-
- Release day: 6/26/2023.
431-
432-
### Features
433-
434-
- 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.
435-
- 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.
436-
- 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).
437-
- 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.
438-
- 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.
439-
- The [List component](/docs/api/pos-ui-extensions/components/list) was updated to support \`badge\` property for \`leftSide\` image, and \`toggleSwitch\` property for \`rightSide\`.
440-
`,
441-
},
442-
{
443-
type: 'Generic',
444-
anchorLink: '112',
445-
title: '1.1.2',
446-
sectionContent: `
447-
- Added in POS version: 8.9.0
448-
- Removed in POS version: 9.31.0
449-
- Release day: 5/15/2023.
450-
451-
### Features
452-
453-
- Introduces new \`CameraScanner\` component.
454-
- Introduces new \`Scanner\` API.
455-
`,
456-
},
457-
{
458-
type: 'Generic',
459-
anchorLink: '101',
460-
title: '1.0.1',
461-
sectionContent: `
462-
- Added in POS version: 8.8.1
463-
- Removed in POS version: 9.31.0
464-
- Release day: 5/3/2023.
465-
466-
### Fixes
467-
468-
- Addresses a problem where certain published extensions could not be launched on POS.
469-
`,
470-
},
471-
{
472-
type: 'Generic',
473-
anchorLink: '100',
474-
title: '1.0.0',
475-
sectionContent: `
476-
- Added in POS version: 8.8.0
477-
- Removed in POS version: 9.31.0
478-
- Release day: 5/1/2023.
479-
480-
### Features
481-
482-
- The \`Banner\` component now can hide the action button.
483-
- The \`Stepper\` component now has \`minimumValue\`, \`maximumValue\`, and \`value\` props.
484-
485-
### Fixes
486-
487-
- An unremovable scanning icon was removed from \`SearchBar\`.
488-
- Icon sizes were adjusted for \`SearchBar\` to avoid cropping.
489-
- \`FormattedTextField\` now doesn't crash on \`currency\` value for \`inputType\`.
490-
- Removed multiple broken \`inputType\` values for \`FormattedTextField\`.
491-
- Resolved multiple path issues with the package.
492-
`,
493-
},
494278
],
495279
};
496280

0 commit comments

Comments
 (0)