Interface NavigationExplorerProps<T>

Type Parameters

Hierarchy

  • Omit<ExplorerProps<T>, "selectionMode" | "onBulkActionsToggled" | "onItemClicked" | "setTabTitle">
    • NavigationExplorerProps

Properties

actions? bulkActions? calculateNavigateUrl? className? columnGap? columns dataProvider defaultFilterValues? defaultSortOrder? enableSelectAll? filterOptions? generateItemLink? headerRowActionSize? headerRowHeight? horizontalTextAlign? inlineMenuActions? keyProperty? listRowActionSize? listRowHeight? loadingTriggerOffset? minimumWidth? modalMode? onCreateAction? openBulkActionsOnStart? persistExplorerStates? rowGap? stationKey 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 calculateNavigateUrl

calculateNavigateUrl?: ((item) => string)

Type declaration

    • (item): string

    • Function that calculates the URL to navigate to when a row of data is clicked.

      • The function should take the item data as input and return the URL string.
      • Navigation will not occur if bulk actions are open.

      Parameters

      • item: T

      Returns string

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?: "center" | "left" | "right"

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 onCreateAction

onCreateAction?: LocationDescriptor | (() => void)
  • If a LocationDescriptor is provided, it will be treated as a path to the station to navigate to, and a link will be generated.
  • If a function is provided, it will be called when the create action is clicked, and a button will be generated.

Type declaration

    • (): void

    • 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 rowGap

rowGap?: string

Spacing between rows

stationKey

stationKey: string

Unique identifier used to store states related to explorer

Optional title

title?: string

Title shown in page header

Optional verticalTextAlign

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

Vertical alignment of text

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc