@shopify/ui-extensions
Advanced tools
Comparing version 0.0.0-unstable-20230726192654 to 0.0.0-unstable-20230802142526
{ | ||
"name": "@shopify/ui-extensions", | ||
"version": "0.0.0-unstable-20230726192654", | ||
"version": "0.0.0-unstable-20230802142526", | ||
"scripts": { | ||
@@ -5,0 +5,0 @@ "docs:admin": "sh ./docs/surfaces/admin/build-docs.sh \"admin\"", |
# `@shopify/ui-extensions` | ||
This package contains the public type definitions and utilities needed to create a Shopify UI extension. This is a generalized package that is intended to be the long-term home of the surface-specific UI extension packages, like [`@shopify/checkout-ui-extensions`](https://github.com/Shopify/ui-extensions/tree/main/packages/checkout-ui-extensions) and [`@shopify/admin-ui-extensions`](https://github.com/Shopify/ui-extensions/tree/main/packages/admin-ui-extensions). | ||
This package contains the public type definitions and utilities needed to create a Shopify UI extension. It includes UI extension APIs for the following Shopify-controlled surfaces: | ||
> **Is your extension currently using `@shopify/checkout-ui-extensions`?** You can learn what you need to do to upgrade to this API versioned package in the [migration guide](../../documentation/upgrade/checkout-ui-extension-api-versioning.md). | ||
- [`checkout`](./src/surfaces/checkout): the checkout surface is the area of Shopify where buyers complete their purchase. This includes the information, shipping, payment, and thank you pages. | ||
- [`customer-account`](./src/surfaces/customer-account): the customer account surface is the area of Shopify where buyers can manage their account information, view their order history, and more. | ||
- [`admin`](./src/surfaces/admin): the admin surface is the area of Shopify where merchants manage their store. This includes products, orders, customers, and settings pages. | ||
Currently, this package only contains the extension APIs for the [`checkout`](./src/surfaces/checkout) and [`admin`](./src/surfaces/admin) surfaces, but other Shopify surfaces will be added here soon. | ||
> **Is your extension currently using `@shopify/checkout-ui-extensions`?** You can learn what you need to do to upgrade to this API versioned package in the [migration guide](https://github.com/Shopify/ui-extensions/discussions/1161). | ||
All extensions, regardless of where they appear in Shopify, make use the same [underlying technology](../../documentation/how-extensions-work.md), and most of the same “core” components (e.g., `BlockStack`, `Button`, `TextField`, 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. | ||
All extensions, regardless of where they appear in Shopify, make use the same [underlying technology](../../documentation/how-extensions-work.md), and most of the same “core” UI components and capabilities. 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. | ||
@@ -11,0 +13,0 @@ A checkout extension using “vanilla” JavaScript would be written as follows: |
45
1357182