-
Notifications
You must be signed in to change notification settings - Fork 50
Added examples to admin Structure components (Part II) #3386
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
base: examples-structure-1
Are you sure you want to change the base?
Conversation
78b3711
to
b4302cf
Compare
7bef3ce
to
da5d217
Compare
166786c
to
8edbe54
Compare
3d4cc02
to
63e9c80
Compare
8edbe54
to
65c76cd
Compare
63e9c80
to
9b4aaa1
Compare
65c76cd
to
2f81a08
Compare
9b4aaa1
to
3987ca6
Compare
2f81a08
to
45cd0e7
Compare
3987ca6
to
41cba3b
Compare
45cd0e7
to
06e2870
Compare
<s-stack gap="base"> | ||
<!-- Level 1 section --> | ||
<s-section heading="Order details"> | ||
<s-text>Order #1234 placed on January 15, 2024</s-text> |
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.
Might be better to use s-paragraph
here (and for other block-like text content examples)
heading="Payment summary" | ||
accessibilityLabel="Order payment breakdown and totals" | ||
> | ||
<s-text>Subtotal: $42.99</s-text> |
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.
@@ -0,0 +1,5 @@ | |||
<s-page heading="Products" inline-size="base"> |
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.
This one seems to be almost identical to the "Page with heading" example. Might be good to consolidate
Screen.Recording.2025-10-01.at.10.50.24.AM.mov
tabs: [ | ||
{ | ||
code: './examples/page-with-heading.html', | ||
language: 'preview', |
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.
We might need to add a new layout here. The page examples are getting squished (maybe due to the container parent)
...i-extensions/src/surfaces/admin/components/UnorderedList/examples/store-setup-checklist.html
Outdated
Show resolved
Hide resolved
41cba3b
to
c49764f
Compare
06e2870
to
7bdb69c
Compare
7bdb69c
to
ff921ac
Compare
Background
This PR adds comprehensive component examples to the Admin UI Extensions documentation for 5 components in the Structure category (Part II). These examples were automatically parsed and imported from the existing Polaris markdown documentation.
Solution
.doc.ts
and.ab.doc.ts
files (App Bridge components)Components Updated
Structure Category - Part II (5 components, 20 examples total):
Page (4 examples):
Section (4 examples):
Stack (5 examples):
Table (5 examples + 1 updated):
UnorderedList (1 example):
Technical Changes
.doc.ts
files for 4 regular Structure components.ab.doc.ts
file for Page (App Bridge component)default.html
example files while adding new ones🎩 Testing Steps
Run the documentation build:
Navigate to shopify-dev repo and test locally at
docs/api/app-home/polaris-web-components/structure/
Verify the newly added examples are displayed correctly for each component:
Test that existing
default.html
examples still work as expectedQuality Assurance
Checklist