notification-banner · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: notificationBanner · React: <FinBazeNotificationBanner />

Create the session#

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

Requirements#

No feature requirements.

Component features#

Switch these off per session with components.notificationBanner.features.

Feature	Default
`supportApproval`	on

Options#

Passed to instance.create("notification-banner", options) or as props.

Option	Type
`dismissible`	`boolean`	Show a close button.

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

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`dismissed`	`onDismissed`
`support.access.approved`	`onSupportAccessApproved`
`support.access.declined`	`onSupportAccessDeclined`

Use it#

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

<FinBazeNotificationBanner />

const component = instance.create("notification-banner");
component.mount("#finbaze");