Embedded analytics SDK API
    Preparing search index...

    Interface CollectionBrowserProps

    interface CollectionBrowserProps {
        className?: string;
        collectionId?: SdkCollectionId;
        EmptyContentComponent?: null | ComponentType;
        onClick?: (item: MetabaseCollectionItem) => void;
        pageSize?: number;
        style?: CSSProperties;
        visibleColumns?: CollectionBrowserListColumns[];
        visibleEntityTypes?: ("collection" | "dashboard" | "question" | "model")[];
    }
    Index

    Properties

    className? collectionId? EmptyContentComponent? onClick? pageSize? style? visibleColumns? visibleEntityTypes?

    Properties

    className?: string

    A custom class name to be added to the root element.

    collectionId?: SdkCollectionId

    The numerical ID of the collection, "personal" for the user's personal collection, or "root" for the root collection. You can find this ID in the URL when accessing a collection in your Metabase instance. For example, the collection ID in http://localhost:3000/collection/1-my-collection would be 1. Defaults to "personal"

    EmptyContentComponent?: null | ComponentType

    A component to display when there are no items in the collection.

    onClick?: (item: MetabaseCollectionItem) => void

    A function to call when an item is clicked.

    pageSize?: number

    The number of items to display per page. The default is 25.

    style?: CSSProperties

    A custom style object to be added to the root element.

    visibleColumns?: CollectionBrowserListColumns[]

    The columns to display in the collection items table. If not provided, all columns will be shown.

    visibleEntityTypes?: ("collection" | "dashboard" | "question" | "model")[]

    The types of entities that should be visible. If not provided, all entities will be shown.

    Settings

    On This Page

    Properties