{"id":21879174,"url":"https://github.com/typpo/mjml-qr-code","last_synced_at":"2025-08-03T03:11:58.703Z","repository":{"id":37968756,"uuid":"266642453","full_name":"typpo/mjml-qr-code","owner":"typpo","description":"Embed QR codes in your emails","archived":false,"fork":false,"pushed_at":"2024-06-18T17:45:39.000Z","size":1483,"stargazers_count":12,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T14:51:07.969Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/typpo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2020-05-24T23:33:31.000Z","updated_at":"2024-11-29T10:18:01.000Z","dependencies_parsed_at":"2023-02-08T08:01:29.329Z","dependency_job_id":"6483926b-acb9-4379-b7d0-395f1816bdd3","html_url":"https://github.com/typpo/mjml-qr-code","commit_stats":{"total_commits":32,"total_committers":2,"mean_commits":16.0,"dds":0.5,"last_synced_commit":"a30f07268aab16569090355860155c708d8a24c3"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typpo%2Fmjml-qr-code","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typpo%2Fmjml-qr-code/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typpo%2Fmjml-qr-code/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typpo%2Fmjml-qr-code/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typpo","download_url":"https://codeload.github.com/typpo/mjml-qr-code/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248530604,"owners_count":21119601,"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-28T08:15:29.500Z","updated_at":"2025-04-15T03:07:20.724Z","avatar_url":"https://github.com/typpo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mjml-qr-code\n[![npm](https://img.shields.io/npm/v/mjml-qr-code)](https://www.npmjs.com/package/mjml-qr-code)\n[![Build Status](https://travis-ci.com/typpo/mjml-qr-code.svg?branch=master)](https://travis-ci.com/typpo/mjml-qr-code)\n\nA component for adding QR codes to your email using an open-source [QuickChart](https://quickchart.io) provider.\n\n## Usage\n\nThis mjml...\n\n```html\n\u003cmjml\u003e\n  \u003cmj-body\u003e\n    \u003cmj-section\u003e\n      \u003cmj-column\u003e\n        \u003cmj-qr-code value=\"hello world\" /\u003e\n      \u003c/mj-column\u003e\n    \u003c/mj-section\u003e\n  \u003c/mj-body\u003e\n\u003c/mjml\u003e\n```\n\nWill show this QR code:\n\n![QR code](https://quickchart.io/qr?text=hello%20world)\n\nCustomize the color, size, positioning, and other QR parameters using the attributes below.\n\n## Setup\n\nInstall via npm:\n\n```\nnpm install mjml-qr-code --save\n```\n\nThen add the package to your `.mjmlconfig`:\n\n```\n{\n  \"packages\": [\n    \"mjml-qr-code/lib/MjQrCode.js\"\n  ]\n}\n```\n\n## Attributes\n\nThe `\u003cmj-qr-code\u003e` tag supports all the attributes of the `\u003cmj-image\u003e` tag.  View those attributes [here](https://mjml.io/documentation/#mjml-image).\n\nIn addition to regular image attributes which you can using for sizing and positioning, the component supports the following QR-specific attributes:\n\n| Name                   | Description                                               | Required? | Default        |   |\n|------------------------|-----------------------------------------------------------|-----------|----------------|---|\n| value                  | The content encoded in your QR code                       | Yes       |                |   |\n| color       | The color of the QR code                                  | No        | 000000 (black) |   |\n| background-color       | The background of the QR code                             | No        | ffffff (white) |   |\n| qr-margin              | The number of QR blocks to leave empty around the QR code | No        | 4              |   |\n| error-correction-level | The QR [error correction level](https://en.wikipedia.org/wiki/QR_code#Error_correction)                             | No        | M              |   |\n| width                  | Width of the QR code image                                | No        | 200            |   |\n| host                   | The host of the QR image server                           | No        | quickchart.io  |   |\n| protocol               | The protocol of the QR image server                       | No        | https          |   |\n\n## Hosting\n\nBy default, this component uses the public [QuickChart](https://quickchart.io) web service to render QR codes, but you can use the `host` attribute to point to your own QR renderer.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftyppo%2Fmjml-qr-code","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftyppo%2Fmjml-qr-code","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftyppo%2Fmjml-qr-code/lists"}