Skip to content

docs: clarify Divider, ClipboardItem, and Avatar prop limitations (2026-04)#4464

Open
SteveSill wants to merge 1 commit into
2026-04from
cleanup-jsdoc-3-components-followup-2026-04
Open

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

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
Add JSDoc gaps surfaced by limitations cleanup follow-up
29bc92d 
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 (`block`) dividers require a
  parent with defined height to render. Annotated inline on the value.
- 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

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 14, 2026

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.

@github-actions github-actions Bot added the needs-rc-port PR against a stable branch awaiting forward-port to the current RC label May 14, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 14, 2026

This PR targets a stable release branch (2026-04). Once merged, the change typically also needs to be forward-ported to 2026-07-rc so it ships in the next release.

When you open the forward-port PR, include a line like this in its body so the needs-rc-port label gets removed automatically when that PR merges:

Forward-port of #4464

Accepted formats (comma-separated for multiple):

  • #4464
  • GH-4464
  • 4464
  • https://github.com/Shopify/ui-extensions/pull/4464

If a forward-port isn't needed (e.g., the change is stable-only), you can remove the needs-rc-port label manually.

This was referenced May 14, 2026
Open
Open
Open
@SteveSill SteveSill force-pushed the cleanup-jsdoc-3-components-followup-2026-04 branch from c8af02f to 29bc92d 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

needs-rc-port PR against a stable branch awaiting forward-port to the current RC

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@SteveSill @sordaz00