Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yardexx/qr_stringify
String QR generator for Dart.
https://github.com/yardexx/qr_stringify
cli code dart flutter generator package qr
Last synced: 9 days ago
JSON representation
String QR generator for Dart.
- Host: GitHub
- URL: https://github.com/yardexx/qr_stringify
- Owner: yardexx
- License: mit
- Created: 2022-12-19T19:29:15.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-06-12T08:04:43.000Z (over 1 year ago)
- Last Synced: 2024-12-06T16:45:42.457Z (2 months ago)
- Topics: cli, code, dart, flutter, generator, package, qr
- Language: Dart
- Homepage:
- Size: 346 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
QR Stringify
Small package to generate QR codes that can be used in terminal output.
💙 Powered by Very Good Tools 💙
> 🚧 Public API of this package is **NOT STABLE**. 🚧
>
> [As version suggests](https://semver.org/#spec-item-4), QR Stringify shouldn't be used in production! More about semantic versioning [here](https://semver.org/).
### Simple 🎈
Easy to use. Simply create QR builder and provide data. Additionally, you can adjust padding and
correction levels.
### Flexible 💃
You can extend `QrDrawer` class and make custom implementation for drawing QR code.
## Usage 🛠
### Adding dependency 📦
This package is currently **not available** on [pub.dev](https://pub.dev/).
To add `qr_stringify` to your `pubspec.yaml` file, use git dependency:
```yaml
dependencies:
qr_stringify:
git:
url: 'https://github.com/yardexx/qr_stringify.git'
```
### Creating QR Code 👷♂️
To generate code, create instance of `QrBuilder` and provide `data` which you want to encode into QR
Code. When you are satisfied with your settings, call `build()` to return QR code in form of `String`.
```dart
import 'package:qr_stringify/qr_stringify.dart';
// Creating builder
final builder = QrBuilder(data: 'Hello World');
// Building QR code
final code = builder.build();
```
> 💡 `QrBuilder` currently defaults to *utf8* drawer, which means, that QR code is generated using this charset. ASCII support is planned.
### Adding padding 🔳
If you wish to add more space around code (also called [quiet zone](https://www.marson.com.tw/en/faq/show.php?num=41)),
you can do so by adding padding.
```dart
final builder = QrBuilder(data: 'Hello World')
..padding = 1;
// QR code with padding
final code = builder.build();
```
### Error correction level 🔧
QR code can be generated with different levels of error corrections levels. These determine how much
damage can QR code sustain before being unreadable.
Higher level means higher percentage of code can be damaged. In `qr_stringify`, these value are
represented as `ErrorCorrectionLevel` with respective values:
- ErrorCorrectionLevel.L - up to 7% damage
- ErrorCorrectionLevel.M - up to 15% damage
- ErrorCorrectionLevel.Q - up to 25% damage
- ErrorCorrectionLevel.H - up to 30% damage
`QrBuilder` default value is `ErrorCorrectionLevel.L`.
You can choose other values by passing them in builder.
```dart
final builder = QrBuilder(data: 'Hello World')
..correctionLevel = ErrorCorrectionLevel.L;
```
> ❗ Be aware that higher level of correction will result in bigger code.
More about error correction in QR codes [here](https://blog.qrstuff.com/general/qr-code-error-correction).
### A note about line spacing (line height) 📝
While qr_stringify is designed to be used in terminal, not all terminals will display code correctly.
Some terminals which have bigger line spacing (> 1.0) will display a little bit of space between
each line of code.
Ideally, QR code should look like this:
In most cases, you will end up with code that looks like this:
But sometimes, you will get totally broken code:
Most of the time, first situation will occur which makes code still readable just **fine**. Second
case can be fixed by adjusting line spacing of terminal.
> ❗ Be aware of line spacing (line height) of terminal.
## Planned features 🗺
- ASCII support
- Borders
- Colors (ANSI)
- Title texts with links
## Contribution 🤝
For issues, bugs, or feature proposals feel free to [open issue](https://github.com/yardexx/qr_stringify/issues)
or [create PR](https://github.com/yardexx/qr_stringify/pulls).