Hosanna UI API v1.30.2-next
    Preparing search index...

    Interface ICollectionViewDataSourceRow<T, I>

    Interface for a data source row in the collection view.

    interface ICollectionViewDataSourceRow<
        T = any,
        I extends IIdentifiable = ICollectionViewDataSourceItem,
    > {
        callbacks?: IRowCallbackNameMap;
        data: T;
        dataMode?: CollectionViewRowDataMode;
        dataSourceConfig?: IDataSourceConfig;
        dataSourceState?: IDataSourceState;
        downKeyTriggers?: TriggerEntry[];
        focusTarget?: IHosannaView<ViewState>;
        focusTriggers?: TriggerEntry[];
        id: string;
        index?: number;
        isEnabled?: boolean;
        isHidden?: boolean;
        items: I[];
        leftKeyTriggers?: TriggerEntry[];
        loadMoreUrl?: string;
        longPressSelectTriggers?: TriggerEntry[];
        optionsTriggers?: TriggerEntry[];
        params?: Record<string, IDataSourceParam<any>>;
        remoteItemsUrl?: string;
        rightKeyTriggers?: TriggerEntry[];
        sectionName?: string;
        selectTriggers?: TriggerEntry[];
        settings?: ICollectionViewRowSettings;
        settingsKey?: string;
        settingsOverrides?: Partial<ICollectionViewRowSettings>;
        state?: RowState;
        tabGroupName?: string;
        upKeyTriggers?: TriggerEntry[];
    }

    Type Parameters

    Index

    Properties

    callbacks? data dataMode? dataSourceConfig? dataSourceState? downKeyTriggers? focusTarget? focusTriggers? id index? isEnabled? isHidden? items leftKeyTriggers? loadMoreUrl? longPressSelectTriggers? optionsTriggers? params? remoteItemsUrl? rightKeyTriggers? sectionName? selectTriggers? settings? settingsKey? settingsOverrides? state? tabGroupName? upKeyTriggers?

    Properties

    callbacks?: IRowCallbackNameMap

    Row callbacks dictionary mapping callback types to arrays of callback handler names.

    data: T

    The data for the row.

    dataMode?: CollectionViewRowDataMode

    Data mode for the row (inline or remote).

    dataSourceConfig?: IDataSourceConfig

    Modern datasource configuration object. Replaces remoteItemsUrl/loadMoreUrl.

    dataSourceState?: IDataSourceState
    downKeyTriggers?: TriggerEntry[]

    DSL triggers that activate when the down key is pressed on this row/item.

    focusTarget?: IHosannaView<ViewState>

    The focus target view for the row, if any.

    focusTriggers?: TriggerEntry[]

    DSL triggers that activate when this row/item is focused.

    id: string

    The unique ID for the row.

    index?: number

    The index of the row (assigned by the data source).

    isEnabled?: boolean

    Optional flag for row interaction.

    isHidden?: boolean

    Optional flag for hiding a row, which is still in the collection view - this can be used for loading.

    items: I[]

    The array of items within the row.

    leftKeyTriggers?: TriggerEntry[]

    DSL triggers that activate when the left key is pressed on this row/item.

    loadMoreUrl?: string

    URL for loading more items in the row.

    Use datasource.loadMoreUrl instead.

    longPressSelectTriggers?: TriggerEntry[]

    DSL triggers that activate when this row/item is long pressed.

    optionsTriggers?: TriggerEntry[]

    DSL triggers that activate when the Options key is pressed on this row/item.

    params?: Record<string, IDataSourceParam<any>>

    Row-level declarative parameters for {{...}} substitution.

    remoteItemsUrl?: string

    URL for the items in the row (for remote data).

    Use datasource.url instead.

    rightKeyTriggers?: TriggerEntry[]

    DSL triggers that activate when the right key is pressed on this row/item.

    sectionName?: string

    Section name for grouping related rows (used for sticky row management).

    selectTriggers?: TriggerEntry[]

    DSL triggers that activate when this row/item is selected or focused.

    settings?: ICollectionViewRowSettings

    Inline or resolved settings for the row.

    settingsKey?: string

    Reference key for predefined row settings.

    settingsOverrides?: Partial<ICollectionViewRowSettings>

    Specific overrides for the row settings.

    state?: RowState

    The current state of the row.

    tabGroupName?: string

    Group name for tab-based row management (rows with same tabGroupName are shown/hidden together).

    upKeyTriggers?: TriggerEntry[]

    DSL triggers that activate when the up key is pressed on this row/item.

    Settings

    Member Visibility

    On This Page

    Properties