CHANGELOG.md

@shopify/ui-extensions-react

2024.10.2

Patch Changes

• #2514 45f4980788fe94ba58ad9c44bbfb80294bb3ad20 Thanks @cpeddecord! - Releasing Chat into the wild, for real this time

• Updated dependencies [45f4980788fe94ba58ad9c44bbfb80294bb3ad20]:

  • @shopify/ui-extensions@2024.10.2

2024.10.1

Patch Changes

• #2482 5e847761d9e0ce2d03fb2971e132810f9696c10f Thanks @js-goupil! - Added support for Host to unmount UI Extensions

• Updated dependencies [5e847761d9e0ce2d03fb2971e132810f9696c10f]:

  • @shopify/ui-extensions@2024.10.1

2024.10.0

Minor Changes

• #2371 28edde440ceee584c71c5ac983252ca71a7f853a Thanks @shopify-github-actions-access! - Adds type property to selectedPaymentOption

• #2361 89438897001dce9058030e6ee1655747a66ec71a Thanks @oliverigor! - Add primary and secondary actions to Modal component

• #2297 7ab538090e8bcef052bfc782b31639efe89ff262 Thanks @shopify-github-actions-access! - update generate-doc version, add attributes to Icon

• #2220 9e619fca6ea4f816148c90158b46bc1db5bfbad7 Thanks @LucasLacerdaUX! - Add QRCode component

Patch Changes

• #2284 f84592931962537d345dfd68bf2a2f2396373740 Thanks @brianshen1990! - expose Switch component to customer account unstable surface

• #2356 a2d458be51a708aeac6a1879554051f98371f908 Thanks @brianshen1990! - add full page navigation api to order full page extension target

• #2347 dd8a861caba591c1087e8349e8a9bbfdc2681cb8 Thanks @brianshen1990! - Add customer-account.order.page.render target

• #2369 7ef1d9cdd37c42277e240eb660e08de54967461c Thanks @brianshen1990! - update error message for useNavigationCurrentEntry api

• Updated dependencies [21234eea51b50dfc53d3fc4962512728b4a19446, 28edde440ceee584c71c5ac983252ca71a7f853a, 89438897001dce9058030e6ee1655747a66ec71a, f84592931962537d345dfd68bf2a2f2396373740, 9347443b76210c2f9f3ce45bb488c38ec08efb6f, fd4ecf2aef0414e790a4a78ae6a9fa013acbafda, 118654e61e393c2885198ab5dafddb4cf4d62669, 4dec3851bf53f6cf289ca8c265cd13f8c123ab06, 9fe9d56d190fee5ee444ed980a5ef60106dfda12, 7ab538090e8bcef052bfc782b31639efe89ff262, a2d458be51a708aeac6a1879554051f98371f908, 8bca1a1710431083b7e98966ec76f3fe17720d5c, a8de80b0e252ebd0c529bfe88d02d2e35e2a0461, dd8a861caba591c1087e8349e8a9bbfdc2681cb8, f81712b643430dd1cbdce54b3edf0c80bc0dafe5, 7ef1d9cdd37c42277e240eb660e08de54967461c, 37620b9d47f38586c843a9c11a6de2e0461bc0dd, 9e619fca6ea4f816148c90158b46bc1db5bfbad7, 9f7ee640e434bb175b90248c29bb194f321e871a, d6ac8d4e4180eef5242719bfaffe998441be1aa9]:

  • @shopify/ui-extensions@2024.10.0

2024.4.0

Minor Changes

• #1693 5d2905b1 Thanks @elskhn! - Adds new purchase.checkout.pickup-location-option-item.render-after extension target, rendered inside each local pickup option item.

• #1781 0772c011 Thanks @jonathanhamel4! - Adds buyerJourney.steps, buyerJourney.activeStep, and their associated react hooks to the checkout surface API.

• #1673 21cb3205 Thanks @brianshen1990! - add requireLogin for CA order status api

• #1837 947b4433 Thanks @JoshuaWhite1! - add new targets for action extensions

• #1689 dd256672 Thanks @klenotiw! - Adds the new customerPrivacy and applyTrackingConsentChange APIs.

Patch Changes

• #1695 c6c4a60d Thanks @cpeddecord! - exporting FunctionSettingsError

• #1719 4dcef623 Thanks @Fionoble! - Export Paragraph in ui-extensions-react/admin

• #1860 0961c0f1 Thanks @jamesvidler! - The useDeliveryGroup() react hook in the checkout surface no longer throws an exception if the delivery group is undefined.

• #1684 48a5f605 Thanks @cpeddecord! - New Section component available to admin UI extensions.

• #1658 58026776 Thanks @brianshen1990! - Drop runExtension support for customer account ui extension

• #1685 a1b884ed Thanks @brianshen1990! - expose authenticated account related hooks

• #1679 45687187 Thanks @cpeddecord! - Adds a top-level component to admin surface

• #1678 cf51fb00 Thanks @thomas-marcucci! - Adds support for async render functions for Admin extensions

• Updated dependencies [c6c4a60d, 57ab9d90, 48a5f605, 8476dfee, e5b82886, 7d2fdcb5, 58026776, 5d2905b1, 6211f9a5, 0772c011, 21cb3205, a1b884ed, e096e9a2, 43390b05, 45687187, 02ca0b9a, 9d21ef30, 947b4433, dd256672]:

  • @shopify/ui-extensions@2024.4.0

2024.1.0

Major Changes

• #1585 70f9bdc1 Thanks @jamesvidler! - The purchase.checkout.shipping-option-list.render-before and purchase.checkout.shipping-option-list.render-after will be duplicated for possible types of delivery groups (One Time Purchase and Subscription). You can use the new target or useDeliveryGroupTarget() React hook to access the delivery group the extension is attached to.

Minor Changes

• #1515 2452a939 Thanks @rcaplanshopify! - Adds custom header and footer unified extension targets for checkout and thank you pages

• #1601 ccbb2353 Thanks @belalsj! - Add tooltip component and update Button and Text with interestTarget API

• #1472 9c836557 Thanks @sirgalleto! - Add order routing extension targets and API

• #1424 9a8dda8c Thanks @MitchLillie! - Add Badge component to admin

• #1453 63aea230 Thanks @charlesdobson! - Add Badge component to admin

• #1428 9cd7d6f9 Thanks @MitchLillie! - Add Banner component to admin

• #1430 0a8b378a Thanks @MitchLillie! - Add ChoiceList to admin

• #1431 8f82c578 Thanks @MitchLillie! - Add ProgressIndicator to admin

• #1625 29625d18 Thanks @billfienberg! - Add ColorPicker remote component

Patch Changes

• #1437 6de2fce0 Thanks @shopi-dori! - Adds the bankIdNumber to the PaymentOptionItemApi. Adds background to View, Grid, GridItem, Pressable, ScrollView, InlineStack, and BlockStack components.

• #1503 f4268b21 Thanks @anahita-m! - Removing legacy customer account extension targets

• #1473 903a62c7 Thanks @mikewilson01! - Add additional props to LWS component

• #1448 be9465df Thanks @robin-drexler! - add previously internal customer account apis to unstable

• #1458 1fb524f6 Thanks @robin-drexler! - fix policy modal handling

• #1456 9faac927 Thanks @robin-drexler! - add some missing exports to customer-account react extensions'

• #1434 b45e1b7f Thanks @mikewilson01! - Add onStatusChange callback to LoginWithShop component

• #1466 e53621b6 Thanks @mikewilson01! - Update props for LoginWithShop component

• #1496 bb30cc52 Thanks @brianshen1990! - remove deprecated fields from doc in customer account ui extensions

• #1437 4bde0584 Thanks @shopi-dori! - Adds usePaymentMethodAttributes, usePaymentMethodAttributeValues, and useApplyPaymentMethodAttributeChange React hooks.

• #1598 345ed9a0 Thanks @MitchLillie! - Deprecate summary prop for AdminBlock

• #1526 22ac2d9b Thanks @oluwatimio! - Adds a hook called useNavigationCurrentEntry that will always track and return the latest current entry for a full page customer account ui extension

• Updated dependencies [6de2fce0, f4268b21, 8f82c578, 903a62c7, 0f0e410d, 9a8dda8c, 2452a939, be9465df, 0a8b378a, f68d0d75, ccbb2353, 1fb524f6, b45e1b7f, e53621b6, 29625d18, 70f9bdc1, 9c836557, bb30cc52, cbc51b33, 345ed9a0, 9cd7d6f9]:

  • @shopify/ui-extensions@2024.1.0

2023.10.0

Major Changes

• #1296 a8e16322 Thanks @MitchLillie! - Bump @remote-ui/core and @remote-ui/react versions.

  Warning: Extensions using @shopify/ui-extensions-react must now use react ^18.0.0 or greater.

  Extensions are also expected to reconcile their own react version.

  In order to use the latest version of @shopify/ui-extensions-react, you should modify your package.json to resemble the following:

  {
    ...
    "dependencies": {
      "react": "^18.0.0",
      "@shopify/ui-extensions": "2023.10.x",
      "@shopify/ui-extensions-react": "2023.10.x",
      "react-reconciler": "0.29.0"
    },
    "devDependencies": {
      "@types/react": "^18.0.0"
    }
  }
  

Minor Changes

• #1340 a7ea6cb0 Thanks @lsit! - Add PaymentIcon component to the checkout surface

• #1351 8df8429b Thanks @jkeohan! - Add ProductThumbnail component to the checkout surface

• #1397 198d0848 Thanks @jamesvidler! - New ConsentCheckbox and ConsentPhoneField components which allow extensions to render their own consent UI, supporting the "sms-marketing" policy.

• #1397 198d0848 Thanks @jamesvidler! - Adds the useShippingOptionTarget react hook to retrieve the target shipping option.

• #1364 3437fc05 Thanks @rcaplanshopify! - Adds purchase.checkout.payment-method-list.render-before and purchase.checkout.payment-method-list.render-after extension targets, rendered above and below the payment method list.

• #1364 39553479 Thanks @rcaplanshopify! - Adds useCartlineTarget API and deprecates useTarget API.

• #1364 1dd9abf0 Thanks @rcaplanshopify! - Storage API stored data is now shared between all activated extension targets of the extension.

• #1364 39553479 Thanks @rcaplanshopify! - Includes masked identifier when submitting custom redeemable data.

• #1364 39553479 Thanks @rcaplanshopify! - Provides payment attributes to checkout extension.

• #1364 39553479 Thanks @rcaplanshopify! - Adds support for decorative color in Text and TextBlock components.

• #1364 7a65c283 Thanks @rcaplanshopify! - Adds the purchase.checkout.delivery-address.render-after static extension target which is rendered after the shipping address form elements.

• #1315 22f71433 Thanks @dnagoda! - # Add checkoutToken Api

  Extensions now have access to the checkout token (a stable id used to identify the checkout) directly through the standard api. The checkout token will match:

  • token field in WebPixel checkout payload.
  • checkout_token in the Admin REST Api Order resource

Patch Changes

• #1324 a15fc4ad Thanks @LTiger14! - Export CustomerSegmentTemplate and the props

• #1274 e198e10a Thanks @PrescilliaA! - Update CustomerSegmentTemplate prop names

• #1316 0905d719 Thanks @lihaokx! - 1. Rename point to target; 2. Update extension target names; 3, Add new types

• #1074 3e60fb40 Thanks @MitchLillie! - Rename components with Admin prefix

• #1294 1dd7a197 Thanks @PrescilliaA! - Remove CustomerSegmentationTemplate and deprecated prop names

• #1283 8a9917b2 Thanks @lihaokx! - Move customer account ui extension from main to unstable branch.

• #1279 f537b081 Thanks @PrescilliaA! - Introduces InternalCustomerSegmentTemplate component

• Updated dependencies [a7ea6cb0, 8df8429b, 198d0848, 82ba4be1, d0bd64d2, e198e10a, a8e16322, 3437fc05, 0905d719, d539b687, 39553479, 1de5d9cf, 1dd9abf0, 39553479, f4d0ea17, 39553479, 3e60fb40, fa561eed, 1dd7a197, 8a9917b2, 1be8d871, 39553479, 898ac175, 7a65c283, 22f71433, f537b081]:

  • @shopify/ui-extensions@2023.10.0

2023.7.2

Patch Changes

• #1267 dc7f7395 Thanks @robin-drexler! - fix customer-account surface build and context

• Updated dependencies [dc7f7395]:

  • @shopify/ui-extensions@2023.7.2

2023.7.1

Patch Changes

• #1249 fc0186ef Thanks @mleandres! - New useDeliveryGroup() hook and improved documentation.

• #1210 1faf52a5 Thanks @vividviolet! - Expose query API for Admin UI extensions

• Updated dependencies [fc0186ef, 1faf52a5]:

  • @shopify/ui-extensions@2023.7.1

2023.7.0

Minor Changes

• #1064 266c13c0 Thanks @Fionoble! - Added new admin components: Box, BlockStack, Checkbox, Form, InlineStack, TextArea

• #1100 c7dba7ad Thanks @jamesvidler! - Add support for reading and writing cart metafields.

• #1145 2d147efa Thanks @lemonmade! - Make @shopify/ui-extensions a peer dependency for the React library

• #1145 2d147efa Thanks @lemonmade! - Add customer-account entrypoints for order status page extensions

• #774 feaab61b Thanks @carolopolo! - Changes typing of description prop of <CustomerSegmentationTemplate/> from string to string | string[]

• #1145 2d147efa Thanks @lemonmade! - Add support for new extension target names

Patch Changes

• #1152 505582a6 Thanks @vividviolet! - Rename all extensionPoint references to extension target

2023.4.3

Patch Changes

• #1216 9052b155 Thanks @jamesvidler! - PickupLocationsApi and PickupPointsApi now return a isLocationFormVisible property as opposed to locationFormVisible. ShippingMethodDetailsApi now gurantees a target (ShippingOption) will be returned.

• Updated dependencies [9052b155]:

  • @shopify/ui-extensions@2023.4.3

2023.4.2

Patch Changes

• #1135 b6df631c Thanks @lemonmade! - Rename useExtensionData() to useExtension()

• #1135 b6df631c Thanks @lemonmade! - Allow passing target name to useApi() for type inference

• #1135 b6df631c Thanks @lemonmade! - Make @shopify/ui-extensions a peer dependency for React library

• #1135 b6df631c Thanks @lemonmade! - Allow React extensions to return asynchronous results

• Updated dependencies [b6df631c, b6df631c]:

  • @shopify/ui-extensions@2023.4.2

2023.4.1

Minor Changes

• #1100 c7dba7ad Thanks @jamesvidler! - Add support for reading and writing cart metafields.

Patch Changes

• #1117 8e11ad23 Thanks @olavoasantos! - Clean up on Admin examples and types

• #1100 c7dba7ad Thanks @jamesvidler! - Updated faker dependancies for ui-extensions-react.

• #1100 c7dba7ad Thanks @jamesvidler! - Updated the documented examples to import from the ui-extensions package.

• Updated dependencies [c7dba7ad, 8e11ad23, c7dba7ad, c7dba7ad]:

  • @shopify/ui-extensions@2023.4.1

2023.4.0

Minor Changes

• #1064 266c13c0 Thanks @Fionoble! - Added new admin components: Box, BlockStack, Checkbox, Form, InlineStack, TextArea

• #774 feaab61b Thanks @carolopolo! - Changes typing of description prop of <CustomerSegmentationTemplate/> from string to string | string[]

Patch Changes

• #1050 df9ff575 Thanks @lauramann! - Add viewMajor to source in CustomerSegmentationTemplate

• #1044 ca55a50c Thanks @olavoasantos! - Add Heading and HeadingGroup components to admin surface

• #1048 faaacfe3 Thanks @olavoasantos! - Add Button component to the Admin surface

• #806 d0e44415 Thanks @jonathanhamel4! - Moving the Segmentation TemplateCategory from the api to the CustomerSegmentationTemplate component props.

• #703 100cfeda Thanks @vividviolet! - Add Admin surface to packages

• #892 0d68e3d1 Thanks @LTiger14! - Add confettiMajor to source in CustomerSegmentationTemplate

• #1023 d250d7df Thanks @olavoasantos! - Remove legacy components on the admin surface and add components based on the unified API

• #771 2a3b4bd0 Thanks @loic-d! - Introduce dateAdded on CustomerSegmentationTemplate

• #1042 de735136 Thanks @MitchLillie! - Add AppAction component

• #1034 35a34867 Thanks @jamesvidler! - Ported latest changes from @shopify/checkout-ui-extensions package for corresponding version 2023-04.

• #1074 3e60fb40 Thanks @MitchLillie! - Rename components with Admin prefix

• #759 4e71987f Thanks @loic-d! - Introduces CustomerSegmentationTemplate component

• #1073 ad9d0f75 Thanks @jamesvidler! - Added ability to generate docs from within the repository.

• #766 0c5b0d5b Thanks @loic-d! - Introduces standardMetafieldDependencies prop on CustomerSegmentationTemplate

• #722 c4d3ef8e Thanks @vividviolet! - Call root.mount for a rendering extension point

• #822 a49cfe5d Thanks @jonathanhamel4! - Changing the dateAdded type from Date to ISO 8601 string

• #1062 aad2fb79 Thanks @lauramann! - Adds buyButtonMajor to source in CustomerSegmentationTemplate

• #1043 1db18001 Thanks @olavoasantos! - Add Text component to the Admin surface

• Updated dependencies [df9ff575, ca55a50c, faaacfe3, 266c13c0, d0e44415, 100cfeda, 0095a792, 0d68e3d1, d250d7df, 2a3b4bd0, de735136, 35a34867, 3e60fb40, 4e71987f, ad9d0f75, 3dff93ac, 0c5b0d5b, c4d3ef8e, feaab61b, a49cfe5d, aad2fb79, 1db18001]:

  • @shopify/ui-extensions@2023.4.0

2022.10.6

Patch Changes

• #717 5c2f511b Thanks @vividviolet! - Fix exports for Checkout's surface

• Updated dependencies [5c2f511b]:

  • @shopify/ui-extensions@2022.10.6

2022.10.5

Patch Changes

• #661 2bef7a10 Thanks @lemonmade! - Bring in @shopify/checkout-ui-extensions@0.22.0

• Updated dependencies [2bef7a10]:

  • @shopify/ui-extensions@2022.10.5