{"_id":"@alexpuertasr/react-qr-scanner","name":"@alexpuertasr/react-qr-scanner","dist-tags":{"latest":"1.2.10"},"versions":{"1.2.10":{"name":"@alexpuertasr/react-qr-scanner","version":"1.2.10","description":"A library to scan qr codes in react.","author":{"name":"Yudiel Curbelo"},"license":"MIT","private":false,"repository":{"type":"git","url":"git+https://github.com/alexpuertasr/react-qr-scanner.git"},"bugs":{"url":"https://github.com/alexpuertasr/react-qr-scanner/issues"},"homepage":"https://github.com/alexpuertasr/react-qr-scanner#readme","main":"dist/cjs/index.js","module":"dist/esm/index.js","types":"dist/index.d.ts","scripts":{"build":"rollup -c","build:esm":"tsc","build:cjs":"tsc --module CommonJS --outDir dist/cjs","storybook":"NODE_OPTIONS=--openssl-legacy-provider && storybook dev -p 6006","build-storybook":"storybook build","publish":"npm publish --access public","publish-beta":"npm publish --tag beta"},"devDependencies":{"@babel/preset-env":"^7.23.9","@babel/preset-react":"^7.23.3","@babel/preset-typescript":"^7.23.3","@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-node-resolve":"^15.2.3","@rollup/plugin-typescript":"^11.1.6","@storybook/addon-actions":"^7.6.16","@storybook/addon-essentials":"^7.6.16","@storybook/addon-interactions":"^7.6.16","@storybook/addon-links":"^7.6.16","@storybook/react":"^7.6.16","@storybook/react-webpack5":"7.6.16","@types/node":"^20.11.19","@types/react":"^18.2.56","@types/react-dom":"^18.2.19","react":"^18.2.0","react-dom":"^18.2.0","rollup":"^4.12.0","rollup-plugin-copy":"^3.5.0","rollup-plugin-dts":"^6.1.0","rollup-plugin-peer-deps-external":"^2.2.4","rollup-plugin-terser":"^7.0.2","storybook":"7.6.16","tslib":"^2.6.2","typescript":"^5.3.3"},"peerDependencies":{"react":"^17.0.2 || ^18.0.0","react-dom":"^17.0.2 || ^18.0.0"},"dependencies":{"@zxing/library":"^0.20.0"},"packageManager":"yarn@4.0.2","_id":"@alexpuertasr/react-qr-scanner@1.2.10","gitHead":"a780312ed0d4e96af27f0a522b4de96523240488","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-3d2TK2RBFzjh+S3o/o+Kt/zo4AJE+VoU9ow9qs0xgUqEyoOr6+JiI70YwdiSwDPNMmrj8ImqcVkMZ9THa6GQxA==","shasum":"600d8205d9e7ee2037960f519a90cb5e3a35bb15","tarball":"https://registry.npmjs.org/@alexpuertasr/react-qr-scanner/-/react-qr-scanner-1.2.10.tgz","fileCount":43,"unpackedSize":4853554,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAh5zhZ1N/s5i5KuO1asjk8JKFO0QF8bku5xDIOBrkElAiB2lnWinq5NjMtI0aJChwdeBttg5f5D+dJR55M863kPMg=="}]},"_npmUser":{"name":"alexpuertasr","email":"alexpuertasr@gmail.com"},"directories":{},"maintainers":[{"name":"alexpuertasr","email":"alexpuertasr@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-qr-scanner_1.2.10_1710113088930_0.2680669788101433"},"_hasShrinkwrap":false}},"time":{"created":"2024-03-10T23:24:48.830Z","1.2.10":"2024-03-10T23:24:49.149Z","modified":"2024-03-10T23:24:49.655Z"},"maintainers":[{"name":"alexpuertasr","email":"alexpuertasr@gmail.com"}],"description":"A library to scan qr codes in react.","homepage":"https://github.com/alexpuertasr/react-qr-scanner#readme","repository":{"type":"git","url":"git+https://github.com/alexpuertasr/react-qr-scanner.git"},"author":{"name":"Yudiel Curbelo"},"bugs":{"url":"https://github.com/alexpuertasr/react-qr-scanner/issues"},"license":"MIT","readme":"### Features\n\n- Scan Qr Codes using a smartphone camera or webcam.\n\n### Demo\nCheckout the [Demo](https://yudielcurbelo.github.io/react-qr-scanner/).\n\n### Install\n\n yarn add @yudiel/react-qr-scanner\n\n npm install @yudiel/react-qr-scanner\n\n### Usage\n\n```jsx\nimport {QrScanner} from '@yudiel/react-qr-scanner';\n\nconst App = () => {\n return (\n console.log(result)}\n onError={(error) => console.log(error?.message)}\n />\n );\n}\n```\n\n### Supported Formats\n\n| 1D product | 1D industrial | 2D |\n|-------------|---------------|--------------|\n| UPC-A | Code 39 | QR Code |\n| EAN-8 | Code 128 | Data Matrix |\n| EAN-13 | RSS-14 | Aztec |\n| | | PDF 417 |\n\n### Limitations\n- Due to browser implementations the camera can only be accessed over https or localhost.\n- Server side rendering won't work so only require the component when rendering in a browser environment.\n\n### API\n| Properties | Types | Default Value | Description |\n|----------------|-------------------------------------------------------------------------------------------------|---------------------------------|-------------------------------------------------------------------|\n| constraints | [MediaTrackConstraints](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints) | `{ facingMode: 'environment' }` | Specify which camera should be used (if available). |\n| containerStyle | `object` | none | Style object for the container element. |\n| videoStyle | `object` | none | Style object for the video element. |\n| scanDelay | `number` | `500` | The scan period for the QR hook. |\n| videoId | `string` | `videoId` | The Id for the video element. |\n| onResult | `function` | none | Scan event handler for result object. |\n| onDecode | `function` | none | Scan event handler for decode value. |\n| onError | `function` | none | Scan event handler for error object. |\n| ViewFinder | `component` | none | ViewFinder component to rendering as overlay in the video element |\n| hideCount | `boolean` | `true` | Hide the scanned count as overlay in the video element |\n| stopDecoding | `boolean` | `false` | Stop the decoding process |\n","readmeFilename":"README.md"}