{"id":15107774,"url":"https://github.com/vkcom/vk-qr","last_synced_at":"2025-04-03T03:13:29.710Z","repository":{"id":34945384,"uuid":"171461490","full_name":"VKCOM/vk-qr","owner":"VKCOM","description":"VK QR Code generator library","archived":false,"fork":false,"pushed_at":"2024-06-26T11:46:24.000Z","size":980,"stargazers_count":62,"open_issues_count":15,"forks_count":10,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-03T03:13:25.367Z","etag":null,"topics":["qr","qr-code","qr-generator","qrcode","vk"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/VKCOM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-19T11:25:52.000Z","updated_at":"2025-01-15T16:39:13.000Z","dependencies_parsed_at":"2024-06-18T16:55:59.212Z","dependency_job_id":"bc19935c-0ca4-4079-81ec-9e1b9ea1fbda","html_url":"https://github.com/VKCOM/vk-qr","commit_stats":{"total_commits":92,"total_committers":13,"mean_commits":7.076923076923077,"dds":0.7717391304347826,"last_synced_commit":"25edbf094ecb203eaf6f8595ba7cd95e072d3b8b"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VKCOM%2Fvk-qr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VKCOM%2Fvk-qr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VKCOM%2Fvk-qr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VKCOM%2Fvk-qr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VKCOM","download_url":"https://codeload.github.com/VKCOM/vk-qr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246927839,"owners_count":20856198,"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":["qr","qr-code","qr-generator","qrcode","vk"],"created_at":"2024-09-25T21:41:35.358Z","updated_at":"2025-04-03T03:13:29.690Z","avatar_url":"https://github.com/VKCOM.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n[\u003cimg width=\"150\" height=\"150\" src=\"https://user-images.githubusercontent.com/45998835/154472026-cae3934d-8013-4898-b7f0-cef7476a6424.png\"\u003e](https://github.com/VKCOM/vk-qr)\n\n[![npm][npm-shield]][npm-url] [![NPM][npm-downloads-shield]][npm-url] [![Build Status](https://travis-ci.org/VKCOM/vk-qr.svg?branch=master)](https://travis-ci.org/VKCOM/vk-qr)\n\n\u003c/div\u003e\n\n# VK-QR\n\nJavaScript library for generating SVG code of VK-style QR codes.\n\n## Usage\n\nInstall via yarn\n\n```\nyarn add @vkontakte/vk-qr\n```\n\nor npm\n\n```\nnpm install @vkontakte/vk-qr\n```\n\nAnd use in your code\n\n```js\nimport vkQr from '@vkontakte/vk-qr';\n\n// Returns SVG code of generated 256x256 QR code with VK logo\nconst qrSvg = vkQr.createQR('Text to encode', {\n  qrSize: 256,\n  isShowLogo: true\n});\n```\n\n## API Reference\n\n### Syntax\n\n```js\ngeneratedSvgCode = vkQr.createQR(text[, qrOptions]);\n```\n\n### Parameters\n\n- `text` _required_\n  String to generate a QR code\n\n- `options` _optional_\n  An options object containing any custom settings that you want to apply to the generated QR code. The possible options are:\n\n  - `qrSize`: Size of QR code.\n    Default is 128\n\n  - `className`: Class name of root SVG element\n\n  - `isShowLogo`: Show VK logo in center of QR code\n    Default is false\n\n  - `isShowBackground`: Show QR background. Default is false\n\n  - `backgroundColor`: QR code background HEX color. Works if `isShowBackground` is enabled. Default is \"#ffffff\"\n\n  - `foregroundColor`: QR code HEX color\n\n  - `logoColor`: Color of logo. Default is \"#4680c2\"\n\n  - `logoData`: Reference to logo as a reference IRI\n\n  - `suffix`: SVG elements id postfix\n\n  - `ecc`: ECC level in range [0-3] (0 - low, 3 - high)\n\n### Return value\n\nA string with SVG code.\n\n## License\n\nThe code is available under the [MIT](LICENSE) license.\n\n[npm-shield]: https://img.shields.io/npm/v/@vkontakte/vk-qr.svg\n[npm-url]: https://npmjs.com/package/@vkontakte/vk-qr\n[npm-downloads-shield]: https://img.shields.io/npm/dt/@vkontakte/vk-qr.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvkcom%2Fvk-qr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvkcom%2Fvk-qr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvkcom%2Fvk-qr/lists"}