@rebilly/framepay-react
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.5 • Public • Published

    framepay-react

    npm Build Status

    React components for FramePay.js

    Supported: React 14, 15, 16 (latest)

    This package is a wrapper for FramePay offering out-of-the-box support for Redux and other common React features.

    Table of Contents

    FramePay documentation

    For more information on FramePay see its official documentation or repository.

    Demos

    Installation

    Install using Yarn:

    yarn add @rebilly/framepay-react
    

    Or using NPM:

    npm install @rebilly/framepay-react --save
    

    Getting started

    The example described in this readme can be found here (CodeSandbox)

    The FramePay context (FramePayProvider)

    FramePayProvider provides settings to the FramePay API. See Rebilly.initialize for a list of all configuration options.

    // index.js
    import React from 'react';
    import { render } from 'react-dom';
    import { FramePayProvider } from 'framepay-react';
    
    import MyCardPageComponent from './MyCardPageComponent';
    
    const App = () => {
        return (
            <FramePayProvider injectStyle publishableKey="pk_sandbox_1234567890">
                <MyCardPageComponent/>
            </FramePayProvider>
        );
    };
    
    render(<App/>, document.getElementById('root'));

    Define configuration parameters as attributes on the provider tag.

    publishableKey="pk_sandbox_1234567890"

    Setting up your payment form

    WARNING

    Please, don't implementing the unmount functionality, use the examples.

    The react lifecycle methods already implemented in the library.

    withFramePay (All props)
    • Rebilly - FramePay's namespace
    • BankAccountNumberElement
    • BankAccountTypeElement
    • BankRoutingNumberElement
    • CardElement
    • CardCvvElement
    • CardExpiryElement
    • CardNumberElement
    withFramePayCardComponent (Card props)
    • Rebilly
    • CardElement
    • CardCvvElement
    • CardExpiryElement
    • CardNumberElement
    withFramePayBankComponent (Bank props)
    • Rebilly
    • BankAccountNumberElement
    • BankAccountTypeElement
    • BankRoutingNumberElement
    With FramePay (withFramePay) HOC

    This simple FramePay HOC is used to provide the Rebilly API in your component. It is most commonly used in combination with multiple payment methods.

    Card elements (withFramePayCardComponent) HOC

    Wrapper for the payment card features.

    // MyCardPageComponent.js
    import React from 'react';
    import { withFramePayCardComponent } from 'framepay-react';
    
    class MyCardPageComponent extends React.Component {
        constructor(props) {
            super(props);
            this.formNode = null;
            this.state = { firstName: '', lastName: '' };
            this.onSubmit = this.onSubmit.bind(this);
        }
    
        onSubmit(e) {
            e.preventDefault();
            // @see https://rebilly.github.io/framepay-docs/reference/rebilly.html#rebilly-createtoken
            this.props.Rebilly.createToken(
                this.formNode,
                { billingAddress: { ...this.state } }
            )
                .then(data => alert(JSON.stringify(data, null, 2)))
                .catch(err => alert(JSON.stringify(err, null, 2)));
        }
    
        render() {
            return (<form
                ref={node => this.formNode = node}
                onSubmit={this.onSubmit}>
                <div>
                    <input
                        type="text"
                        name="firstName"
                        placeholder="First Name"
                        defaultValue={this.state.firstName}
                        onChange={(e) => this.setState({ firstName: e.target.value })}/>
                </div>
                <br/>
                <div>
                    <input
                        type="text"
                        name="lastName"
                        placeholder="Last Name"
                        defaultValue={this.state.lastName}
                        onChange={(e) => this.setState({ lastName: e.target.value })}/>
                </div>
                <br/>
                <this.props.CardElement/>
                <hr/>
                <button>Make Payment</button>
            </form>);
        }
    }
    
    export default withFramePayCardComponent(MyCardPageComponent);
    Bank elements (withFramePayBankComponent) HOC

    Wrapper for the ACH features.

    import React from 'react';
    import { withFramePayBankComponent } from 'framepay-react';
    
    class MyBankPageComponent extends React.Component {
        constructor(props) {
            super(props);
            this.formNode = null;
            this.state = { firstName: '', lastName: '' };
            this.onSubmit = this.onSubmit.bind(this);
        }
    
        onSubmit(e) {
            e.preventDefault();
            // @see https://rebilly.github.io/framepay-docs/reference/rebilly.html#rebilly-createtoken
            this.props.Rebilly.createToken(
                this.formNode,
                { billingAddress: { ...this.state } }
            )
                .then(data => alert(JSON.stringify(data, null, 2)))
                .catch(err => alert(JSON.stringify(err, null, 2)));
        }
    
        render() {
            return (<form
                ref={node => this.formNode = node}
                onSubmit={this.onSubmit}>
                <div>
                    <input
                        type="text"
                        name="firstName"
                        placeholder="First Name"
                        defaultValue={this.state.firstName}
                        onChange={(e) => this.setState({ firstName: e.target.value })}/>
                </div>
                <br/>
                <div>
                    <input
                        type="text"
                        name="lastName"
                        placeholder="Last Name"
                        defaultValue={this.state.lastName}
                        onChange={(e) => this.setState({ lastName: e.target.value })}/>
                </div>
                <br/>
                <this.props.BankElement/>
                <hr/>
                <button>Make Payment</button>
            </form>);
        }
    }
    
    export default withFramePayBankComponent(MyBankPageComponent);

    Advanced options

    Initialization settings

    The framepay-react package supports all the FramePay initialization settings. See Rebilly.initialize for all customizations.

    Additionally injectStyle is available. When defined in the FramePayProvider it will add the default FramePay CSS in the header of your application.

    <FramePayProvider injectStyle publishableKey="pk_sandbox_1234567890">
        <MyCardPageComponent/>
    </FramePayProvider>

    The CSS file is hosted on Rebilly's CDN and is found at this URL: https://cdn.rebilly.com/framepay/v1/rebilly.css

    See adding default element styles in FramePay's documentation for more details.

    Create Token Parameters

    The createToken method supports all FramePay arguments. See Rebilly.createToken for more details.

    Troubleshooting

    The methods withFramePay, withFramePayCardComponent and withFramePayBankComponent are higher-order-components. They can't be called directly from your render() method, so assign the generated component to a variable in the global scope before use.

    Incorrect
    import * as React from 'react';
    import {withFramePayCardComponent} from 'framepay-react'
    
    class SomeComponent extends React.Component {
        render(){
            return(<div>
                {withFramePayCardComponent(MyCardComponent)}
            </div>)
        }
    }
    Correct
    import * as React from 'react';
    import {withFramePayCardComponent} from 'framepay-react'
    
    const MyCardElement = withFramePayCardComponent(MyCardComponent);
    
    class SomeComponent extends React.Component {
        render(){
            return(<div>
                <MyCardElement />
            </div>)
        }
    }

    Install

    npm i @rebilly/framepay-react

    DownloadsWeekly Downloads

    288

    Version

    1.1.5

    License

    MIT

    Unpacked Size

    133 kB

    Total Files

    55

    Last publish

    Collaborators

    • adamaltman
    • romanhotsiy
    • mike.classic
    • irena-rebilly
    • rebilly-npm-machine-user