suite · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: suite · React: <FinBazeSuite />

Create the session#

mutation {
  createEmbedSession(input: {
    companyId: "…"
    user: { externalUserId: "…" }
    components: { suite: { enabled: true } }
  }) { clientSecret }
}

Requirements#

No feature requirements.

Component features#

None.

Options#

Passed to instance.create("suite", options) or as props.

Option	Type
`initialRoute`	`string`	A suite route to open first, for example `sales/sales-invoices`. A route is `<section>/<component>` or `<section>/<component>/<id>`.
`route`	`string`	Drive the suite: pass a route and it opens that page. In external navigation the partner uses this to show the page a `suite_route` navigation pointed at.

Every component also takes appearance and navigation ("internal" or "external").

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`

Use it#

import { FinBazeSuite } from "@finbaze/embed-react";

<FinBazeSuite />

const component = instance.create("suite");
component.mount("#finbaze");