Versions

• Added in POS version: 10.6
• Release day: 07/03/2025

Breaking Changes

• Removed the deprecated FormattedTextField component. Use the TextField component instead. It will continue to work in POS 10.6.0, but will no longer function in POS 10.7.0.

Deprecations

• Deprecated 'minor', 'major', 'spot', 'caption', 'badge' as values for the size prop in the Icon component. Use 's', 'm', 'l', 'xl' instead.
• 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 component. See valid values for IconName.

Important Fixes

• Updated 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.
• Fixed an issue where the SearchBar component's onTextChange handler was not being called when the clear button was pressed. Available from POS 10.8.0.

Features

• Added support for Direct API access, and authenticated requests.
• Added required posVersion property to Session interface.
• Added optional currency property to Discount interface.
• Added executedAt property to BaseTransactionComplete interface.
• Added optional exchangeId and returnId property to ReturnTransactionData interface.
• Added required variantId property to ProductApi interface.
• Added optional taxLines property to ShippingLine interface.
• Added optional onBlur handler to SearchBar component.
• Added optional tone property to Icon component and expanded name and size options.
• Added optional editable property to Cart interface.
• Added useCartEditable hook to access the cart's editable state.
• Added support for the pos.cart.line-item-details.action.menu-item.render and pos.cart.line-item-details.action.render targets on the cart line item details screen.
• Added optional editable property to Cart interface.
• Added useCartEditable hook to access the cart's editable state.
• Added support for the pos.cart.line-item-details.action.menu-item.render and pos.cart.line-item-details.action.render targets on the cart line item details screen.
• Introduced a Storage API. The Storage API gives the UI Extension access to store data on the POS device that the extension is running on.

Developer Preview

• Added support for the pos.exchange.post.action.menu-item.render, pos.exchange.post.action.render, pos.exchange.post.block.render targets.
• Added support for the pos.return.post.action.menu-item.render, pos.return.post.action.render, pos.return.post.block.render targets.

• Added in POS version: 9.31
• Release day: 04/01/2025

Important Fixes

• POS 10.3.0:

  • Fixed an issue where the TextField component failed to apply the maxLength parameter.

• POS 10.2.0:

  • Fixed a sizing issue with the Button component.
  • Fixed an issue where the Section component was displaying a divider between child components.

• POS 10.0.0:

  • Removed email, firstName, lastName, and note from the Customer object.
  • POS UI Extensions components automatically use our new POS visual design language.

Features

Developer Preview:

• Added support for the pos.transaction-complete.event.observe target.
• Added support for cash tracking session. pos.cash-tracking-session-start.event.observe, pos.cash-tracking-session-complete.event.observe targets.
• Added support for the pos.cart-update.event.observe target.
• Added support for the pos.receipt-footer.block.render target.
• Introduced a POSReceiptBlock component. It's the required parent component for pos.receipt-footer.block.render targets.
• Introduced a QRCode component. It can be used to render a QR code in POS receipts but must be within a POSReceiptBlock component.

• Added in POS version: 9.26.0
• Release day: 1/6/2025

Important Fixes

• POS 10.3.0:

  • Fixed an issue where the TextField component failed to apply the maxLength parameter.

• POS 10.2.0:

  • Fixed a sizing issue with the Button component.
  • Fixed an issue where the Section component was displaying a divider between child components.

• POS 10.0.0:

  • Removed email, firstName, lastName, and note from the Customer object.
  • POS UI Extensions components automatically use our new POS visual design language.

• POS 9.31.0:

  • Modal updated so neither swiping down nor tapping outside of modal will dismiss modal.

• POS 9.29.0:

  • Fixed an issue where the FormattedTextField component was rendering black input text in dark mode.

• POS 9.27.0:

  • Fixed an issue where the Stack component was not rendering correctly. By default, Stack will now always wrap. Additionally, stacks using 'block' will now compress horizontally. Use alignContents: 'stretch' to take all of the horizontal space. This will not have an impact on layout in previous POS versions.

Breaking Changes

• Removed the deprecated ActionItem component. Use a Button instead.
• Removed the deprecated SmartGridApi. Use the ActionApi instead.
• Removed the deprecated DiscountType. Use CartDiscountType and LineItemDiscountType instead.
• Removed the deprecated badge prop from the List component. Use badges instead.
• Removed the deprecated TextFieldProps type from the TextField component.
• Deprecated 'vertical' and 'horizontal' as values for the direction field in the Stack component. Use 'block' and 'inline' instead.
• Deprecated the flex field in the Stack component. Set blockSize or inlineSize to a value other than 'auto' to create the desired size for your Stack.
• Deprecated the flexWrap field in the Stack component. Content will now wrap automatically.
• Deprecated the paddingHorizontal and paddingVertical fields in the Stack component. Use paddingInline and paddingBlock instead.
• Removed customValidator prop from the FormattedTextField component.
• Removed email, firstName, lastName, and note from the Customer object.
• Text now takes priority in growing over other components. To contain Text to its minimum width, wrap it in a Box component.

Features

• Added PrintApi and a PrintPreview component.
• Added currency prop to the SessionApi.
• Cart API updates:
  • Added bulkUpdateCart function for single-operation cart updates.
  • The addLineItem and addCustomSale functions now return a UUID for the added line item.
• Added Box component.
• Added a new justifyContent prop to Stack component. The default value is 'start'.
• Added a new alignContents prop to Stack component. The default value is 'start'. By default, 'block' stacks may compress horizontally. Use 'stretch' to take all of the horizontal space.
• Added a new alignItems prop to Stack component. The default value is 'stretch'. This may by default cause certain elements to stretch.
• Added a new blockSize prop to Stack component. This will allow setting a vertical size for the stack.
• Added a new inlineSize prop to Stack component. This will allow setting a horizontal size for the stack.
• Added sizing and fill options to the Image component.

• Added in POS version: 9.22.0
• Release day: 11/11/2024

Important Fixes

• POS 10.3.0:

  • Fixed an issue where the TextField component failed to apply the maxLength parameter.

• POS 10.2.0:

  • Fixed a sizing issue with the Button component.
  • Fixed an issue where the Section component was displaying a divider between child components.

• POS 10.0.0:

  • Removed email, firstName, lastName, and note from the Customer object.
  • POS UI Extensions components automatically use our new POS visual design language.

Features

• Fixes long standing issue where useEffect teardown functions are not working in React

• Added in POS version: 9.19.0
• Release day: 10/1/2024

Important Fixes

• POS 10.3.0:

  • Fixed an issue where the TextField component failed to apply the maxLength parameter.

• POS 10.2.0:

  • Fixed a sizing issue with the Button component.
  • Fixed an issue where the Section component was displaying a divider between child components.

• POS 10.0.0:

  • Removed email, firstName, lastName, and note from the Customer object.

Features

• Added support for iOS debugging with the Safari dev tools.
• On iOS, modals now appear in windowed mode.
• Introduced a POSBlock component. It's the required parent component for block extension targets.
• Introduced a POSBlockRow component. It's the required child component for POSBlock, and can be used to wrap other components.
• Added support for the pos.product-details.block.render target.
• Added support for the pos.purchase.post.block.render target.
• Added support for the pos.order-details.block.render target.
• Added support for the pos.customer-details.block.render target.
• Deprecated the ActionItem component. Please use the Button component instead.

• Added in POS version: 9.15.0
• Release day: 08/14/2024

Important Fixes

• POS 10.3.0:

  • Fixed an issue where the TextField component failed to apply the maxLength parameter.

• POS 10.2.0:

  • Fixed a sizing issue with the Button component.
  • Fixed an issue where the Section component was displaying a divider between child components.

• POS 10.0.0:

  • Removed email, firstName, lastName, and note from the Customer object.
  • POS UI Extensions components automatically use our new POS visual design language.

Features

• Introduced a SectionHeader component. It can be used to title sections and structure content.
• Removed subtitle property to the FormattedTextField component.
• Removed subtitle property to the TextField component.
• Renamed the OrderAPIContent interface to OrderApiContent.
• Added support for the pos.product-details.action.menu-item.render and pos.product-details.action.render targets.
• Added support for the pos.order-details.action.menu-item.render and pos.order-details.action.render targets.
• Added support for the pos.draft-order-details.action.menu-item.render and pos.draft-order-details.action.render targets.
• Added support for the pos.customer-details.action.menu-item.render and pos.customer-details.action.render targets.

• Added in POS version: 9.11.0
• Release day: 06/10/2024

Features

• Added support for the pos.purchase.post.action.menu-item.render and pos.purchase.post.action.render targets.