Skip to content

feat: Allow custom selection of action buttons #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
itsarvinddev merged 1 commit into from
Oct 21, 2025
Merged

feat: Allow custom selection of action buttons #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions example/lib/main.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,20 @@ class _HomePageState extends State<HomePage> {
},
),
),
_buildDemoButton(
title: "Enabled Icons Only",
subtitle: "Only show camera switch and torch.",
scanner: AiBarcodeScanner(
galleryButtonType: GalleryButtonType.icon,
enabledActionButtons: const {
ScannerAction.cameraSwitch,
ScannerAction.torch,
},
onDetect: (BarcodeCapture capture) {
/// Do something with the barcode
},
),
),
_buildDemoButton(
title: "None Gallery Button",
subtitle: "Shows no gallery button.",
Expand Down
131 changes: 82 additions & 49 deletions lib/src/ai_barcode_scanner.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ import 'error_builder.dart';
import 'gallery_button.dart';
import 'overlay.dart';

/// The set of quick action controls that can be shown alongside the scanner.
enum ScannerAction { cameraSwitch, torch, gallery }

/// The main barcode scanner widget.
class AiBarcodeScanner extends StatefulWidget {
/// Defines how the camera preview will be fitted into the layout.
Expand Down Expand Up @@ -115,6 +118,9 @@ class AiBarcodeScanner extends StatefulWidget {
/// Custom icon for the flashlight when off
final IconData flashOffIcon;

/// Controls which quick action icons (camera switch, torch, gallery) are displayed.
final Set<ScannerAction> enabledActionButtons;

/// Whether to return the raw image data (Uint8List) along with the BarcodeCapture.
/// This can be useful for post-scan image processing such as color analysis or saving the frame.
/// Defaults to `false`.
Expand Down Expand Up @@ -161,6 +167,11 @@ class AiBarcodeScanner extends StatefulWidget {
this.cameraSwitchIcon = CupertinoIcons.arrow_2_circlepath,
this.flashOnIcon = CupertinoIcons.bolt_fill,
this.flashOffIcon = CupertinoIcons.bolt,
this.enabledActionButtons = const {
ScannerAction.gallery,
ScannerAction.cameraSwitch,
ScannerAction.torch,
},
this.returnImage = false,
this.onCustomImagePicker,
this.child,
Expand Down Expand Up @@ -261,49 +272,27 @@ class _AiBarcodeScannerState extends State<AiBarcodeScanner> {

/// default action icons
/// camera switch and torch for easier access
final actionIcons = [
IconButton.filled(
style: IconButton.styleFrom(
backgroundColor: CupertinoColors.systemGrey6,
foregroundColor: CupertinoColors.darkBackgroundGray,
),
icon: Icon(widget.cameraSwitchIcon),
onPressed: () async {
await _controller.switchCamera();
setState(() {});
},
),
IconButton.filled(
style: IconButton.styleFrom(
backgroundColor: isTorchOn
? CupertinoColors.activeOrange
: CupertinoColors.systemGrey6,
foregroundColor: CupertinoColors.darkBackgroundGray,
),
icon: Icon(isTorchOn ? widget.flashOnIcon : widget.flashOffIcon),
onPressed: () async {
await _controller.toggleTorch();
setState(() {});
},
)
];
final actionButtons = _buildActionButtons(isTorchOn);
final showGalleryAction =
widget.enabledActionButtons.contains(ScannerAction.gallery);

return Scaffold(
appBar: widget.appBarBuilder?.call(context, _controller) ??
AppBar(
backgroundColor: Colors.transparent,
actions: [
if (widget.galleryButtonType == GalleryButtonType.icon) ...[
GalleryButton.icon(
onImagePick: widget.onImagePick,
onDetect: widget.onDetect,
validator: widget.validator,
controller: _controller,
isSuccess: _isSuccess,
text: widget.galleryButtonText,
onCustomImagePicker: widget.onCustomImagePicker,
),
...actionIcons,
if (showGalleryAction)
GalleryButton.icon(
onImagePick: widget.onImagePick,
onDetect: widget.onDetect,
validator: widget.validator,
controller: _controller,
isSuccess: _isSuccess,
text: widget.galleryButtonText,
onCustomImagePicker: widget.onCustomImagePicker,
),
...actionButtons,
],
...?widget.actions,
],
Expand Down Expand Up @@ -363,7 +352,8 @@ class _AiBarcodeScannerState extends State<AiBarcodeScanner> {
useAppLifecycleState: widget.useAppLifecycleState,
),
widget.child ??
(widget.galleryButtonType == GalleryButtonType.filled
(widget.galleryButtonType == GalleryButtonType.filled &&
(showGalleryAction || actionButtons.isNotEmpty)
? Align(
alignment: widget.galleryButtonAlignment ??
Alignment.lerp(
Expand All @@ -375,18 +365,20 @@ class _AiBarcodeScannerState extends State<AiBarcodeScanner> {
mainAxisAlignment: MainAxisAlignment.center,
mainAxisSize: MainAxisSize.min,
children: [
GalleryButton(
onImagePick: widget.onImagePick,
onDetect: widget.onDetect,
validator: widget.validator,
controller: _controller,
isSuccess: _isSuccess,
text: widget.galleryButtonText,
icon: widget.galleryIcon,
onCustomImagePicker: widget.onCustomImagePicker,
),
const SizedBox(width: 4),
...actionIcons,
if (showGalleryAction)
GalleryButton(
onImagePick: widget.onImagePick,
onDetect: widget.onDetect,
validator: widget.validator,
controller: _controller,
isSuccess: _isSuccess,
text: widget.galleryButtonText,
icon: widget.galleryIcon,
onCustomImagePicker: widget.onCustomImagePicker,
),
if (showGalleryAction && actionButtons.isNotEmpty)
const SizedBox(width: 4),
...actionButtons,
],
),
)
Expand Down Expand Up @@ -433,4 +425,45 @@ class _AiBarcodeScannerState extends State<AiBarcodeScanner> {
}
});
}

List<Widget> _buildActionButtons(bool isTorchOn) {
final actions = widget.enabledActionButtons;
final icons = <Widget>[];

if (actions.contains(ScannerAction.cameraSwitch)) {
icons.add(
IconButton.filled(
style: IconButton.styleFrom(
backgroundColor: CupertinoColors.systemGrey6,
foregroundColor: CupertinoColors.darkBackgroundGray,
),
icon: Icon(widget.cameraSwitchIcon),
onPressed: () async {
await _controller.switchCamera();
setState(() {});
},
),
);
}

if (actions.contains(ScannerAction.torch)) {
icons.add(
IconButton.filled(
style: IconButton.styleFrom(
backgroundColor: isTorchOn
? CupertinoColors.activeOrange
: CupertinoColors.systemGrey6,
foregroundColor: CupertinoColors.darkBackgroundGray,
),
icon: Icon(isTorchOn ? widget.flashOnIcon : widget.flashOffIcon),
onPressed: () async {
await _controller.toggleTorch();
setState(() {});
},
),
);
}

return icons;
}
}
Loading