gal 1.8.6 gal: ^1.8.6 copied to clipboard
Gal is a Flutter plugin for saving image/video to gallary app. You can also easily handle permissions.
Gal πΌοΈ #
Easy to use Dart3 plugin for saving image/video to gallery app #
Please leave a likeπ and starβοΈ for more features.
Support | iOS 11.0+ | Android SDK 21+ |
---|---|---|
Example |
β¨ Features #
- Open gallery
- Save video (to album)
- Save image (to album)
- Handle permission
- Handle errors
- Lots of docs and wiki
π Get started #
Add dependency #
You can use the command to add gal as a dependency with the latest stable version:
$ flutter pub add gal
iOS #
Add the following key to your Info.plist file, located in
<project root>/ios/Runner/Info.plist
:
<key>NSPhotoLibraryAddUsageDescription</key>
<key>NSPhotoLibraryUsageDescription</key>
Requried If you want to save media to album.
you can copy from Info.plist in example.
Android (API <29) #
Add the following key to your AndroidManifest file, located in
<project root>/android/app/src/main/AndroidManifest.xml
:
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="29" />
you can copy from AndroidManifest.xml in example.
π΄ Warning: Android emulators with API < 29 require SD card setup. Real devices don't.
β Usage #
Save from local #
// Save Image (Supports two ways)
await Gal.putImage('$filePath');
await Gal.putImageBytes('$uint8List');
// Save Video
await Gal.putVideo('$filePath');
// Save to album
await Gal.putImage('$filePath', album: '$album')
...
Download from Internet #
$ flutter pub add dio
// Download Image
final imagePath = '${Directory.systemTemp.path}/image.jpg';
await Dio().download('$url',imagePath);
await Gal.putImage(imagePath);
// Download Video
final videoPath = '${Directory.systemTemp.path}/video.mp4';
await Dio().download('$url',videoPath);
await Gal.putVideo(videoPath);
Save from Camera #
$ flutter pub add image_picker
// Shot and Save
final image = await ImagePicker.pickImage(source: ImageSource.camera);
await Gal.putImage(image.path);
$ flutter pub add camera
// Record and Save
...
final video = await controller.stopVideoRecording();
await Gal.putVideo(video.path);
Handle Permission #
// Check Permission
await Gal.hasAccess();
// Request Permission
await Gal.requestAccess();
Handle Errors #
// Save Image with try-catch
try {
await Gal.putImage($imagePath);
} on GalException catch (e) {
log(e.type.message);
}
// Exception Type
enum GalExceptionType {
accessDenied,
notEnoughSpace,
notSupportedFormat,
unexpected;
String get message => switch (this) {
accessDenied => 'You do not have permission to access the gallery app.',
notEnoughSpace => 'Not enough space for storage.',
notSupportedFormat => 'Unsupported file formats.',
unexpected => 'An unexpected error has occurred.',
};
}
π― Example #
Here is a minimal example. A best practice and more detailed one can be found in example.
import 'package:flutter/material.dart';
import 'package:gal/gal.dart';
void main() => runApp(const App());
class App extends StatelessWidget {
const App({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
body: Column(
children: [
TextButton(
onPressed: () async => Gal.open(),
child: const Text('Open Gallery'),
),
TextButton(
onPressed: () async => Gal.putVideo('VIDEO_PATH'),
child: const Text('Save Video'),
),
TextButton(
onPressed: () async => Gal.putImage('IMAGE_PATH'),
child: const Text('Save Image'),
),
TextButton(
onPressed: () async => Gal.hasAccess(),
child: const Text('Chack Permission'),
),
TextButton(
onPressed: () async => Gal.requestAccess(),
child: const Text('Request Permission'),
),
],
),
),
);
}
}