Skip to content

Commit 1c3edf9

Browse files
committed
Integrate feedback from Steve
1 parent ecb8f88 commit 1c3edf9

File tree

9 files changed

+29
-25
lines changed

9 files changed

+29
-25
lines changed

packages/ui-extensions/src/surfaces/admin/components/Box.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ export interface BoxProps
132132
>
133133
| Extract<RequiredBoxProps['borderWidth'], ''>;
134134
/**
135-
* Controls the visual style of the border on all sides, such as solid, dashed, or dotted.
135+
* Controls the visual style of the border on all sides (solid, dashed, auto, or none).
136136
*
137137
* When set, this overrides the style value specified in the `border` property.
138138
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box)for specifying different styles per side: one value applies to all sides,
@@ -396,7 +396,7 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
396396
*/
397397
accessor overflow: BoxProps['overflow'];
398398
/**
399-
* The padding on all sides of the Box.
399+
* The padding on all sides of the box.
400400
*/
401401
accessor padding: BoxProps['padding'];
402402
/**
@@ -405,7 +405,7 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
405405
*/
406406
accessor paddingBlock: BoxProps['paddingBlock'];
407407
/**
408-
* The block-start padding of the Box.
408+
* The padding at the top in horizontal writing modes, or at the start edge in vertical writing modes.
409409
*/
410410
accessor paddingBlockStart: BoxProps['paddingBlockStart'];
411411
/**
@@ -434,7 +434,7 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
434434
*/
435435
accessor borderWidth: BoxProps['borderWidth'];
436436
/**
437-
* Controls the visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.
437+
* Controls the visual style of the border on all sides (solid, dashed, auto, or none). When set, this overrides the style value specified in the `border` property.
438438
*/
439439
accessor borderStyle: BoxProps['borderStyle'];
440440
/**
@@ -450,7 +450,7 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
450450
*/
451451
accessor accessibilityLabel: BoxProps['accessibilityLabel'];
452452
/**
453-
* The accessibility visibility of the Box.
453+
* Controls the visibility of the box for both visual and assistive technology users. Use `hidden` to hide from screen readers or `exclusive` to hide visually but announce to screen readers.
454454
*/
455455
accessor accessibilityVisibility: BoxProps['accessibilityVisibility'];
456456
/**

packages/ui-extensions/src/surfaces/admin/components/Clickable.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ export interface BoxProps
150150
>
151151
| Extract<RequiredBoxProps['borderWidth'], ''>;
152152
/**
153-
* Controls the visual style of the border on all sides, such as solid, dashed, or dotted.
153+
* Controls the visual style of the border on all sides (solid, dashed, auto, or none).
154154
*
155155
* When set, this overrides the style value specified in the `border` property.
156156
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side.

packages/ui-extensions/src/surfaces/admin/components/Grid.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ export interface BoxProps
128128
>
129129
| Extract<RequiredBoxProps['borderWidth'], ''>;
130130
/**
131-
* Controls the visual style of the border on all sides, such as solid, dashed, or dotted.
131+
* Controls the visual style of the border on all sides (solid, dashed, auto, or none).
132132
*
133133
* When set, this overrides the style value specified in the `border` property.
134134
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side.
@@ -568,7 +568,7 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
568568
*/
569569
accessor paddingBlock: BoxProps['paddingBlock'];
570570
/**
571-
* The block-start padding of the Box.
571+
* The padding at the top in horizontal writing modes, or at the start edge in vertical writing modes.
572572
*/
573573
accessor paddingBlockStart: BoxProps['paddingBlockStart'];
574574
/**
@@ -597,7 +597,7 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
597597
*/
598598
accessor borderWidth: BoxProps['borderWidth'];
599599
/**
600-
* Controls the visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.
600+
* Controls the visual style of the border on all sides (solid, dashed, auto, or none). When set, this overrides the style value specified in the `border` property.
601601
*/
602602
accessor borderStyle: BoxProps['borderStyle'];
603603
/**

packages/ui-extensions/src/surfaces/admin/components/GridItem.d.ts

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ export interface BoxProps
131131
>
132132
| Extract<RequiredBoxProps['borderWidth'], ''>;
133133
/**
134-
* The visual style of the border (solid, dashed, dotted, or none).
134+
* The visual style of the border (solid, dashed, auto, or none).
135135
*
136136
* @default '' - meaning no override
137137
*/
@@ -423,11 +423,13 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
423423
*/
424424
accessor blockSize: BoxProps['blockSize'];
425425
/**
426-
* The minimum block size of the Box.
426+
* The minimum height of the grid item in horizontal writing modes, or minimum width in vertical writing modes.
427+
* Prevents the grid item from shrinking below this size.
427428
*/
428429
accessor minBlockSize: BoxProps['minBlockSize'];
429430
/**
430-
* The maximum block size of the Box.
431+
* The maximum height of the grid item in horizontal writing modes, or maximum width in vertical writing modes.
432+
* Prevents the grid item from growing beyond this size.
431433
*/
432434
accessor maxBlockSize: BoxProps['maxBlockSize'];
433435
/**
@@ -436,11 +438,13 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
436438
*/
437439
accessor inlineSize: BoxProps['inlineSize'];
438440
/**
439-
* The minimum inline size of the Box.
441+
* The minimum width of the grid item in horizontal writing modes, or minimum height in vertical writing modes.
442+
* Prevents the grid item from shrinking below this size.
440443
*/
441444
accessor minInlineSize: BoxProps['minInlineSize'];
442445
/**
443-
* The maximum inline size of the Box.
446+
* The maximum width of the grid item in horizontal writing modes, or maximum height in vertical writing modes.
447+
* Prevents the grid item from growing beyond this size.
444448
*/
445449
accessor maxInlineSize: BoxProps['maxInlineSize'];
446450
/**
@@ -452,11 +456,12 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
452456
*/
453457
accessor padding: BoxProps['padding'];
454458
/**
455-
* The block padding of the Box.
459+
* The vertical padding (top and bottom) in horizontal writing modes.
460+
* Use this for flow-relative padding that adapts to text direction.
456461
*/
457462
accessor paddingBlock: BoxProps['paddingBlock'];
458463
/**
459-
* The block-start padding of the Box.
464+
* The padding at the top in horizontal writing modes, or at the start edge in vertical writing modes.
460465
*/
461466
accessor paddingBlockStart: BoxProps['paddingBlockStart'];
462467
/**
@@ -477,7 +482,7 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
477482
*/
478483
accessor paddingInlineEnd: BoxProps['paddingInlineEnd'];
479484
/**
480-
* The border of the Box.
485+
* Applies a border using shorthand syntax to specify width, color, and style in a single property.
481486
*/
482487
accessor border: BoxProps['border'];
483488
/**

packages/ui-extensions/src/surfaces/admin/components/Heading.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
140140
*/
141141
declare class Heading extends PreactCustomElement implements HeadingProps {
142142
/**
143-
* The ARIA role for the heading, which determines its semantic level (`heading1` through `heading6`).
143+
* The ARIA role for the heading. Set to `'heading'` (the default) for standard heading semantics, or `'presentation'` / `'none'` to remove heading semantics for decorative use.
144144
*/
145145
accessor accessibilityRole: HeadingProps['accessibilityRole'];
146146
/**

packages/ui-extensions/src/surfaces/admin/components/Heading/Heading.doc.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,8 @@ const data: AdminReferenceEntityTemplateSchema = {
2020
title: 'Limitations',
2121
type: 'Generic' as const,
2222
anchorLink: 'limitations',
23-
sectionContent: `- Heading levels are determined automatically based on nesting depth and can't be manually overridden. The component supports up to 3-4 nesting levels (h2, h3, h4), after which all headings remain at h4.
24-
- Line clamping truncates text visually but doesn't provide a way to show the full heading text on hover or through other interactions. Truncated content might not be fully accessible to screen readers.
25-
- The component renders with heading semantics by default. To remove heading semantics for decorative use, set \`accessibilityRole\` to \`"presentation"\` or \`"none"\`.`,
23+
sectionContent: `- Heading levels (h2, h3, h4) are determined automatically based on nesting depth. You can't set a specific heading level, but you can remove heading semantics entirely by setting \`accessibilityRole\` to \`"presentation"\` or \`"none"\`.
24+
- Line clamping truncates text visually but doesn't provide a way to show the full heading text on hover or through other interactions. Truncated content might not be fully accessible to screen readers.`,
2625
},
2726
],
2827
definitions: [

packages/ui-extensions/src/surfaces/admin/components/Image.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ export interface BoxProps
166166
>
167167
| Extract<RequiredBoxProps['borderWidth'], ''>;
168168
/**
169-
* The visual style of the border (solid, dashed, dotted, or none).
169+
* The visual style of the border (solid, dashed, auto, or none).
170170
*
171171
* @default '' - meaning no override
172172
*/

packages/ui-extensions/src/surfaces/admin/components/Select/Select.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const data: AdminReferenceEntityTemplateSchema = {
1616
- **Organize options thoughtfully:** The order of options affects how quickly merchants find what they need. Group related options together, put common choices first, or use alphabetical order when no natural hierarchy exists.
1717
- **Make options scannable:** Merchants should be able to quickly distinguish between options. Include enough context in each option label so merchants don't need to open and read multiple options to find the right one.
1818
- **Handle default selections appropriately:** Pre-select an option when there's a clear default choice, but use a placeholder when merchants should make an intentional selection. Avoid confusing merchants with unclear initial states.
19-
- **Provide clear validation feedback:** When selection is required or invalid, explain what the user needs to do. Context-specific error messages help users complete forms faster than generic validation messages.`,
19+
- **Provide clear validation feedback:** When selection is required or invalid, explain what the merchant needs to do. Context-specific error messages help merchants complete forms faster than generic validation messages.`,
2020
},
2121
{
2222
title: 'Limitations',

packages/ui-extensions/src/surfaces/admin/components/Stack.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ export interface BoxProps
127127
>
128128
| Extract<RequiredBoxProps['borderWidth'], ''>;
129129
/**
130-
* Controls the visual style of the border on all sides, such as solid, dashed, or dotted.
130+
* Controls the visual style of the border on all sides (solid, dashed, auto, or none).
131131
*
132132
* When set, this overrides the style value specified in the `border` property.
133133
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side.
@@ -546,7 +546,7 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
546546
*/
547547
accessor borderWidth: BoxProps['borderWidth'];
548548
/**
549-
* Controls the visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.
549+
* Controls the visual style of the border on all sides (solid, dashed, auto, or none). When set, this overrides the style value specified in the `border` property.
550550
*/
551551
accessor borderStyle: BoxProps['borderStyle'];
552552
/**

0 commit comments

Comments
 (0)