{"id":21546503,"url":"https://github.com/extrievetechnologies/quickcapture_react_native","last_synced_at":"2026-02-26T07:17:07.058Z","repository":{"id":230377301,"uuid":"779213018","full_name":"ExtrieveTechnologies/QuickCapture_react_native","owner":"ExtrieveTechnologies","description":"QuickCapture SDK port for react-native","archived":false,"fork":false,"pushed_at":"2024-08-09T11:04:03.000Z","size":2105,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T10:42:24.619Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ExtrieveTechnologies.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-29T09:50:22.000Z","updated_at":"2024-09-11T19:29:38.000Z","dependencies_parsed_at":"2024-03-29T11:23:41.575Z","dependency_job_id":"604d9230-888c-45ad-a29f-e187b7521550","html_url":"https://github.com/ExtrieveTechnologies/QuickCapture_react_native","commit_stats":null,"previous_names":["extrievetechnologies/quickcapture_react_native"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExtrieveTechnologies%2FQuickCapture_react_native","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExtrieveTechnologies%2FQuickCapture_react_native/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExtrieveTechnologies%2FQuickCapture_react_native/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExtrieveTechnologies%2FQuickCapture_react_native/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ExtrieveTechnologies","download_url":"https://codeload.github.com/ExtrieveTechnologies/QuickCapture_react_native/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248166927,"owners_count":21058480,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T06:12:22.645Z","updated_at":"2026-02-26T07:17:07.030Z","avatar_url":"https://github.com/ExtrieveTechnologies.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# quickcapture_react_native\n\nA React Native port of quickcapture for easy integration into mobile applications.\n\nThe Quickcapture plugin offers functionalities for capturing documents and optical codes (like QR codes and barcodes), building PDFs from captured images, and generating QR and barcode images from provided data. This document guides you through the installation and utilization of the Quickcapture plugin in your React Native application.\n\n## Installation\n\nFollow these steps to install the Quickcapture plugin using either npm or Yarn, depending on your preference:\n\n**Using npm**\n\n1. Add the Package:\n```bash\nnpm install @extrieve_technologies/quickcapture_react_native\n```\n2. Link the Package:\nIf you are using React Native 0.60 or above, autolinking will handle the rest. For iOS, you must run:\n```bash\ncd ios \u0026\u0026 pod  install \u0026\u0026 cd..\n```\n\n3. Rebuild Your Application:\n\nRebuild your application to ensure all native dependencies are properly linked.\nFor iOS:\n```bash\nnpx react-native run-ios\n```\nFor Android:\n\n```bash\nnpx react-native run-android\n```\n**Using Yarn**\n\n1. Add the Package:\n```bash\nyarn add @extrieve_technologies/quickcapture_react_native\n```\n\n## Usage\n1. First, import the necessary modules and initialize quickcapture:\n\n\t```js\n\timport {\n\t\t//If need to activate the SDK without restrictions - optional\n\t\tactivateLicense,\n\t\t//TO initialise license - mandatory\n\t\tinitialise,\n\t\t//For Document Capture capabilities, add following - optional\n\t\tcaptureDocument,\n\t\tbuildPdfForLastDocumentCapture,\n\t\t//For Bar/QR Code capabilities, add following - optional\n\t\tcaptureOpticalCode,\n\t\tgenerateQRCode,\n\t\tgenerateBarcode,\n\t} from  '@extrieve_technologies/quickcapture_react_native';\n\n\t// Initialize Quickcapture\n\t//activateLicense('Your Android license key', 'Your iOS license key');\n\tactivateLicense(androidLicense, iosLicense).then((response) =\u003e {\n\t\t//response - true/false\n\t});\n\n\t//call plugin initialisation\n\tinitialise();\n\t```\n2.  **captureDocument** : To start capturing images, call startCapture. This function returns a promise that resolves with the JSON string having an array of the captured images file path:\n\n\t```js\n\tcaptureDocument().then((resultString) =\u003e {\n\t\tconst result = JSON.parse(resultString);\n\t})\n\t.catch((error) =\u003e {\n\t\tconsole.error('Error starting capture:', error);\n\t});\n\t```\n3.  **buildPdfForLastDocumentCapture** : To build a PDF from the last capture set, use buildPdfForLastCapture. This function also returns a promise that resolves with the path to the generated PDF:\n\n\t```js\n\tbuildPdfForLastCapture().then(pdfFilePath  =\u003e {\n\t\tconsole.log(`Generated PDF path: ${pdfFilePath}`);\n\t}).catch(error  =\u003e {\n\t\tconsole.error(`PDF generation error: ${error}`);\n\t});\n\t```\n\n3.  **captureOpticalCode** : To Captures an optical code (QR code or barcode) using the device camera.Will returns a promise that resolves to the scanned code data in JSON string\n\t```js\n\tcaptureOpticalCode().then((resultString) =\u003e {\n\t\t//handle JSON data here.\n\t\tconst  result = JSON.parse(resultString);\n\t\tconsole.log('Scanned code : ', result.DATA);\n\t})\n\t.catch((error) =\u003e {\n\t\tconsole.error('Error Scanning code:', error);\n\t});\n\t```\n\n3.  **generateQRCode** : Generates a QR code from provided data.Need to provide a data in string.in return, a promise that resolves data with Base64 data of the generated QR code image will get.\n\t```js\n\tgenerateQRCode(qrText).then((base64String) =\u003e {\n\t\t// use barcode image in Base64 data format here.\n\t\t//image encoded and a PNG image in Base64 format\n\t\t//setBase64Image(base64String);\n\t\tAlert.alert('The QR code was generated successfully');\n\t})\n\t.catch((error) =\u003e {\n\t\tconsole.error('Error generating QR code:', error);\n\t\tAlert.alert('QR Generation Error', `Error: ${error.message}`);\n\t});\n\t```\n\n3.  **generateBarcode** : Generates a BAR code from provided data.Need to provide a data in string and also can specify if the BARcode with text needed.In return, a promise that resolves data with Base64 data of the generated BAR code image will get.\n\t```js\n\tgenerateBarcode(qrText, enableText).then((base64String) =\u003e {\n\t\t// use barcode image in Base64 data format here.\n\t\t//image encoded and a PNG image in Base64 format\n\t\t//setBase64Image(base64String);\n\t\tAlert.alert('Barcode generated successfully.');\n\t})\n\t.catch((error) =\u003e {\n\t\tconsole.error('Error generating QR code:', error);\n\t\tAlert.alert('QR Generation Error', `Error: ${error.message}`);\n\t});\n\t```\n## Contributing\n\nSee the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.\n\n## License\nMIT\n\nMade with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fextrievetechnologies%2Fquickcapture_react_native","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fextrievetechnologies%2Fquickcapture_react_native","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fextrievetechnologies%2Fquickcapture_react_native/lists"}