Interface VideoSelectExplorerProps

Hierarchy

  • VideoSelectExplorerProps

Properties

allowBulkSelect? enableSelectAll? excludeItems? onCancel? onSelection predefinedFilterValues? stationKey? title?

Properties

Optional allowBulkSelect

allowBulkSelect?: boolean

Whether or not the selection of multiple items is allowed (default: false)

Optional enableSelectAll

enableSelectAll?: boolean

In multiselect mode, whether the Select All button will be displayed. This is currently not fully supported. (default: false)

Optional excludeItems

excludeItems?: any[]

IDs of items which will be excluded from the explorer. Can be used to remove already selected items.

Optional onCancel

onCancel?: (() => void)

Type declaration

    • (): void

    • Callback called when the user cancels the selection

      Returns void

onSelection

onSelection: ((selection) => void)

Type declaration

    • (selection): void

    • Callback called when the user finished the selection. The IDs of the selected item (or items) will be passed as argument to the callback.

      Parameters

      • selection: ItemSelection<Video>

      Returns void

Optional predefinedFilterValues

predefinedFilterValues?: FilterValues<Video>

A set of initial filter values which the Explorer will use. (default: empty)

Optional stationKey

stationKey?: string

Unique identifier used to store states related to explorer

Optional title

title?: string

Optional Title shown in page header (default: 'Videos')

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc