KScan
0.9.2indexedEnables easy barcode scanning in apps using Google’s MLKit on Android and Apple's AVFoundation on iOS, supporting QR and EAN-13 formats with simple integration.
336
Stars
1
Used by
dependents
61
Health
/ 100
KScan
A Compose Multiplatform barcode scanning library for Android, iOS and Desktop.
| Android | iOS | Desktop |
|---|---|---|
Installation
Add the dependency to your commonMain source set:
implementation("io.github.ismai117:KScan:$version")
Platform Setup
Android - Uses Google ML Kit for barcode scanning.
iOS - Uses AVFoundation for camera and barcode scanning.
Windows / macOS / Linux - Uses JavaCV for camera and ZXing for barcode scanning.
Permissions
Android, iOS, macOS - Before displaying the ScannerView, your application must request and be granted camera permissions by the operating system. On iOS & macOS, add this to your Info.plist:
<key>NSCameraUsageDescription</key>
<string>Camera access is required for barcode scanning</string>
Usage
Basic
ScannerView(
codeTypes = listOf(BarcodeFormat.FORMAT_QR_CODE, BarcodeFormat.FORMAT_EAN_13)
) { result ->
when (result) {
is BarcodeResult.OnSuccess -> {
println("Barcode: ${result.barcode.data}")
}
is BarcodeResult.OnFailed -> {
println("Error: ${result.exception.message}")
}
BarcodeResult.OnCanceled -> {
println("Canceled")
}
}
}
Without Default UI
ScannerView(
codeTypes = listOf(BarcodeFormat.FORMAT_QR_CODE),
scannerUiOptions = null
) { result ->
// handle result
}
Custom Controls
Use ScannerController for torch and zoom:
val scannerController = remember { ScannerController() }
ScannerView(
codeTypes = listOf(BarcodeFormat.FORMAT_ALL_FORMATS),
scannerUiOptions = null,
scannerController = scannerController
) { result ->
// handle result
}
// Torch control
Button(onClick = { scannerController.setTorch(!scannerController.torchEnabled) }) {
Text("Toggle Torch")
}
// Zoom control
Slider(
value = scannerController.zoomRatio,
onValueChange = scannerController::setZoom,
valueRange = 1f..scannerController.maxZoomRatio
)
Scanning from Images
Use scanImage to scan barcodes from static images (gallery, screenshots, downloaded images) instead of the live camera feed:
scanImage(
imageBytes = imageBytes, // ByteArray of the image (PNG, JPEG)
codeTypes = listOf(BarcodeFormat.FORMAT_ALL_FORMATS),
filter = { barcode -> true }, // Optional: filter detected barcodes
) { result ->
when (result) {
is BarcodeResult.OnSuccess -> {
println("Barcode: ${result.barcode.data}")
println("Format: ${result.barcode.format}")
}
is BarcodeResult.OnFailed -> {
println("Error: ")
}
BarcodeResult.OnCanceled -> {
}
}
}
Supported Formats
Use BarcodeFormat.FORMAT_ALL_FORMATS to scan all supported types.
License
Copyright 2024 ismai117
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Contributing
Contributions are welcome! Feel free to open issues or submit pull requests.