update readme for 2026-01-rc (#3517)#4229
Closed
janezhu918 wants to merge 333 commits into2025-10from
Closed
Conversation
Part of Part of shop/issues-retail#21459 [Companion shopify-dev PR](https://app.graphite.com/github/pr/Shopify/shopify-dev/65897/Update-POS-UI-Extension-storage-api-limitation-docs) ### Background Add back missing limitations & add additional detail on inactivity bullet for 2026-01 storage api docs.
Resolves shop/issues-retail#21304 ### Background This PR refines the TypeScript definitions for the TextArea component in the Point of Sale UI extensions. ### Solution This change streamlines the type definitions by: - Removing the `accessory` prop from the `TextAreaJSXProps` interface These changes make the type definitions more maintainable while preserving type safety. ### 🎩 - Verified that existing components using TextArea still compile correctly - Confirmed that the type definitions work as expected in the Point of Sale surface ### Checklist - [ ] I have 🎩'd these changes - [ ] I have updated relevant documentation
Fixes [#21438](shop/issues-retail#21438) ### Background - Removed the `accessory` prop which was not being used in the component 🎩 - Verified that existing components using EmailField still behaves correctly ### Checklist - [x] I have 🎩'd these changes - [ ] I have updated relevant documentation [will raise a separate PR for this]
Fixes [#21545](shop/issues-retail#21545) ### Background This PR removes the accessory slot feature from the EmailField component documentation and examples. ### Solution The changes include: - Removing the "Slots" section from the component documentation - Removing the "Limitations" section that described constraints for the accessory slot - Updating the examples description to focus only on handling email input events - Deleting the `accessory-slot.jsx` example file that demonstrated how to use buttons in the accessory slot ### 🎩 - Before change (Original): https://shopify.dev/docs/api/pos-ui-extensions/2026-01-rc/polaris-web-components/forms/emailfield - After change: https://pr-65965.shopify-dev.shopify.io/docs/api/pos-ui-extensions/2026-01-rc/polaris-web-components/forms/emailfield ### Checklist - [x] I have 🎩'd these changes - [x] I have updated relevant documentation --- **Screenshots**: 
Partially resolves issue shop/issues-retail#21021 ### Background PR deletes old tutorial code examples. The new tutorial code has been updated and moved to: - https://github.com/Shopify/pos-ui-extensions-tutorials/tree/main/example-pos-ui-extensions--discounts--preact - https://github.com/Shopify/pos-ui-extensions-tutorials/tree/main/example-pos-ui-extensions--printer--preact ### Solution - Corresponding code references have been updated in the Shopify Dev Docs with the new tutorial links - Deleting these MDX code examples as they are no longer used anywhere ### 🎩 - Verify there are no broken code examples in the code references for - https://shopify.dev/docs/apps/build/pos/build-discount-extension - https://shopify.dev/docs/apps/build/pos/build-print-extension <img width="500" alt="image" src="https://github.com/user-attachments/assets/66b8792e-354c-4644-a6eb-f05027f818b1" /> ### Checklist - [x] I have 🎩'd these changes - [x] I have updated relevant documentation
Co-authored-by: andy-chhuon <andy.chhuon@shopify.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Add OIDC to rc branch
bump node version
Version Packages (2026-01-rc) (rc)
Fix rc tag publish script
…te-PWC-docs Update 2026-01 PWC docs
…r/removeEventListener methods to the POS Navigation API
#3606) ### Background Adding navigation api event listener interfaces and functions 2026-01
…emptystate-docs Add EmptyState docs
Made-with: Cursor
Remove Polaris branding from Customer Account UI Extensions docs
…d URL slugs Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…026-04-rc Rename Polaris web components to Web components
…4140) * Use 'web components' terminology * Update categories
…ilename Rename localization-order-status.doc.ts for correct alphabetical sorting
…rting Made-with: Cursor
…lename Rename to orderstatus-localization.doc.ts for correct alphabetical sorting
) * Remove `ui` from StandardApi in checkout UI extensions The `ui` property (which only exposed `overlay.close`) no longer works for closing modals starting with API version 2025-10. This removes it from the types and associated doc references. Corresponding world PR: shop/world#502645 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Remove `ui` reference from checkout test factories Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ItemsRemoved fields to ReprintReceiptData to support reprinting return and exchange receipts.
…ItemsRemoved fields to ReprintReceiptData to support reprinting return and exchange receipts. (#4178) ### Background This pull request enhances the `ReprintReceiptData` interface to support reprinting receipts for return and exchange transactions in addition to the existing sale transaction support. ### Solution Extended the `ReprintReceiptData` interface with five new optional fields: - `refundId`: Tracks refund ID when a refund was issued for the return - `returnId`: Identifies the completed return transaction - `exchangeId`: Links the return to an exchange transaction when applicable - `lineItemsAdded`: Captures items added to the customer during an exchange - `lineItemsRemoved`: Captures items removed from the customer during an exchange These fields are optional to maintain backward compatibility with existing sale transaction reprints while enabling comprehensive support for return and exchange receipt reprinting scenarios. ### 🎩 - Added optional `refundId`, `returnId`, and `exchangeId` fields to track transaction relationships - Added `lineItemsAdded` and `lineItemsRemoved` arrays to support exchange transaction details - Updated documentation comments to reflect broader transaction type support - Imported `LineItem` type to support the new exchange-related fields ### Checklist - [x] I have 🎩'd these changes - [x] I have updated relevant documentation
Version Packages (2026-04-rc) (rc)
…ions-skills-2026-04-rc
…-04-rc Add doc validation skills for ui-extensions
Fix stale ui-extensions:universal references
…PIs descriptions and examples (#4195) * Account and Order APIs: description improvements and examples for 2026-04-rc Improve property descriptions, add best practices and limitations, create code examples for all 18 Account and Order APIs, and generate documentation for the 2026-04-rc version of Customer Account UI extensions. Made-with: Cursor * Generate docs
docs(admin-extensions): migrate static pages to MDX and update build process
Contributor
🚨🚨🚨 Docs migration in progress 🚨🚨🚨We are actively migrating UI extension reference docs to MDX in the
During this migration, please be aware of the following:
Doc comments in Examples that previously lived in this repo are being moved to the What should I do?
Thanks for your patience while we complete the migration! 🙏 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
20 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
(Provide a link to any relevant issues AND provide a TLDR of the issue in this pull request)
Solution
(Describe your solution, why this approach was chosen, and what the alternatives/impacts may be)
🎩
Checklist