@getoverflow/overflow-button

overflow-button

overflow-button is a React component that allows you to embed Overflow into your application to facilitate stock gifts to non-profit organizations.

Installation

To install the overflow-button library, run

npm i @getoverflow/overflow-button --save

Example

import  OverflowButton  from  '@getoverflow/overflow-button';

export default class OverflowButtonExample extends React.Component {
	render() {
		return(
			<OverflowButton
				className="some-class"
				institution="your-organization-id"
				identifier="publicKey"
				env="production"
				nonProfitName="NAACP"
				onComplete={() => console.log("Do something")}
			>
				Give Through Overflow
			</OverflowButton>
		)
	}
}

Props

You can customize the Overflow button component however you like using the standard className prop
className: PropTypes.string,

// The institution is your organization's id that is provided to you by Overflow
institution: PropTypes.string.isRequired

// The non-profit identifier provided by partner organization
identifier: PropTypes.string.isRequired

// For development and testing, use "demo". For production use, use "production".
env: PropTypes.string // default is "demo"

// If you are a marketplace and have multiple non-profits on your platform, use the nonProfitName prop to pass the specific non-profit that the donor is giving to
nonProfitName: PropTypes.string,

//Callback function to call when the Overflow flow is complete
onComplete: PropTypes.func,

//The child is the title of the button
children: PropTypes.string.isRequired