Added examples to admin Actions components #3387
Open
+1,694
−8
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
This PR adds comprehensive component examples to the Admin UI Extensions documentation for all components in the Actions category. 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
Actions Category (6 components, 49 examples total):
Button (14 examples):
ButtonGroup (6 examples + 1 updated):
Clickable (6 examples):
ClickableChip (5 examples):
Link (11 examples):
Menu (6 examples):
Technical Changes
.doc.ts
files for all 6 Actions componentsdefault.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/actions/
Verify the newly added examples are displayed correctly for each component:
Test that existing
default.html
examples still work as expectedQuality Assurance
Checklist