centurion-ui
    Preparing search index...

    Type Alias DataSetListProps<T>

    Props for DataSetList component.

    0.9.0

    type DataSetListProps<T extends React.ElementType = React.ElementType> = {
        component?: T;
        componentProps?: React.ComponentPropsWithoutRef<T>;
        fieldNames?: boolean;
        hasRowDelete?: boolean;
        isCheckable?: boolean;
        isCompact?: boolean;
        isDraggable?: boolean;
        metadata: APIMetadata;
        rowData: APIDataset;
        selectedRows?: number[];
        selectRows?: (rows: "all" | number | number[]) => void;
    }

    Type Parameters

    • T extends React.ElementType = React.ElementType

      React element type used for the container component.

    Index
    component? componentProps? fieldNames? hasRowDelete? isCheckable? isCompact? isDraggable? metadata rowData selectedRows? selectRows?
    component?: T

    Container component used to wrap the footer UI.

    componentProps?: React.ComponentPropsWithoutRef<T>

    Props forwarded to the container component.

    fieldNames?: boolean

    Display the field names with the row data.

    hasRowDelete?: boolean

    Add a delete button to the row.

    isCheckable?: boolean

    Add a checkbox to the row.

    isCompact?: boolean

    Set the rows up as compact.

    isDraggable?: boolean

    Should the row be setup as a draggable row?

    metadata: APIMetadata

    Objects metadata as presented by the API.

    rowData: APIDataset

    Data to populate the rows.

    selectedRows?: number[]

    Row IDs of selected rows from the dataset.

    selectRows?: (rows: "all" | number | number[]) => void

    Callback to update page number.

    Type Declaration

      • (rows: "all" | number | number[]): void

      • Parameters

        • rows: "all" | number | number[]

          Rows to select.

        Returns void

    Settings
    Member Visibility

    On This Page
    Properties