Skip to content

docs: clarify Divider, ClipboardItem, and Avatar prop limitations (2025-10)#4462

Open
SteveSill wants to merge 1 commit into
2025-10from
cleanup-jsdoc-3-components-followup-2025-10
Open

docs: clarify Divider, ClipboardItem, and Avatar prop limitations (2025-10)#4462
SteveSill wants to merge 1 commit into
2025-10from
cleanup-jsdoc-3-components-followup-2025-10

Conversation

@SteveSill
Copy link
Copy Markdown
Contributor

@SteveSill SteveSill commented May 14, 2026

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.

Adds three JSDoc additions for property/method behavior that the
shopify-dev .mdx Limitations cleanup follow-up identified as missing
from the TypeScript source:

- ClipboardItem.text — explicitly note that rich text, HTML, and binary
  content aren't supported.
- Divider.direction — note that vertical dividers require a parent with
  defined height to render.
- Avatar.initials (CA-only) — note about truncation and special-character
  rendering behavior.

Companions:

- shopify-dev follow-up .mdx PR: shop/world#723308
- Original Agent 3 .mdx PR (merged): shop/world#669910
- Multi-agent plan: shop/world#660052
@github-actions
Copy link
Copy Markdown
Contributor

🚨🚨🚨 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! 🙏

@github-actions
Copy link
Copy Markdown
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant