Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexzhirkevich/qrose
Styled QR & Barcode generation library for Compose Multiplatform and Jetpack Compose
https://github.com/alexzhirkevich/qrose
compose compose-multiplatform jetpack-compose kotlin kotlin-multiplatform multiplatform qr qr-code qr-code-generator qr-generator qrcode
Last synced: 3 months ago
JSON representation
Styled QR & Barcode generation library for Compose Multiplatform and Jetpack Compose
- Host: GitHub
- URL: https://github.com/alexzhirkevich/qrose
- Owner: alexzhirkevich
- License: mit
- Created: 2023-10-14T12:50:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-12T17:47:32.000Z (5 months ago)
- Last Synced: 2024-07-12T21:13:30.191Z (4 months ago)
- Topics: compose, compose-multiplatform, jetpack-compose, kotlin, kotlin-multiplatform, multiplatform, qr, qr-code, qr-code-generator, qr-generator, qrcode
- Language: Kotlin
- Homepage:
- Size: 352 KB
- Stars: 245
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- kmp-awesome - QRose - Multiplatform QR code generator (Libraries / 🍎 Compose UI)
- awesome - QRose
README
# QRose
Barcode generation library for Compose Multiplatform
Why QRose?
- **Lightweight** - doesn't contain any dependencies except of `compose.ui`;
- **Flexible** - high customization ability that is open for extension;
- **Efficient** - declare and render codes synchronously right from the composition in 60+ fps;
- **Scalable** - no raster bitmaps, only scalable vector graphics;
- **Multiplatform** - supports all the targets supported by Compose Multiplatform.
- **Multiformat** - multiple formats supported: `QR`, `UPC`, `EAN`, `Code 128/93/39`, `Codabar`, `ITF`.
# Installation
[](https://maven-badges.herokuapp.com/maven-central/io.github.alexzhirkevich/qrose)
```gradle
dependencies {
// For QR codes
implementation("io.github.alexzhirkevich:qrose:")
// For single-dimension barcodes (UPC,EAN, Code128, ...)
implementation("io.github.alexzhirkevich:qrose-oned:")
}
```
# Usage
## Basic
You can create code right in composition using `rememberQrCodePainter`, `rememberBarcodePainter`.
Or use `QrCodePainter`, `BarcodePainter` to create it outside of Compose.
```kotlin
Image(
painter = rememberQrCodePainter("https://example.com"),
contentDescription = "QR code referring to the example.com website"
)
Image(
painter = rememberBarcodePainter("9780201379624", BarcodeType.EAN13),
contentDescription = "EAN barcode for some product"
)
```
## Design
QR codes have flexible styling options, for example:
```kotlin
val logoPainter : Painter = painterResource("logo.png")
val qrcodePainter : Painter = rememberQrCodePainter("https://example.com") {
logo {
painter = logoPainter
padding = QrLogoPadding.Natural(.1f)
shape = QrLogoShape.circle()
size = 0.2f
}
shapes {
ball = QrBallShape.circle()
darkPixel = QrPixelShape.roundCorners()
frame = QrFrameShape.roundCorners(.25f)
}
colors {
dark = QrBrush.brush {
Brush.linearGradient(
0f to Color.Red,
1f to Color.Blue,
end = Offset(it, it)
)
}
frame = QrBrush.solid(Color.Black)
}
}
```
Or just parametrized constructor:
```kotlin
val qrcodePainter = rememberQrCodePainter(
data = "https://example.com",
shapes = QrShapes(
darkPixel = QrPixelShape.roundCorners()
)
)
```
## Customize
You can create your own shapes for each QR code part, for example:
```kotlin
class MyCircleBallShape : QrBallShape {
override fun Path.path(size: Float, neighbors: Neighbors): Path = apply {
addOval(Rect(0f,0f, size, size))
}
}
```
> **Note**
>A path here uses [`PathFillType.EvenOdd`](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/PathFillType#EvenOdd()) that cannot be changed.
## Data types
QR codes can hold various payload types: Text, Wi-Fi, E-mail, vCard, etc.
`QrData` object can be used to perform such encodings, for example:
```kotlin
val wifiData : String = QrData.wifi(ssid = "My Network", psk = "12345678")
val wifiCode = rememberQrCodePainter(wifiData)
```
## Export
QR codes can be exported to `PNG`, `JPEG` and `WEBP` formats using `toByteArray` function:
```kotlin
val painter : Painter = QrCodePainter(
data = "https://example.com",
options = QrOptions {
colors {
//...
}
}
)
val bytes : ByteArray = painter.toByteArray(1024, 1024, ImageFormat.PNG)
```