@quiltt/react

@quiltt/react provides React Components and Hooks for integrating Quiltt into React-based applications.

Installation

$ npm install @quiltt/react
# or
$ yarn add @quiltt/react
# or
$ pnpm add @quiltt/react

Core Modules and Types

The @quiltt/react library ships with @quiltt/core, which provides an Auth API and essential functionality for building Javascript-based applications with Quiltt. See the Core README for more information.

React Components

All components automatically handle Session token management under the hood, using the useQuilttSession hook.

To pre-authenticate the Connector for one of your user profiles, make sure to set your token using the QuilttProvider provider or the useQuilttSession hook. See the Authentication guides for how to generate a Session.

QuilttButton

Launch the Quiltt Connector as a pop-out modal.

By default, the rendered component will be a <button> element, but you can supply your own component via the as prop. You can also pass forward any props to the rendered component.

Example

import { useState } from 'react'
import { QuilttButton } from '@quiltt/react'

export const App = () => {
  const [connectionId, setConnectionId] = useState<string>()
  const handleExitSuccess = (metadata) => {
    setConnectionId(metadata?.connectionId)
  }

  return (
    <QuilttButton
      connectorId="<CONNECTOR_ID>"
      onExitSuccess={handleExitSuccess}
      className="my-css-class"
      styles={{ borderWidth: '2px' }}
      // ... other props to pass through to the button
    >
      Add Account
    </QuilttButton>
  )
}
export default App

QuilttContainer

Launch the Quiltt Connector inside a container.

By default, the rendered component will be a <div> element, but you can supply your own component via the as prop. You can also pass forward any props to the rendered component.

Example

import { useState } from 'react'
import { QuilttContainer } from '@quiltt/react'

export const App = () => {
  const [connectionId, setConnectionId] = useState<string>()
  const handleExitSuccess = (metadata) => {
    setConnectionId(metadata?.connectionId)
  }

  return (
    <QuilttContainer
      connectorId="<CONNECTOR_ID>"
      onExitSuccess={handleExitSuccess}
      className="my-css-class"
      styles={{ height: '100%' }}
      // ... other props to pass through to the container
    />
  )
}

export default App

QuilttProvider

A provider component for passing Session and settings down to the rest of your application.

Example

import { QuilttProvider } from '@quiltt/react'

const Layout = ({ children }) => {
  return <QuilttProvider token="{SESSION_TOKEN}">{children}</QuilttProvider>
}

export default Layout

React Hooks

For maximum control over the lifecycle of Quiltt Connector and Quiltt Sessions, you can also use hooks directly.

useQuilttConnector

A hook to manage the lifecycle of Quiltt Connector.

Example

import { useQuilttConnector } from '@quiltt/react'

const App = () => {
  const { open } = useQuilttConnector('<CONNECTOR_ID>', {
    onEvent: (type) => console.log(`Received Quiltt Event: ${type}`)
    onExitSuccess: (metadata) => console.log("Connector onExitSuccess", metadata.connectionId),
  })

  return(
    <button onClick={open}>
      Launch Connector
    </button>
  )
}

useQuilttSession

A hook to manage the lifecycle of Quiltt Sessions.

See the Authentication guides for more information.

Example

import { useCallback, useEffect } from 'react'

import { useQuilttSession } from '@quiltt/react'

const App = () => {
  const { session, importSession, revokeSession } = useQuilttSession()

  useEffect(() => {
    // Import session from API call, local storage, query param, etc.
    importSession('{SESSION_TOKEN}')
  }, [importSession])

  const logOut = useCallback(() => {
    // Revoke and clear the Quiltt session
    revokeSession()

    // do other stuff!
  }, [revokeSession])

  if (session) {
    console.log('Session token: ', session.token)
  } else {
    console.log('No Session available')
  }

  return (
    <>
      <div>Hello world!</div>
      <button onClick={logOut}>Log Out</button>
    </>
  )
}

export default App

Typescript support

@quiltt/react is written in Typescript and ships with its own type definitions. It also ships with the type definitions from @quiltt/core.

License

This project is licensed under the terms of the MIT license. See the LICENSE file for more information.

Contributing

For information on how to contribute to this project, please refer to the CONTRIBUTING.md file.