Axinom Mosaic Libraries
    Preparing search index...

    Interface NavigationExplorerProps<T>

    interface NavigationExplorerProps<T extends Data> {
        actions?: PageHeaderActionProps[];
        bulkActions?: ExplorerBulkAction<T>[];
        bulkEditRegistration?: BulkEditRegistration<T>;
        calculateNavigateUrl?: (item: T) => string;
        className?: string;
        columnGap?: string;
        columns: Column<T>[];
        dataProvider: ExplorerDataProvider<T>;
        defaultFilterValues?: FilterValues<T>;
        defaultSortOrder?: SortData<T>;
        enableSelectAll?: boolean;
        filterOptions?: FilterType<T>[];
        generateItemLink?: (data: T) => LocationDescriptor<unknown>;
        headerRowActionSize?: string;
        headerRowHeight?: string;
        horizontalTextAlign?: "right" | "left" | "center";
        inlineMenuActions?: (data: T) => ActionData[];
        keyProperty?: keyof T;
        listRowActionSize?: string;
        listRowHeight?: string;
        loadingTriggerOffset?: number;
        minimumWidth?: string;
        modalMode?: boolean;
        onCreateAction?: LocationDescriptor | (() => void);
        openBulkActionsOnStart?: boolean;
        persistExplorerStates?: ExplorerStateOptions;
        quickEditConfig?: QuickEditConfig;
        quickEditRegistrations?: QuickEditRegistration<T>[];
        rowGap?: string;
        stationKey: string;
        textWrap?: boolean;
        title?: string;
        verticalTextAlign?: "end" | "center" | "start";
    }

    Type Parameters

    Hierarchy

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

    Properties

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

    Properties

    actions?: PageHeaderActionProps[]

    Array of actions to be rendered.

    bulkActions?: ExplorerBulkAction<T>[]

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

    bulkEditRegistration?: BulkEditRegistration<T>

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

    calculateNavigateUrl?: (item: T) => 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.
    className?: string

    CSS Class name for additional styles

    columnGap?: string

    Spacing between columns

    columns: Column<T>[]

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

    dataProvider: ExplorerDataProvider<T>

    Callback used to request new or additional data

    defaultFilterValues?: FilterValues<T>

    Default values for filters

    defaultSortOrder?: SortData<T>

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

    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)

    filterOptions?: FilterType<T>[]

    The filters that should be available on the Explorer

    generateItemLink?: (data: T) => 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!

    headerRowActionSize?: string

    Header checkbox size

    headerRowHeight?: string

    Header row height

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

    Horizontal alignment of text

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

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

    keyProperty?: keyof T

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

    listRowActionSize?: string

    List row action button and checkbox size

    listRowHeight?: string

    List row height

    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)

    minimumWidth?: string

    Minimum width of this component

    modalMode?: boolean

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

    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.
    openBulkActionsOnStart?: boolean

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

    persistExplorerStates?: ExplorerStateOptions

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

    quickEditConfig?: QuickEditConfig

    Optional Quick Edit Configuration

    quickEditRegistrations?: QuickEditRegistration<T>[]

    Quick Edit Registrations

    rowGap?: string

    Spacing between rows

    stationKey: string

    Unique identifier used to store states related to explorer

    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)

    title?: string

    Title shown in page header

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

    Vertical alignment of text

    Settings

    Member Visibility

    On This Page

    Properties