Changelog · Report a Bug · Request a Feature · Ask a Question

Overview

Our React library that builds on top of the js-sdk. It provides React components for checkout forms, donor profiles, and more to seamlessly integrate Everfund into your React applications

Getting Started

Installation

There are two ways you can include @everfund/react-sdk in your project. You can either import the @everfund/react-sdk npm module or load @everfund/react-sdk with a script tag.

Install everfund/react-sdk

pnpm i @everfund/react-sdk
# or
yarn add @everfund/react-sdk
# or
npm install @everfund/react-sdk

Usage Checkout Modal

import { useDonationCheckoutModal } from '@everfund/react-sdk'
import { useState } from 'react'

export const DonateNow = () => {
  const { openModal } = useDonationCheckoutModal({
    code: 'demo',
  })

  return (
    <button className="button" onClick={() => openModal()}>
      Donate Now
    </button>
  )
}

Usage Donation Form

import { DonationForm } from '@everfund/react-sdk'

export const App = () => (<div>
  <div>Some content</div>
  <div>
    <DonationForm code="demo" />
  </div>
</div>)

For further details and examples, please refer to our Documentation.

Build

To build the package locally with tsup, run:

pnpm build

Contributing

At Everfund, we strive to create an inclusive and welcoming environment for all contributors.

To ensure a productive and respectful experience for everyone involved, we have established a few ground rules.

Please review our Code of Conduct before getting started.

If you're new to the project, you may want to start with one of our designated "good first issues" These issues are specifically chosen to be accessible and easy to understand, making them a great introduction to the project.

Together, let's build something amazing!

Security

@everfund/react-sdk follows good practices of security, but 100% security cannot be assured.

@everfund/react-sdk is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.