Skip to content

Commit 119c91e

Browse files
authored
update root readme based on remote-dom updates (#3505)
1 parent 1383559 commit 119c91e

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,16 @@
22

33
This repo contains the public definition of Shopify’s UI extension API. App developers can use these libraries for a strongly-typed, optimized development experience that lets them focus on integrating their app’s features deep into Shopify workflows. You can learn more about what is possible with UI extensions in [Shopify’s developer documentation](https://shopify.dev/api/checkout-extensions/checkout).
44

5-
> **Note:** UI extensions are a [versioned API](https://shopify.dev/api/usage/versioning). This branch contains the APIs for the `unstable` API version. The following API versions are available as separate branches in this repo: [`2023-04`](https://github.com/Shopify/ui-extensions/tree/2023-04), [`2023-07`](https://github.com/Shopify/ui-extensions/tree/2023-07)
5+
> **Note:** UI extensions are a [versioned API](https://shopify.dev/api/usage/versioning). This branch contains the APIs for the `2025-10` API version. The following API versions are available as separate branches in this repo: [`2023-04`](https://github.com/Shopify/ui-extensions/tree/2023-04), [`2023-07`](https://github.com/Shopify/ui-extensions/tree/2023-07)
66
7-
Shopify provides different “variants” of UI extension APIs that are suitable for different developers:
8-
9-
- [`@shopify/ui-extensions`](./packages/ui-extensions/) lets developers use a small, strongly-typed JavaScript API for creating UI extensions
10-
- [`@shopify/ui-extensions-react`](./packages/ui-extensions-react/) lets developers create UI extensions using [React](https://reactjs.org/), a popular JavaScript library for building user interfaces
7+
Shopify provides UI extension APIs via the [`@shopify/ui-extensions` package](./packages/ui-extensions/) which lets developers use a small, strongly-typed JavaScript API for creating UI extensions
118

129
## What are “UI extensions”?
1310

1411
A UI extension is a JavaScript-based module that can hook in to client-side behaviors on any of Shopify’s first party UI surface areas. The most minimal definition of a UI extension has the following properties, which are configured in a `shopify.extension.toml` file in your project:
1512

1613
- A `name` that is presented to merchants when interacting with the extension.
17-
- The [`target`](https://shopify.dev/docs/apps/app-extensions/configuration#targets) that the UI extension wishes to inject into. These are represented with string identifiers that describe the surface and responsibility of the extension. For example, [`purchase.checkout.cart-line-item.render-after` target](https://shopify.dev/docs/api/checkout-ui-extensions/unstable/apis/extensiontargets) gives a UI Extension the ability to render UI after the each cart line in a checkout.
14+
- The [`target`](https://shopify.dev/docs/apps/app-extensions/configuration#targets) that the UI extension wishes to inject into. These are represented with string identifiers that describe the surface and responsibility of the extension. For example, [`purchase.checkout.cart-line-item.render-after` target](https://shopify.dev/docs/api/checkout-ui-extensions/latest/targets) gives a UI Extension the ability to render UI after the each cart line in a checkout.
1815
- The JavaScript `module` in your local project that will be run to render UI.
1916

2017
The types in this package allow us to represent additional details about the targets developers can implement. Each target can have a custom set of APIs available to it, which includes:
@@ -23,3 +20,5 @@ The types in this package allow us to represent additional details about the tar
2320
- What **imperative APIs** are provided by the host application, for reading and writing data relevant to the extension
2421

2522
UI extensions are built on an open source project called, [remote-dom](https://github.com/Shopify/remote-dom), which allows them to render native UI elements while being safely sandboxed.
23+
24+
> **Note:** If you are migrating from an API version prior to `2025-10`, you can follow the [migration guide](https://shopify.dev/docs/api/checkout-ui-extensions/2025-10/upgrading-to-2025-10).

packages/ui-extensions/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ This package supports the development of UI extension for [Admin](https://shopif
66

77
All extensions, regardless of where they appear in Shopify, make use of the same [underlying technology](https://github.com/Shopify/remote-dom), and most of the same “core” components (e.g., `s-block`, `s-button`, `s-text-field`, etc) and capabilities (e.g., direct API access, session tokens). Separating APIs by surface makes it easier for a developer to see what is available to them in each context, and gives us a flexible system for introducing components and APIs available in only some areas of Shopify.
88

9+
> **Note:** If you are migrating from an API version prior to `2025-10`, you can follow the [migration guide](https://shopify.dev/docs/api/checkout-ui-extensions/2025-10/upgrading-to-2025-10).
10+
911
A checkout extension using Preact would be written as follows:
1012

1113
```ts

0 commit comments

Comments
 (0)