-
Notifications
You must be signed in to change notification settings - Fork 56
Update Typography and Content component descriptions (2026-04-rc) #4284
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,7 +27,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base | |
|
|
||
| declare const tagName = "s-heading"; | ||
| /** | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| * The element props interface for the Heading component. | ||
| * Configure the following properties on the heading component. | ||
| * @publicDocs | ||
| */ | ||
| export interface HeadingElementProps extends Pick<HeadingProps$1, 'accessibilityRole' | 'id'> { | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,12 +27,23 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base | |
|
|
||
| declare const tagName = "s-paragraph"; | ||
| /** | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The missing description is because of this issue, where some definitions aren't flowing to world. I'm surgically adding them, but they get erased every regen. https://shopify.slack.com/archives/C099RJCHAKE/p1775840928446659?thread_ts=1775663494.383649&cid=C099RJCHAKE
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for the context, @sordaz00! Just out of curiosity, is this description coming from another surface? When I did a quick search on "The semantic type and styling treatment for the paragraph content", the instance that came up in the |
||
| * The element props interface for the Paragraph component. | ||
| * Configure the following properties on the paragraph component. | ||
| * @publicDocs | ||
| */ | ||
| export interface ParagraphElementProps extends Pick<ParagraphProps$1, 'accessibilityVisibility' | 'color' | 'dir' | 'id' | 'lang' | 'tone' | 'type'> { | ||
| color?: Extract<ParagraphProps$1['color'], 'subdued' | 'base'>; | ||
| tone?: Extract<ParagraphProps$1['tone'], 'auto' | 'info' | 'success' | 'warning' | 'critical' | 'neutral' | 'custom'>; | ||
| /** | ||
| * The semantic type and styling treatment for the paragraph content. | ||
| * | ||
| * Other presentation properties on `s-paragraph` override the default styling. | ||
| * | ||
| * - `paragraph`: A semantic type that indicates the text is a structural grouping of related content. | ||
| * - `small`: A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand. | ||
| * | ||
| * @default 'paragraph' | ||
| */ | ||
| type?: Extract<ParagraphProps$1['type'], 'paragraph' | 'small'>; | ||
| } | ||
| export interface ParagraphElement extends ParagraphElementProps, Omit<HTMLElement, 'id' | 'dir' | 'lang'> { | ||
| } | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,12 +27,28 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base | |
|
|
||
| declare const tagName = "s-text"; | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| /** | ||
| * The element props interface for the Text component. | ||
| * Configure the following properties on the text component. | ||
| * @publicDocs | ||
| */ | ||
| export interface TextElementProps extends Pick<TextProps$1, 'accessibilityVisibility' | 'color' | 'dir' | 'display' | 'id' | 'lang' | 'tone' | 'type'> { | ||
| color?: Extract<TextProps$1['color'], 'subdued' | 'base'>; | ||
| tone?: Extract<TextProps$1['tone'], 'auto' | 'neutral' | 'info' | 'success' | 'warning' | 'critical' | 'custom'>; | ||
| /** | ||
| * The semantic type and styling treatment for the text content. | ||
| * | ||
| * Other presentation properties on text override the default styling. | ||
| * | ||
| * - `address`: A semantic type that indicates the text is contact information. Typically used for addresses. | ||
| * - `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant. One such use-case is discounted prices. | ||
| * - `mark`: A semantic type that indicates the text is marked or highlighted and relevant to the user's current action. | ||
| * - `emphasis`: A semantic type that indicates emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text. | ||
| * - `offset`: A semantic type that indicates an offset from the normal prose of the text. | ||
| * - `small`: A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand. | ||
| * - `strong`: A semantic type that indicates strong importance, seriousness, or urgency. | ||
| * - `generic`: No additional semantics or styling is applied. | ||
| * | ||
| * @default 'generic' | ||
| */ | ||
| type?: Extract<TextProps$1['type'], 'address' | 'redundant' | 'mark' | 'emphasis' | 'offset' | 'small' | 'strong' | 'generic'>; | ||
| } | ||
| export interface TextElement extends TextElementProps, Omit<HTMLElement, 'id' | 'dir' | 'lang'> { | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,7 +27,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement> extends Base | |
|
|
||
| declare const tagName = "s-time"; | ||
| /** | ||
| * The element props interface for the Time component. | ||
| * Configure the following properties on the time component. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| * @publicDocs | ||
| */ | ||
| export interface TimeElementProps extends Pick<TimeProps$1, 'dateTime' | 'id'> { | ||
|
|
||








There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noticed this one which can have the values reordered as well: