Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/quiet-images-curve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/ui-extensions': patch
---

Document the `borderRadius` prop on the POS `s-image` component.
30 changes: 30 additions & 0 deletions packages/ui-extensions/src/surfaces/point-of-sale/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4172,6 +4172,21 @@ declare module 'preact' {

declare const tagName$q = 's-image';
interface ImageJSXProps extends Pick<ImageProps, 'id' | 'objectFit' | 'alt'> {
/**
* The border radius for the image corners.
*
* Supports one to four flow-relative values in this order:
*
* - One value applies to all corners.
* - Two values apply to `start-start` and `end-end`, then `inline-end` and `inline-start`.
* - Three values apply to `start-start`, both inline corners, and `end-end`.
* - Four values apply to `start-start`, `inline-end`, `end-end`, and `inline-start`.
*
* Use values from `small-500` through `large-500`, `base`, `max`, or `none`.
*
* @default 'none'
*/
borderRadius?: MaybeAllValuesShorthandProperty<BorderRadiusKeyword>;
/**
* The displayed inline width of the image.
*
Expand Down Expand Up @@ -7070,6 +7085,21 @@ interface TimePicker {
* @publicDocs
*/
interface Image {
/**
* The border radius for the image corners.
*
* Supports one to four flow-relative values in this order:
*
* - One value applies to all corners.
* - Two values apply to `start-start` and `end-end`, then `inline-end` and `inline-start`.
* - Three values apply to `start-start`, both inline corners, and `end-end`.
* - Four values apply to `start-start`, `inline-end`, `end-end`, and `inline-start`.
*
* Use values from `small-500` through `large-500`, `base`, `max`, or `none`.
*
* @default 'none'
*/
borderRadius?: MaybeAllValuesShorthandProperty<BorderRadiusKeyword>;
/**
* The displayed inline width of the image.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@
/* eslint-disable import-x/namespace */
// eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
/// <reference lib="DOM" />
import type {ImageProps, Key, Ref} from './components-shared.d.ts';
import type {
BorderRadiusKeyword,
ImageProps,
Key,
MaybeAllValuesShorthandProperty,
Ref,
} from './components-shared.d.ts';

/** @publicDocs */
export type ComponentChildren = any;
Expand Down Expand Up @@ -47,6 +53,21 @@ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T & HTML
declare const tagName = 's-image';
/** @publicDocs */
export interface ImageJSXProps extends Pick<ImageProps, 'id' | 'objectFit'> {
/**
* The border radius for the image corners.
*
* Supports one to four flow-relative values in this order:
*
* - One value applies to all corners.
* - Two values apply to `start-start` and `end-end`, then `inline-end` and `inline-start`.
* - Three values apply to `start-start`, both inline corners, and `end-end`.
* - Four values apply to `start-start`, `inline-end`, `end-end`, and `inline-start`.
*
* Use values from `small-500` through `large-500`, `base`, `max`, or `none`.
*
* @default 'none'
*/
borderRadius?: MaybeAllValuesShorthandProperty<BorderRadiusKeyword>;
/**
* Controls the displayed width of the image. Choose based on your layout requirements. For mobile interfaces, consider using `'fill'` with defined container dimensions to ensure consistent image display, as dynamic container heights can cause layout inconsistencies in scrollable views.
*
Expand Down
Loading