ImageOverlayProps interface

パッケージ:

@azure/communication-react

ImageOverlay のプロップ。

プロパティ

altText	画像の代替テキストとして使用される省略可能な文字列。
imageSrc	画像を大規模に表示するために使用される画像ソース。
isOpen	モーダルを表示するかどうかを制御するブール値。
onDismiss	ImageOverlay モーダルが閉じられたときに呼び出すコールバック
onDownloadButtonClicked	ダウンロードボタンがクリックされたときに呼び出されるオプションのコールバック。 指定しない場合、ダウンロード ボタンはレンダリングされません。
title	画像のタイトルとして使用され、ImageOverlay の左上隅に表示される省略可能な文字列。
titleIcon	タイトルアイコンとして使用され、タイトル要素の左側に表示されるオプションの JSX 要素。

プロパティの詳細

altText

画像の代替テキストとして使用される省略可能な文字列。

altText?: string

プロパティ値

string

imageSrc

画像を大規模に表示するために使用される画像ソース。

imageSrc: string

プロパティ値

string

isOpen

モーダルを表示するかどうかを制御するブール値。

isOpen: boolean

プロパティ値

boolean

onDismiss

ImageOverlay モーダルが閉じられたときに呼び出すコールバック

onDismiss: () => void

プロパティ値

() => void

onDownloadButtonClicked

ダウンロードボタンがクリックされたときに呼び出されるオプションのコールバック。 指定しない場合、ダウンロード ボタンはレンダリングされません。

onDownloadButtonClicked?: (imageSrc: string) => void

プロパティ値

(imageSrc: string) => void

title

画像のタイトルとして使用され、ImageOverlay の左上隅に表示される省略可能な文字列。

title?: string

プロパティ値

string

titleIcon

タイトルアイコンとして使用され、タイトル要素の左側に表示されるオプションの JSX 要素。

titleIcon?: Element

プロパティ値

Element