Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

2.2 KB
Raw Blame

title: Browser component reference summary: "Reference for the metabase-browser web component attributes and the CollectionBrowser SDK props."

Browser component reference

Reference material for embedding a collection browser:

For how to set all this up, check out Embed a collection browser.

Web component metabase-browser attributes

These attributes apply to the <metabase-browser> web component.

{% include_file "{{ dirname }}/eajs/snippets/MetabaseBrowserAttributes.md" snippet="properties" %}

Depending on the framework you're using, you may need to stringify attributes before passing them to the component. And if you surround an attribute's value with double quotes, use single quotes inside it:

<metabase-browser
  initial-collection="123"
  collection-entity-types="['collection', 'dashboard']"
  data-picker-entity-types="['model']"
></metabase-browser>

These examples use sequential IDs — the number in the item's URL. On Pro and Enterprise plans, you can use entity IDs instead; they stay the same when you serialize content from one Metabase to another, like from staging to production.

React SDK CollectionBrowser props

{% include plans-blockquote.html feature="Modular embedding SDK" sdk=true convert_pro_link_to_embedding=true %}

CollectionBrowser lists the items in a collection and reports clicks. Unlike the web component, it doesn't open items or offer buttons for creating them. See React SDK collection browser.

{% include_file "{{ dirname }}/sdk/api/snippets/CollectionBrowserProps.md" snippet="properties" %}

Further reading