Skip to content

Commit 47c1857

Browse files
authored
Merge pull request #4464 from Shopify/cleanup-jsdoc-3-components-followup-2026-04
docs: clarify Divider, ClipboardItem, and Avatar prop limitations (2026-04)
2 parents 3f865c6 + 29bc92d commit 47c1857

2 files changed

Lines changed: 5 additions & 1 deletion

File tree

packages/ui-extensions/src/surfaces/checkout/components/components-shared.d.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2005,6 +2005,8 @@ interface ClipboardItemProps$1 extends GlobalProps {
20052005
/**
20062006
* Plain text to be written to the clipboard.
20072007
*
2008+
* Rich text, HTML, and binary content aren't supported.
2009+
*
20082010
* @default ''
20092011
*/
20102012
text?: string;
@@ -2304,7 +2306,7 @@ interface DividerProps$1 extends GlobalProps {
23042306
* The orientation of the divider, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
23052307
*
23062308
* - `inline`: A horizontal divider that separates content stacked vertically.
2307-
* - `block`: A vertical divider that separates content arranged horizontally.
2309+
* - `block`: A vertical divider that separates content arranged horizontally. Requires a parent with a defined height to render visibly.
23082310
*
23092311
* @default 'inline'
23102312
*/

packages/ui-extensions/src/surfaces/customer-account/components/Avatar.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ export type CallbackEventListener<
1818
export interface AvatarElementProps extends IdProps {
1919
/**
2020
* The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as "JD" for John Doe.
21+
*
22+
* Characters beyond the first two might be truncated. Special characters, emojis, and non-Latin scripts might not render as expected.
2123
*/
2224
initials?: string;
2325

0 commit comments

Comments
 (0)