Skip to content

docs: clarify Divider, ClipboardItem, and Avatar prop limitations (2026-07-rc)#4465

Open
SteveSill wants to merge 1 commit into
2026-07-rcfrom
cleanup-jsdoc-3-components-followup-2026-07-rc
Open

docs: clarify Divider, ClipboardItem, and Avatar prop limitations (2026-07-rc)#4465
SteveSill wants to merge 1 commit into
2026-07-rcfrom
cleanup-jsdoc-3-components-followup-2026-07-rc

Conversation

@SteveSill
Copy link
Copy Markdown
Contributor

@SteveSill SteveSill commented May 14, 2026 •
edited
Loading

Companion to shopify-dev cleanup shop/world#723308, which removes ## Limitations content from .mdx pages following the framework merged in #669910.

Three of those bullets are property-level behavior that belongs on the auto-generated property table, not in a separate doc section. Adding the JSDoc here ensures the regen automation (areas-platforms-shopify-dev-checkout-ui-extensions-apis-regen-automation.yml) carries the constraints into shopify-dev when it next runs against this branch.

Sister PRs (one per active version): #4462, #4463, #4464, #4465. Manual checkout-web override (so the alt docs build path doesn't revert these): shop/world#723563.

@SteveSill
Clarify Divider, ClipboardItem, and Avatar prop limitations
5e32120 
Add JSDoc clarifications uncovered while cleaning up Limitations sections in
shopify-dev component docs:

- ClipboardItemProps.text: rich text, HTML, and binary content aren't supported
- DividerProps.direction (block): requires a parent with a defined height to render visibly
- Avatar.initials (customer-account): characters beyond the first two might be truncated;
  special characters, emojis, and non-Latin scripts might not render as expected

Companion to shopify-dev follow-up PR #723308.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 14, 2026

🚨🚨🚨 Docs migration in progress 🚨🚨🚨

We are actively migrating UI extension reference docs to MDX in the areas/platforms/shopify-dev zone of the monorepo. This impacts docs for the following surfaces:

During this migration, please be aware of the following:

.doc.ts files are being deprecated. Changes to .doc.ts files in this repo will not be reflected in the new MDX-based docs. If you need to update docs for a reference that has already been migrated, make your changes directly in the areas/platforms/shopify-dev zone of the monorepo instead.

Doc comments in .ts source files (the comment blocks above types and functions) are also affected. Generating docs from these comments currently requires a newer version of the @shopify/generate-docs library that isn't yet available. Updates to doc comments may not produce the expected output until the migration is complete.

Examples that previously lived in this repo are being moved to the areas/platforms/shopify-dev zone of the monorepo and should be authored there going forward.

What should I do?

  • If your PR includes changes to .doc.ts files, doc comments, or examples, please reach out to us in #devtools-proj-templated-refs so we can help ensure your updates are captured correctly.
  • If your PR is limited to source code changes (non-docs), you can ignore this notice.

Thanks for your patience while we complete the migration! 🙏

This was referenced May 14, 2026
Open
Open
Open
@SteveSill SteveSill force-pushed the cleanup-jsdoc-3-components-followup-2026-07-rc branch from 3c75802 to 5e32120 Compare May 14, 2026 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sordaz00 sordaz00 sordaz00 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@SteveSill @sordaz00