-
Notifications
You must be signed in to change notification settings - Fork 53
Add more pos ui extension doc examples #3592
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
7e8cc96 to
6feb16f
Compare
|
I'll need to cherry-pick this into 2026-01-rc as well |
|
We detected some changes in |
mcvinci
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for adding these new examples, @vctrchu! I've made some minor suggestions re: wording of codeblock titles.
packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/draft-order-api.doc.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/product-api.doc.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/scanner-api.doc.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/session-api.doc.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/session-api.doc.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/toast-api.doc.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/order-api.doc.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/pinpad-api.doc.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/scanner-api.doc.ts
Outdated
Show resolved
Hide resolved
6feb16f to
b8ce02c
Compare
Part of https://github.com/shop/issues-retail/issues/20825
Background
Below is a table showing the APIs with New Examples Added (7)
current-session.jsxcurrentSessionproperties (shop, user, staff, location, currency, POS version)currentSessionvsgetSessionToken()order-details.jsxnameandcustomerIdpropertiesdraft-order-details.jsxnameandcustomerIdpropertiesscanner-data-subscribe.jsxscannerDatafor scan events with history trackingsourcesandscannerDataproduct-variant.jsxidandvariantIdvalidation-with-options.jsxPinPadOptionswithonDismissedcallback for post-validation flowshow-with-duration.jsxdurationparameter not previously demonstratedBelow is the table of APIs Excluded from Additional Examples (4)
id.jsxcartLineItem) - API surface too small for meaningful second examplesubscribe.jsxcurrent) - existing example adequately covers usageid.jsxid) - API surface too small for meaningful second examplesubscribe.jsxcurrent) - existing example adequately covers usageSolution
🎩
https://pr-65216.shopify-dev.shopify.io/docs/api/pos-ui-extensions/latest/apis/draft-order-api
https://pr-65216.shopify-dev.shopify.io/docs/api/pos-ui-extensions/latest/apis/order-api
https://pr-65216.shopify-dev.shopify.io/docs/api/pos-ui-extensions/latest/apis/pinpad-api
https://pr-65216.shopify-dev.shopify.io/docs/api/pos-ui-extensions/latest/apis/product-api
https://pr-65216.shopify-dev.shopify.io/docs/api/pos-ui-extensions/latest/apis/scanner-api
https://pr-65216.shopify-dev.shopify.io/docs/api/pos-ui-extensions/latest/apis/session-api
https://pr-65216.shopify-dev.shopify.io/docs/api/pos-ui-extensions/latest/apis/toast-api
Checklist