Skip to main content

AssetPickerDialog

AssetPickerDialog​

@vendure/dashboardasset-picker-dialog.tsx

A dialog which allows the creation and selection of assets.

Signature
function AssetPickerDialog(props: AssetPickerDialogProps): void

Parameters

props​

parameter
AssetPickerDialogProps

AssetPickerDialogProps​

@vendure/dashboardasset-picker-dialog.tsx

Props for the AssetPickerDialog component.

Signature
interface AssetPickerDialogProps {
    open: boolean;
    onClose: () => void;
    onSelect: (assets: Asset[]) => void;
    multiSelect?: boolean;
    initialSelectedAssets?: Asset[];
    title?: string;
}

open​

property
boolean

Whether the dialog is open.

onClose​

property
() => void

The function to call when the dialog is closed.

onSelect​

property
(assets: Asset[]) => void

The function to call when assets are selected.

multiSelect​

property
boolean

Whether multiple assets can be selected.

initialSelectedAssets​

property
Asset[]

The initial assets that should be selected.

title​

property
string

The title of the dialog.