Embedded analytics SDK API
    Preparing search index...

    Function CollectionBrowser

    • A component that allows you to browse collections and their items.

      Parameters

      • props: CollectionBrowserProps
        • OptionalclassName?: string

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

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

        • OptionalEmptyContentComponent?: null | ComponentType

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

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

          A function to call when an item is clicked.

        • OptionalpageSize?: number

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

        • 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.

      Returns ReactNode