Skip to main content

Interface: ItemPreviewProps

Hierarchy​

Properties​

alt​

• Optional alt: string

alt text te be show for accessibility purposes

Defined in​

packages/ida-framework/src/features/itemPreview/ItemPreview.tsx:24


ariaLabel​

• Optional ariaLabel: string

Deprecated

  • Use kebab-case aria-label instead Label to be used for accessibility purposes.

Inherited from​

SharedComponentProps.ariaLabel

Defined in​

packages/ida-framework/src/types.ts:46


className​

• Optional className: string

Inherited from​

SharedComponentProps.className

Defined in​

packages/ida-framework/src/types.ts:48


onImageLoad​

• Optional onImageLoad: () => void

Type declaration​

▸ (): void

Callback fired when the image is loaded from src

Returns​

void

Defined in​

packages/ida-framework/src/features/itemPreview/ItemPreview.tsx:36


previewBox​

• Optional previewBox: PreviewBox

Box within the image to show. Leave undefined if the entire image should be shown.

Defined in​

packages/ida-framework/src/features/itemPreview/ItemPreview.tsx:32


role​

• Optional role: AriaRole

Inherited from​

SharedComponentProps.role

Defined in​

packages/ida-framework/src/types.ts:49


show​

• Optional show: boolean

Optionally hide the image, in case some other temporary preview needs to be shown instead

Defined in​

packages/ida-framework/src/features/itemPreview/ItemPreview.tsx:28


src​

• src: string

URL to image

Defined in​

packages/ida-framework/src/features/itemPreview/ItemPreview.tsx:20


style​

• Optional style: CSSProperties

Inherited from​

SharedComponentProps.style

Defined in​

packages/ida-framework/src/types.ts:47