QR.Flutter 是一個輕量級的 Flutter 套件,讓開發者能透過元件或自訂繪圖工具有效率地產生 QR 碼。它支援多個平台,包括 Android、iOS、Web、macOS、Windows 與 Linux,非常適合跨平台應用程式。該函式庫提供簡單的 API,可自訂 QR 碼的大小、顏色與錯誤校正等級。設計上強調快速性能,並易於整合至現有的 Flutter 專案中。
適用情境
為登入權杖產生二維碼
建立產品或活動票券
分享網址或聯絡資訊
在應用程式中整合QR碼掃描
以QR碼顯示動態資料
主要特色
基於小部件的簡單二維碼產生
對自定義繪製器的支援
跨平台相容性
可設定的錯誤校正等級
可客製化的顏色和尺寸
快速渲染性能
適合對象
行動應用開發者
Web 應用程式創建者
事件票務系統
身分驗證工作流程
數位名片
使用建議
僅限生成二維碼(不支援掃描)
需要手動處理圖像匯出
無內建QR碼讀取支援
可能需要額外的套件以支援掃描功能
未針對非常大的二維碼進行優化
原始 README
以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。
QR.Flutter is a Flutter library for simple and fast QR code rendering via a Widget or custom painter.
Need help?
Please do not submit an issue for a "How do i ..?" or "What is the deal with ..?" type question. They will pretty much be closed instantly. If you have questions, please ask them on the Discussions board or on Stack Overflow. They will get answered there.
Using issues creates a large amount of noise and results in real issues getting fixed slower.
Automatic QR code version/type detection or manual entry
Supports QR code versions 1 - 40
Error correction / redundancy
Configurable output size, padding, background and foreground colors
Supports image overlays
Export to image data to save to file or use in memory
No internet connection required
Installing
Version compatibility: 4.0.0+ supports null safety and requires a version of Flutter that is compatible.
If you're using an incompatible version of flutter, please use a 3.x version of this library.
You should add the following to your pubspec.yaml file:
dependencies:qr_flutter:^4.1.0
Note: If you're using the Flutter master channel, if you encounter build issues, or want to try the latest and greatest then you should use the master branch and not a specific release version. To do so, use the following configuration in your pubspec.yaml:
Depending on your data requirements you may want to tweak the QR code output. The following options are available:
Property
Type
Description
version
int
QrVersions.auto or a value between 1 and 40. See http://www.qrcode.com/en/about/version.html for limitations and details.
errorCorrectionLevel
int
A value defined on QrErrorCorrectLevel. e.g.: QrErrorCorrectLevel.L.
size
double
The (square) size of the image. If not given, will auto size using shortest size constraint.
padding
EdgeInsets
Padding surrounding the QR code data.
backgroundColor
Color
The background color (default is none).
eyeStyle
QrEyeStyle
Configures the QR code eyes' (corners') shape and color.
dataModuleStyle
QrDataModuleStyle
Configures the shape and the color of the dots.
gapless
bool
Adds an extra pixel in size to prevent gaps (default is true).
errorStateBuilder
QrErrorBuilder
Allows you to show an error state Widget in the event there is an error rendering the QR code (e.g.: version is too low, input is too long, etc).
constrainErrorBounds
bool
If true, the error Widget will be constrained to the square that the QR code was going to be drawn in. If false, the error state Widget will grow/shrink to whatever size it needs.
embeddedImage
ImageProvider
An ImageProvider that defines an image to be overlaid in the center of the QR code.
embeddedImageStyle
QrEmbeddedImageStyle
Properties to style the embedded image.
embeddedImageEmitsError
bool
If true, any failure to load the embedded image will trigger the errorStateBuilder or render an empty Container. If false, the QR code will be rendered and the embedded image will be ignored.
semanticsLabel
String
semanticsLabel will be used by screen readers to describe the content of the QR code.
borderRadius
double
Setting corner rounding for shape types QrEyeShape.square, QrDataModuleShape.square, EmbeddedImageShape.square. Set in appropriate styles.
roundedOutsideCorners
bool
If true, the outer corners of the data are rounded. Set to QrDataModuleStyle. Rounded to borderRadius by default. Only QrDataModuleShape.square.
outsideBorderRadius
double
It is set if the outer rounding outsideBorderRadius should differ from the inner one borderRadius. No more than borderRadius. Only QrDataModuleShape.square
gradient
Gradient
Changing the solid color of the code to a gradient, e.g. LinearGradient.
safeArea
bool
If true, data is hidden behind the embeddedImage. Set to QrEmbeddedImageStyle.
safeAreaMultiplier
double
Multiplier safeArea size.
Examples
There is a simple, working, example Flutter app in the /example directory. You can use it to play with all
the options.
Also, the following examples give you a quick overview on how to use the library.
A basic QR code will look something like:
QrImageView(
data: 'This is a simple QR code',
version: QrVersions.auto,
size: 320,
gapless: false,
)
A QR code with an image (from your application's assets) will look like:
QrImageView(
data: 'This QR code has an embedded image as well',
version: QrVersions.auto,
size: 320,
gapless: false,
embeddedImage: AssetImage('assets/images/my_embedded_image.png'),
embeddedImageStyle: QrEmbeddedImageStyle(
size: Size(80, 80),
),
)
To show an error state in the event that the QR code can't be validated:
QrImageView(
data: 'This QR code will show the error state instead',
version: 1,
size: 320,
gapless: false,
errorStateBuilder: (cxt, err) {
returnContainer(
child: Center(
child: Text(
'Uh oh! Something went wrong...',
textAlign: TextAlign.center,
),
),
);
},
)
A QR code with inside and outside corners rounding and safe area of embedded image:
QrImageView(
data: 'London is the capital of Great Britain',
version: QrVersions.auto,
size: 320,
eyeStyle: constQrEyeStyle(
borderRadius: 10,
),
dataModuleStyle: constQrDataModuleStyle(
borderRadius: 5,
roundedOutsideCorners: true,
),
embeddedImage: AssetImage('assets/images/my_embedded_image.png'),
embeddedImageStyle: QrEmbeddedImageStyle(
size: Size.square(40),
color: Colors.white,
safeArea: true,
safeAreaMultiplier: 1.1,
embeddedImageShape: EmbeddedImageShape.square,
borderRadius: 10,
),
)