flutter_image_picker/README.md

54 lines
3.7 KiB
Markdown
Raw Normal View History

2022-08-29 14:52:48 +02:00
# Flutter Image Picker
Flutter Image Picker is a package you can use to implement an Image Picker in your Flutter app.
2022-09-01 12:04:18 +02:00
![Gif](example/gif/ImagePickerGif.gif)
2022-08-29 14:52:48 +02:00
## Features
2022-09-05 09:40:35 +02:00
With the Flutter Image Picker you can select an existing picture from the gallery of your device or make a picture with the camera to use in your app. This package is made for Android, iOS and Windows.
2022-08-29 14:52:48 +02:00
2022-09-05 09:40:35 +02:00
## Setup
2022-08-29 14:52:48 +02:00
To use this package, add `flutter_image_picker` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).
2022-09-05 09:40:35 +02:00
## How To Use
2022-08-31 17:05:15 +02:00
See the [Example Code](example/lib/main.dart) for an example on how to use this package.
2022-09-01 17:07:53 +02:00
You can add an optional `ImagePickerTheme()` to the `ImagePicker()` to change the layout of the Image Picker Dialog. You can add the following parameters to the `ImagePickerTheme`:
2022-09-01 17:09:40 +02:00
An example on how to add a parameter to the `ImagePickerTheme()` is: `ImagePickerTheme(imagePickerTheme: const ImagePickerTheme(title: "Image Picker"))`.
As a whole you get `ImagePicker(ImagePickerTheme(imagePickerTheme: const ImagePickerTheme(title: "Image Picker")))`
2022-09-01 17:07:53 +02:00
2022-08-31 17:03:20 +02:00
| Parameter | Explaination |
|-------------------|----------------|
2022-09-06 14:22:28 +02:00
| font | The font that is being used in the Image Picker Dialog. |
2022-09-01 17:00:59 +02:00
| title | The title displayed at the top of the Image Picker Dialog. |
2022-09-06 14:22:28 +02:00
| textColor | The color of the text that is displayed in the Image Picker Dialog. |
| iconColor | The color of the icons that are displayed in the Image Picker Dialog. |
2022-09-01 17:00:59 +02:00
| titleTextSize | The font size of the title mentioned above. |
| iconSize | The size of the icons that are visible in the Image Picker Dialog. |
| iconTextSize | The font size of the text underneath the icon buttons. |
| spaceBetweenIcons | The size of the space between the two icons in the Image Picker Dialog. |
| makePhotoIcon | The icon that is displayed for the 'Make Photo' functionality of the Image Picker Dialog. |
| makePhotoText | The text that is displayed underneath the 'Make Photo' icon. |
| selectImageIcon | The icon that is displayed for the 'Select Image From Gallery' functionality of the Image Picker Dialog. |
| selectImageText | The text that is displayed underneath the 'Select Image From Gallery' icon. |
| closeButtonText | The text that is shown on the 'Close Dialog' button at the bottom of the Image Picker Dialog. |
2022-09-06 14:22:28 +02:00
| closeButtonTextSize | The size of the text that is being displayed on the 'Close Dialog' button at the bottom of the Image Picker Dialog. |
| closeButtonTextColor | The color of the text that is being displayed on the 'Close Dialog' button at the bottom of the Image Picker Dialog. |
2022-09-01 17:00:59 +02:00
| closeButtonWidth | The width of the 'Close Dialog' button at the bottom of the Image Picker Dialog. |
| closeButtonHeight | The height of the 'Close Dialog' button at the bottom of the Image Picker Dialog. |
2022-09-06 14:22:28 +02:00
| closeButtonBackgroundColor | The background color of the 'Close Dialog' button at the bottom of the Image Picker Dialog. |
2022-09-01 17:00:59 +02:00
2022-09-01 12:04:18 +02:00
2022-09-05 09:40:35 +02:00
## Issues
2022-09-01 12:04:18 +02:00
2022-09-05 09:40:35 +02:00
Please file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/Iconica-Development/flutter_image_picker/pulls) page. Commercial support is available if you need help with integration with your app or services. You can contact us at [support@iconica.nl](mailto:support@iconica.nl).
2022-09-01 12:04:18 +02:00
2022-09-05 09:40:35 +02:00
## Want to contribute
If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](URL TO PULL REQUEST TAB IN REPO).
## Author
This `flutter-image-picker` for Flutter is developed by [Iconica](https://iconica.nl). You can contact us at <support@iconica.nl>