@pinwheel/react-modal

@pinwheel/react-modal

React package for Pinwheel modal

Install

npm install --save @pinwheel/react-modal

Usage

import PinwheelModal from '@pinwheel/react-modal'

const App = () => {
  return <PinwheelModal open={true} linkToken={token} onEvent={console.log} />
}

In order to utilize the pinwheel iframe with the security policies enforced. (Recommended for production)

import PinwheelModal from '@pinwheel/react-modal'

const App = () => {
  return (
    <PinwheelModal
      open={true}
      useSecureOrigin
      linkToken={token}
      onEvent={console.log}
    />
  )
}

All available React props are listed here.

Please consult our docs for more information.

Quick Start

You may want to explore the usage of the modal locally.

Start by going to the customer dashboard to create a token. Copy the token string. Then

# Build the @pinwheel/react-modal package
npm i
npm run build
# Run the example app
cd example
npm i
npm start
# Go to localhost:9000?token=<PASTE YOUR GENERATED TOKEN HERE>

License

MIT © Pinwheel React Modal is available under the MIT license. See the LICENSE file for more info.