react

@offer-ui/react

Offer Design System UI for React components.

🎉 Getting Started

Run the following command using npm:

$ npm install @offer-ui/react

If you prefer Yarn, use the following command instead:

$ yarn add @offer-ui/react

🚀 Usage

To start using the components, please follow these steps:

1. Wrap your application with the OfferStyleProvider provided by @offer-ui/react.

import { OfferStyleProvider } from "@offer-ui/react"

// Do this at the root of your application
function App({ children }) {
  return <OfferStyleProvider>{children}</OfferStyleProvider>
}

1. Now you can start using components like so!:

import { Badge } from "@offer-ui/react"

function Example() {
  return <Badge colorType="orange">I just consumed some Offer!</Badge>
}

More guides on how to get started are available here

📝 License

@offer-ui/react is made available under the MIT License.