ImageOverlayProps interface

Package:

@azure/communication-react

Props for ImageOverlay.

Properties

altText	Optional string used as a alt text for the image.
imageSrc	Image source used to display the image in a large scale.
isOpen	Boolean that controls whether the modal is displayed.
onDismiss	Callback to invoke when the ImageOverlay modal is dismissed
onDownloadButtonClicked	Optional callback called when the download button is clicked. If not provided, the download button will not be rendered.
title	Optional string used as the title of the image and displayed on the top left corner of the ImageOverlay.
titleIcon	Optional JSX element used as a title icon and displayed to the left of the title element.

Property Details

altText

Optional string used as a alt text for the image.

altText?: string

Property Value

string

imageSrc

Image source used to display the image in a large scale.

imageSrc: string

Property Value

string

isOpen

Boolean that controls whether the modal is displayed.

isOpen: boolean

Property Value

boolean

onDismiss

Callback to invoke when the ImageOverlay modal is dismissed

onDismiss: () => void

Property Value

() => void

onDownloadButtonClicked

Optional callback called when the download button is clicked. If not provided, the download button will not be rendered.

onDownloadButtonClicked?: (imageSrc: string) => void

Property Value

(imageSrc: string) => void

title

Optional string used as the title of the image and displayed on the top left corner of the ImageOverlay.

title?: string

Property Value

string

titleIcon

Optional JSX element used as a title icon and displayed to the left of the title element.

titleIcon?: Element

Property Value

Element