Both renderCatalogDefault
and renderCatalog
use the same configuration, the only difference being how they are passed in. This is the reference for available configuration for both.
Property | Data Attribute | Description | Available Values | Default |
---|---|---|---|---|
None | data-token | The Xkit User Token to be used. This is only available for renderCatalogDefault and can be skipped if you're using xkit.login | string | None |
rootPath | data-path | The base path at which the catalog will be rendered on your webserver. This is used in determining the href of links and what page to render on initial load. If you are using a memory router, set this to the page on which the catalog will be rendered | Any valid path starting with a / | / |
routerType | data-router | Whether to use the browser history or not when changing locations within the catalog. If the catalog has an entire subdirectory against which it will be shown, use browser , otherwise, use memory . | memory browser | browser |
title | data-title | The title used at the top of the catalog. | string | <Your App> Integrations |
hideTitle | data-hide-title | Whether to hide the title at the top of the catalog (useful when embedding) | A boolean attribute. Its presence indicates a value of true . | false |
hideSearch | data-hide-search | Whether to hide the search at the top of the catalog (useful when only rendering a few connectors) | A boolean attribute. Its presence indicates a value of true . | |
theme | Not available as data attribute | The custom Theme to use when rendering the Catalog | Catalog Theme | None |
connectorsPath | data-connectors-path | The URL prefix before a specific connector. Defaults to /connectors | A string starting with / | |
filter | Not available as data attribute | A function to limit which connectors are visible to the current user | Catalog Filter | () => true |
settings | Not available as a data attribute | A function to show configuration settings to the user. | Catalog Settings |