react-payme-paycode
v1.0.3
Published
A React component for generating PayMe QR codes 🚀
Maintainers
Readme
React PayMe PayCode
A React component for PayMe PayCode online payment.
Features
- Out of the box.
- Easy to use.
Installation
To install the component, use npm or yarn:
npm install react-payme-paycodeor
yarn add react-payme-paycodeUsage
import React from 'react';
import { PayCode } from 'react-payme-paycode';
function App() {
return (
<div>
<h1>Pay with PayCode</h1>
<PayCode
value="https://payment.example.com/123456"
typeNumber={0}
errorCorrectionLevel="M"
size={344}
consumer={false}
logoSrc={"/assets/logo.png"}
/>
</div>
);
}
export default App;Props
The PayCode component accepts the following props:
| Prop | Type | Default | Description |
| ---------------------- | --------- | ------- | ------------------------------------------------------------------------------------ |
| value | string | - | Text/URL to be encoded in the QR code. |
| typeNumber | number | 0 | QR code type number (0-40). Use 0 for Auto Detect, higher numbers allow more data. |
| errorCorrectionLevel | string | "M" | Error correction level of the PayCode. |
| size | number | 300 | The size of the PayCode in pixels (recommended minimum: 250px for optimal scanning). |
| consumer | boolean | false | UI style variant for whether the PayCode is for a consumer or not. |
| logoSrc | string | - | URL of the logo image to be displayed in the PayCode. |
Acknowledgement
This project explores payment UI component integration in React applications for learning purposes. It is not affiliated with PayMe.
License
This project is licensed under the MIT License. See the LICENSE file for details.
