tiaanduplessis / react-qr-image

Generate a QR Image for your React app

react-qr-image

A React component for a QR image generated from text.

📖 Table of Contents

• react-qr-image
  • 📖 Table of Contents
  • ⚙️ Install
  • 📖 Usage
  • 📚 API
  • 💬 Contributing
  • 🪪 License

⚙️ Install

Install the package locally within you project folder with your package manager:

With npm:

npm install react-qr-image

With yarn:

yarn add react-qr-image

With pnpm:

pnpm add react-qr-image

📖 Usage

import React from "react";
import ReactDOM from "react-dom";

import QRImage from "react-qr-image";

function App() {
  return (
    <>
      <QRImage text="hello" />
      <QRImage text="hello" color="red" />
      <QRImage text="hello" color="white" background="#111" />
      <QRImage>hello</QRImage>
    </>
  );
}

const rootElement = document.getElementById("root");
ReactDOM.render(<App />, rootElement);

📚 API

For all configuration options, please see the API docs.

💬 Contributing

Got an idea for a new feature? Found a bug? Contributions are welcome! Please open up an issue or make a pull request.

🪪 License

MIT © Tiaan du Plessis