80 lines
2.7 KiB
Markdown
80 lines
2.7 KiB
Markdown
# @rc-component/qrcode
|
|
|
|
React QRCode Component
|
|
|
|
[![NPM version][npm-image]][npm-url]
|
|
[![npm download][download-image]][download-url]
|
|
[![build status][github-actions-image]][github-actions-url]
|
|
[![Test coverage][codecov-image]][codecov-url]
|
|
[![bundle size][bundlephobia-image]][bundlephobia-url]
|
|
[![dumi][dumi-image]][dumi-url]
|
|
|
|
[npm-image]: http://img.shields.io/npm/v/@rc-component/qrcode.svg?style=flat-square
|
|
[npm-url]: http://npmjs.org/package/@rc-component/qrcode
|
|
[travis-image]: https://img.shields.io/travis/react-component/qrcode/master?style=flat-square
|
|
[travis-url]: https://travis-ci.com/react-component/qrcode
|
|
[github-actions-image]: https://github.com/react-component/qrcode/workflows/CI/badge.svg
|
|
[github-actions-url]: https://github.com/react-component/qrcode/actions
|
|
[codecov-image]: https://img.shields.io/codecov/c/github/react-component/qrcode/master.svg?style=flat-square
|
|
[codecov-url]: https://app.codecov.io/gh/react-component/qrcode
|
|
[david-url]: https://david-dm.org/react-component/qrcode
|
|
[david-image]: https://david-dm.org/react-component/qrcode/status.svg?style=flat-square
|
|
[david-dev-url]: https://david-dm.org/react-component/qrcode?type=dev
|
|
[david-dev-image]: https://david-dm.org/react-component/qrcode/dev-status.svg?style=flat-square
|
|
[download-image]: https://img.shields.io/npm/dm/@rc-component/qrcode.svg?style=flat-square
|
|
[download-url]: https://npmjs.org/package/@rc-component/qrcode
|
|
[bundlephobia-url]: https://bundlephobia.com/package/@rc-component/qrcode
|
|
[bundlephobia-image]: https://badgen.net/bundlephobia/minzip/@rc-component/qrcode
|
|
[dumi-url]: https://github.com/umijs/dumi
|
|
[dumi-image]: https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square
|
|
|
|
## Install
|
|
|
|
[](https://npmjs.org/package/@rc-component/qrcode)
|
|
|
|
## Usage
|
|
|
|
## Example
|
|
|
|
http://localhost:8001
|
|
|
|
## Development
|
|
|
|
```
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
## API
|
|
|
|
### props
|
|
|
|
## API
|
|
|
|
| Name | Type | Default | Description |
|
|
| ---- | ---- | ------- | ----------- |
|
|
|
|
## Test Case
|
|
|
|
```
|
|
npm test
|
|
npm run coverage
|
|
```
|
|
|
|
open coverage/ dir
|
|
|
|
## License
|
|
|
|
rc-qrcode is released under the MIT license.
|
|
|
|
### Refs
|
|
|
|
- Util part is from [qrcode.react](https://github.com/zpao/qrcode.react) under ISC license.
|
|
- QR Code generation part is from [qrcode-generator](https://www.nayuki.io/page/qr-code-generator-library) under MIT license.
|
|
|
|
## 🤝 Contributing
|
|
|
|
<a href="https://openomy.app/github/react-component/qrcode" target="_blank" style="display: block; width: 100%;" align="center">
|
|
<img src="https://www.openomy.app/svg?repo=react-component/qrcode&chart=bubble&latestMonth=24" target="_blank" alt="Contribution Leaderboard" style="display: block; width: 100%;" />
|
|
</a>
|