GitLocker: The Coding Marketplace

Description:

image picker widget

image_picker_widget #

A new Flutter package to integrate image_picker with a simple Flutter widget, allowing you to edit an image without any problems with design code development

Preview
Modal image type picker

Getting Started #
Add the dependency in pubspec.yaml:
dependencies:
...
# Design
image_picker_widget: '>=2.0.0 <3.0.0
# For pre null-safety, use version 1.0.3'
copied to clipboard
A Flutter plugin for iOS and Android for picking images from the image library,
and taking new pictures with the camera.
Installation #
Since this package requires image_picker, and image_cropper you need to add this requirements bellow.
iOS #
Add the following keys to your Info.plist file, located in <project root>/ios/Runner/Info.plist:

NSPhotoLibraryUsageDescription - describe why your app needs permission for the photo library. This is called Privacy - Photo Library Usage Description in the visual editor.
NSCameraUsageDescription - describe why your app needs access to the camera. This is called Privacy - Camera Usage Description in the visual editor.
NSMicrophoneUsageDescription - describe why your app needs access to the microphone, if you intend to record videos. This is called Privacy - Microphone Usage Description in the visual editor.

Android #
Image Picker config:
No configuration required - the plugin should work out of the box.
It is no longer required to add android:requestLegacyExternalStorage="true" as an attribute to the
Image Cropper config:

Add UCropActivity into your AndroidManifest.xml

<activity
android:name="com.yalantis.ucrop.UCropActivity"
android:screenOrientation="portrait"
android:theme="@style/Theme.AppCompat.Light.NoActionBar"/>
copied to clipboard
Note:
From v1.2.0, you need to migrate your android project to v2 embedding (detail)

Parameter (Required) #

Property
Description
Type

diameter
The diameter of the container in which the image is contained.
double

Parameter (Optional) #

Property
Description
Type

initialImage
The initial image to be displaied, can be an ImageProvider, File or a external url (String)
dynamic

isEditable
Checks whether the image can be changed
bool

shouldCrop
defines if the image can be edited and/or croped with the defined values bellow default to false.
bool

onChange
Case the image can be changed, this function will be called after the change.
void Function(File)

fit
How the image should be inscribed into the box.
BoxFit

Customization (Optional) #
Image Picker Widget #

Property
Description
Type

shape
The shape of the widget [square or circle]
ImagePickerWidgetShape

backgroundColor
The background of the widget [default to Colors.grey[500]]
Color

backgroundColor
The radius of the square image [default to Radius.all(8)]
Radius

editIcon
The widget that references the possibility of editing
Widget

iconAlignment
Alignment option for editIcon
AlignmentGeometry

Modal image type picker #

Property
Description
Type

modalOptions.title
The title of the widget [default to Text > "Select:"]
Widget

modalOptions.cameraIcon
The camera icon that selects the camera [default to Icons.camera]
IconData

IconData

modalOptions.cameraText
The camera label that indicates to select the camera [defaults to Text > "camera"]
Widget

modalOptions.cameraSize
The camera icon size that indicates to select the camera [defaults to 40]
double

modalOptions.cameraColor
The camera icon color that indicates to select the camera [defaults to primaryColor]
Color

modalOptions.galleryIcon
The gallery icon that select the gallery [default to Icons.collections]
IconData

IconData

modalOptions.galleryText
The gallery label that indicates to select the gallery [defaults to Text > "gallery"]
Widget

modalOptions.gallerySize
The gallery icon size that indicates to select the gallery [defaults to 40]
Widget

modalOptions.galleryColor
The gallery icon color that indicates to select the gallery [defaults to primaryColor]
Widget

Or, in case you want to add your own modal, you can make'it using imagePickerModal like as follow:
imagePickerModal: (context, selectCamera, selectGallery) => BottomSheet(
onClosing: () => print('Nothing'),
backgroundColor: Colors.red,
builder: (context) => Padding(
padding: const EdgeInsets.all(16),
child: Row(
mainAxisAlignment: MainAxisAlignment.spaceEvenly,
children: [
ElevatedButton(onPressed: () => selectCamera(context), child: Text("Camera")),
SizedBox(height: 20),
ElevatedButton(onPressed: () => selectGallery(context), child: Text("Galeria")),
],
),
),
),
copied to clipboard
Image Picker Options #

Property
Description
Type

maxWidth
If specified, the image will be at most maxWidth wide and maxHeight tall. Otherwise the image will be returned at it's original width and height.
int

maxHeight
If specified, the image will be at most maxWidth wide and maxHeight tall. Otherwise the image will be returned at it's original width and height.
int

imageQuality
The imageQuality argument modifies the quality of the image, ranging from 0-100 where 100 is the original/max quality. If imageQuality is null, the image with the original quality will be returned. Compression is only supported for certain image types such as JPEG and on Android PNG and WebP, too. If compression is not supported for the image that is picked, a warning message will be logged.
int

preferredCameraDevice
Use preferredCameraDevice to specify the camera to use when the source is [ImageSource.camera]. The preferredCameraDevice is ignored when source is [ImageSource.gallery]. It is also ignored if the chosen camera is not supported on the device. Defaults to [CameraDevice.rear]. Note that Android has no documented parameter for an intent to specify if the front or rear camera should be opened, this function is not guaranteed to work on an Android device.
CameraDevice

Image Cropping Options #

Property
Description
Type

maxWidth
maximum cropped image width.
int

maxHeight
maximum cropped image height.
int

aspectRatio
controls the aspect ratio of crop bounds. If this values is set, the cropper is locked and user can't change the aspect ratio of crop bounds.
CropAspectRatio

aspectRatioPresets
controls the list of aspect ratios in the crop menu view. In Android, you can set the initialized aspect ratio when starting the cropper by setting the value of AndroidUiSettings.initAspectRatio.
List

cropStyle
controls the style of crop bounds, it can be rectangle or circle style (default is CropStyle.rectangle).
CropStyle

compressFormat
the format of result image, png or jpg (default is ImageCompressFormat.jpg).
ImageCompressFormat

compressQuality
the value [0 - 100] to control the quality of image compression.
int

androidUiSettings
controls UI customization on Android. See Android customization.
AndroidUiSettings

iosUiSettings
controls UI customization on iOS. See iOS customization.
IOSUiSettings

Basic Usage #
Adding the widget
..child: ImagePickerWidget(
diameter: 180,
// initialImage: "https://strattonapps.com/wp-content/uploads/2020/02/flutter-logo-5086DD11C5-seeklogo.com_.png",
shape: ImagePickerWidgetShape.circle, // ImagePickerWidgetShape.square
isEditable: true,
onChange: (File file) {
print("I changed the file to: ${file.path}");
},
)
copied to clipboard
Issues #
Please if you see any issues, bugs, or feature requests, send to me in: GitHub issue.