Function CollectionBrowser

Parameters

• props: CollectionBrowserProps

  • OptionalclassName?: string

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

  • OptionalcollectionId?: 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".

  • OptionalEmptyContentComponent?: ComponentType | null

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

  • OptionalonClick?: (item: MetabaseCollectionItem) => void

    A function to call when an item is clicked.

  • OptionalpageSize?: number

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

  • OptionalshowDashboardQuestions?: 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.

  • Optionalstyle?: CSSProperties

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

  • OptionalvisibleColumns?: CollectionBrowserListColumns[]

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

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

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