Interface ExplorerProps<T>

Type Parameters

Hierarchy

  • ExplorerProps

Properties

actions? bulkActions? bulkEditRegistration? className? columnGap? columns dataProvider defaultFilterValues? defaultSortOrder? enableSelectAll? filterOptions? generateItemLink? headerRowActionSize? headerRowHeight? horizontalTextAlign? inlineMenuActions? keyProperty? listRowActionSize? listRowHeight? loadingTriggerOffset? minimumWidth? modalMode? onBulkActionsToggled? onItemClicked? openBulkActionsOnStart? persistExplorerStates? quickEditRegistrations? rowGap? selectionMode? setTabTitle? stationKey textWrap? title? verticalTextAlign?

Properties

Optional actions

actions?: PageHeaderActionProps[]

Array of actions to be rendered.

Optional bulkActions

bulkActions?: ExplorerBulkAction<T>[]

Array of Bulk Actions to be rendered. If populated, Bulk Actions will become available.

Optional Experimental bulkEditRegistration

bulkEditRegistration?: BulkEditRegistration<T>

Bulk Edit Registration The feature Bulk Edit and it's underlying implementation is still in beta.

Optional className

className?: string

CSS Class name for additional styles

Optional columnGap

columnGap?: string

Spacing between columns

columns

columns: Column<T>[]

Column definitions The order of this array determines the order of columns

dataProvider

dataProvider: ExplorerDataProvider<T>

Callback used to request new or additional data

Optional defaultFilterValues

defaultFilterValues?: FilterValues<T>

Default values for filters

Optional defaultSortOrder

defaultSortOrder?: SortData<T>

Sets the default sort order for the Explorer. (default: undefined)

Optional enableSelectAll

enableSelectAll?: boolean

In multiselect mode, whether the Select All button will be displayed. When Select All button is clicked the onItemClicked button will return a filter query instead of an array of items. (default: true)

Optional filterOptions

filterOptions?: FilterType<T>[]

The filters that should be available on the Explorer

Optional generateItemLink

generateItemLink?: ((data) => LocationDescriptor<unknown>)

Type declaration

    • (data): LocationDescriptor<unknown>

    • When set, this function is used to generate the link that the user should be navigated to for each item.

      This property takes precedence over onItemClicked, which will not be executed in case generateItemLink is set!

      Parameters

      • data: T

      Returns LocationDescriptor<unknown>

Optional headerRowActionSize

headerRowActionSize?: string

Header checkbox size

Optional headerRowHeight

headerRowHeight?: string

Header row height

Optional horizontalTextAlign

horizontalTextAlign?: "right" | "left" | "center"

Horizontal alignment of text

Optional inlineMenuActions

inlineMenuActions?: ((data) => ActionData[])

Type declaration

    • (data): ActionData[]

    • Provide inline actions which are available through '...' context menu

      Parameters

      • data: T

      Returns ActionData[]

Optional keyProperty

keyProperty?: keyof T

The name of the property on the data object that should be used to identify objects (default: 'id')

Optional listRowActionSize

listRowActionSize?: string

List row action button and checkbox size

Optional listRowHeight

listRowHeight?: string

List row height

Optional loadingTriggerOffset

loadingTriggerOffset?: number

Defines when the loading of the next page is triggered. The number represents the number of row left, before a load is triggered. (default: 10)

Optional minimumWidth

minimumWidth?: string

Minimum width of this component

Optional modalMode

modalMode?: boolean

If true, the explorer will leave some margin for the modal backdrop.

Optional onBulkActionsToggled

onBulkActionsToggled?: ((expanded) => void)

Type declaration

    • (expanded): void

    • Callback to emit when Bulk Actions is toggled The expanded state is supplied as an argument

      Parameters

      • expanded: boolean

      Returns void

Optional onItemClicked

onItemClicked?: ((data, mode?) => void)

Type declaration

    • (data, mode?): void

    • Raised when an data item is clicked Row data is supplied as the first argument List mode is supplied as the second argument. List mode may change depending on the bulk actions toggled state

      Parameters

      Returns void

Optional openBulkActionsOnStart

openBulkActionsOnStart?: boolean

Whether or not bulk actions are shown by default. (default: false)

Optional persistExplorerStates

persistExplorerStates?: ExplorerStateOptions

Options for disabling states that persist such as filters and sorting. All states persist by default

Optional quickEditRegistrations

quickEditRegistrations?: QuickEditRegistration<T>[]

Quick Edit Registrations

Optional rowGap

rowGap?: string

Spacing between rows

Optional selectionMode

selectionMode?: ListSelectMode

Determines which select mode the list is in. If 'None' is selected, a right chevron will be rendered for each row of data If 'Single' is selected, a check mark will be rendered for each row of data If 'Multi' is selected or Bulk Actions is open, a checkbox will be rendered for the header and each row of data

Optional setTabTitle

setTabTitle?: boolean

Update the tab title using the 'title' field. (default: true)

stationKey

stationKey: string

Unique identifier used to store states related to explorer

Optional textWrap

textWrap?: boolean

If set to true, column text overflow will be wrapped to a new line. Otherwise, it will be truncated with an ellipsis (default: true)

Optional title

title?: string

Title shown in page header

Optional verticalTextAlign

verticalTextAlign?: "center" | "start" | "end"

Vertical alignment of text

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc