Embedded analytics SDK API
    Preparing search index...

    Interface CollectionBrowserProps

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

    Properties

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

    Properties

    className?: string

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

    collectionId?: SdkBrowserCollectionId

    The collection to show:

    • a number - the collection ID. You can find it in the URL of a collection in your Metabase instance. For http://localhost:3000/collection/1-my-collection the ID is 1.
    • an entity ID string, e.g. "nT4gT_MOnU1uJ1zLsGaTV".
    • "personal" - the user's personal collection.
    • "tenant" - the user's tenant collection.
    • "root" - the root collection, "Our analytics".
    • "all" - a list that contains the root collection, the tenant collections, and the user's personal collection.

    Defaults to "personal".

    EmptyContentComponent?: ComponentType | null

    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.

    showDashboardQuestions?: boolean

    Whether to show questions that belong to a dashboard alongside collection saved questions. Set to true to show them. Defaults to false, keeping the list focused on collection content.

    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