period-picker · FinBaze for Platforms

Components

Kind: element (inline) · Session key: periodPicker · React: <FinBazePeriodPicker />

Create the session#

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

Requirements#

No feature requirements.

Component features#

None.

Options#

Passed to instance.create("period-picker", options) or as props.

Option	Type
`period`	`'current' \| 'previous' \| { year: number; month?: number; quarter?: number }`	The period to show.
`granularity`	`'month' \| 'quarter' \| 'year'`	How long a period is. Defaults to month.
`granularities`	`Array<'month' \| 'quarter' \| 'year'>`	The period lengths to offer.

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

Events#

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

Use it#

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

<FinBazePeriodPicker />

const component = instance.create("period-picker");
component.mount("#finbaze");