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}>
  )
}

TypeScript support

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

Error Handling

For details on how errors are managed within the SDK and how to handle them as a consumer or a maintainer, please see our Error Handling Guidelines.

Navigation Patterns

For guidance on modal dismissal, back button behavior, and callback semantics when integrating SDK components into your application, please see our Navigation and Closing Patterns.