CapitalOS for React

React components for integrating with CapitalOS

Requirements

React 16.8.0 or later

Installation

npm

npm install @capitalos/react

yarn

yarn add @capitalos/react

pnpm

pnpm add @capitalos/react

Documentation

Please refer to the official docs for more details.

Usage

In order to use the components you will need to obtain a client authentication token. refer to the CapitalOS documentation for more information.

import { App } from '@capitalos/react'

function MyComponent() {

  // ... obtain token from backend

  return (
    <App token={token}>
  )
}

Manage bank connections

ManageBankConnections supports admin users on approved, pending, and waiting accounts. It shows connected banks and lets the user add or reconnect accounts before approval. Other account statuses and non-admin users receive an error through the App's onError callback.

The standalone screen shows bank management without onboarding status copy. Eligibility is controlled by the deployed iframe, so existing SDK versions can use it without upgrading. Disconnecting a bank still requires the extended bank-connection actions feature and cannot remove the bank containing the default account. The separate AddBankAccount component requires an approved account.

TypeScript support

TypeScript definitions for @capitalos/react are built into the npm package and should be automatically picked up by your editor.