documentation updates

This commit is contained in:
commitimpush 2022-09-01 17:07:53 +02:00
parent 9ec7bd78ce
commit 8cf757f4e7
2 changed files with 5 additions and 6 deletions

View file

@ -15,7 +15,9 @@ To use this package, add `flutter_image_picker` as a [dependency in your pubspec
See the [Example Code](example/lib/main.dart) for an example on how to use this package.
You can add optional parameters to the `showImagePickerDialog(context)` function call. These are:
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`:
An example on how to add a parameter to the `ImagePickerTheme()` is: `ImagePickerTheme(imagePickerTheme: const ImagePickerTheme(title: "Image Picker"))`
| Parameter | Explaination |
|-------------------|----------------|
| title | The title displayed at the top of the Image Picker Dialog. |
@ -31,9 +33,6 @@ You can add optional parameters to the `showImagePickerDialog(context)` function
| 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. |
The `showImagePickerDialog(context)` function returns an `Uint8List` as value which you can use in your application.
## Issues & Feedback
Please file an [issue](https://github.com/Iconica-Development/flutter_image_picker/issues) to send feedback or report a bug.

View file

@ -89,8 +89,8 @@ class _ImagePickerExampleHomePageState
/// The [pickImage] function is used to show the usage of the Image Picker Package.
/// The most important part is the [ImagePicker] call.
/// You can add a custom [ImagePickerTheme] to it if you want to change some of the UI.
/// You can do that by adding [imagePickerTheme: const ImagePickerTheme()] in the [ImagePicker] in the builder.
/// You can add a custom [ImagePickerTheme] to the [ImagePicker] if you want to change some of the UI.
/// An example on how to do that is: ImagePickerTheme(imagePickerTheme: const ImagePickerTheme(title: "Image Picker")).
/// Check the README for all possible parameters you can add in the [ImagePickerTheme].
/// This function saves the image in a variable and if it's different than the current image it will get displayed in the application.
/// When the same image is chosen there will be a snackbar popping up to let you know it's already being displayed.