Merge branch 'icapps:main' into main

Author: sikandernoori

.gitignore

@@ -74,4 +74,6 @@ build/
 !**/ios/**/default.perspectivev3
 
 test/coverage_helper_test.dart
-coverage/**
+coverage/**
+.fvm/
+.vscode/settings.json

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.0.7] - 2023-08-09
+
+* Added Ratio as new shape and arguments
+
 ## [0.0.6]
 
 * Added new param to CustomImageCrop for new image fit types

README.md

@@ -11,7 +11,7 @@ An Image cropper that is customizable
 
 # CustomImageCrop
 
-```
+```dart
 CustomImageCrop(
   cropController: controller,
   image: const AssetImage('assets/test.png'),
@@ -23,35 +23,51 @@ You can provide the image using any Imageprovider.
 ## Parameters
 
 ### required image
+
 The image that needs to be cropped
 
 ### cropController
+
 The controller used to adjust the image and crop it.
 
 ### overlayColor
+
 The color above the image that will be cropped
 
 ### backgroundColor
+
 The color behind the image. This color will also be used when there are gaps/empty space after the cropping
 
 ### shape
+
 The shape of the cropping path.
 
 ### cropPercentage
+
 How big the crop should be in regards to the width and height available to the cropping widget.
 
 ### drawPath
+
 How the border of the crop should be painted. default DottedCropPathPainter.drawPath and SolidCropPathPainter.drawPath are provided, but you can create/provide any CustomPaint.
 
 ### pathPaint
 Custom painting for the crop area border style.
 
 ### canRotate
+
 Whether to allow the image to be rotated.
 
 ### customProgressIndicator
+
 Custom widget for progress indicator.
 
+### ratio
+
+Ratio of the cropping area.
+If ` shape`` is set to  `CustomCropShape.Ratio`, this property is required.
+For example, to create a square crop area, use `[`Ratio(width: 1, height: 1)`.
+To create a rectangular crop area with a 16:9 aspect ratio, use `[`Ratio(width: 16, height: 9)`.
+
 # Controller Methods
 
 ## addTransition
@@ -67,11 +83,13 @@ Add the position, angle and scale to the current state. This can be used to adju
 Set the position, angle and scale to the specified values. This can be used to center the image by pressing a button for example.
 
 ## reset
+
 `void reset()`
 
 Reset the image to its default state
 
 ## onCropImage
+
 `Future<MemoryImage> onCropImage()`
 
 Crops the image in its current state, this will return a MemoryImage that contains the cropped image
@@ -80,7 +98,7 @@ Crops the image in its current state, this will return a MemoryImage that contai
 
 See example/lib
 
-```
+```dart
 class MyHomePage extends StatefulWidget {
   final String title;
 
@@ -148,4 +166,3 @@ class _MyHomePageState extends State<MyHomePage> {
   }
 }
 ```
-

example/lib/main.dart

@@ -90,12 +90,9 @@ class _MyHomePageState extends State<MyHomePage> {
             child: CustomImageCrop(
               cropController: controller,
               // image: const AssetImage('assets/test.png'), // Any Imageprovider will work, try with a NetworkImage for example...
-              image: const NetworkImage(
-                  'https://upload.wikimedia.org/wikipedia/en/7/7d/Lenna_%28test_image%29.png'),
+              image: const NetworkImage('https://upload.wikimedia.org/wikipedia/en/7/7d/Lenna_%28test_image%29.png'),
               shape: _currentShape,
-              ratio: _currentShape == CustomCropShape.Ratio
-                  ? Ratio(width: _width, height: _height)
-                  : null,
+              ratio: _currentShape == CustomCropShape.Ratio ? Ratio(width: _width, height: _height) : null,
               canRotate: true,
               canMove: false,
               canScale: false,
@@ -111,47 +108,34 @@ class _MyHomePageState extends State<MyHomePage> {
           Row(
             mainAxisAlignment: MainAxisAlignment.spaceAround,
             children: [
-              IconButton(
-                  icon: const Icon(Icons.refresh), onPressed: controller.reset),
-              IconButton(
-                  icon: const Icon(Icons.zoom_in),
-                  onPressed: () =>
-                      controller.addTransition(CropImageData(scale: 1.33))),
-              IconButton(
-                  icon: const Icon(Icons.zoom_out),
-                  onPressed: () =>
-                      controller.addTransition(CropImageData(scale: 0.75))),
-              IconButton(
-                  icon: const Icon(Icons.rotate_left),
-                  onPressed: () =>
-                      controller.addTransition(CropImageData(angle: -pi / 4))),
-              IconButton(
-                  icon: const Icon(Icons.rotate_right),
-                  onPressed: () =>
-                      controller.addTransition(CropImageData(angle: pi / 4))),
+              IconButton(icon: const Icon(Icons.refresh), onPressed: controller.reset),
+              IconButton(icon: const Icon(Icons.zoom_in), onPressed: () => controller.addTransition(CropImageData(scale: 1.33))),
+              IconButton(icon: const Icon(Icons.zoom_out), onPressed: () => controller.addTransition(CropImageData(scale: 0.75))),
+              IconButton(icon: const Icon(Icons.rotate_left), onPressed: () => controller.addTransition(CropImageData(angle: -pi / 4))),
+              IconButton(icon: const Icon(Icons.rotate_right), onPressed: () => controller.addTransition(CropImageData(angle: pi / 4))),
               IconButton(
                 icon: const Icon(Icons.crop),
                 onPressed: () async {
                   final image = await controller.onCropImage();
                   if (image != null) {
-                    Navigator.of(context).push(MaterialPageRoute(
-                        builder: (BuildContext context) =>
-                            ResultScreen(image: image)));
+                    Navigator.of(context).push(MaterialPageRoute(builder: (BuildContext context) => ResultScreen(image: image)));
                   }
                 },
               ),
               PopupMenuButton<CustomCropShape>(
                 icon: const Icon(Icons.crop_original),
                 onSelected: _changeCropShape,
                 itemBuilder: (BuildContext context) {
-                  return CustomCropShape.values.map((shape) {
-                    return PopupMenuItem<CustomCropShape>(
-                      value: shape,
-                      child: getShapeIcon(shape),
-                    );
-                  }).toList();
+                  return CustomCropShape.values.map(
+                    (shape) {
+                      return PopupMenuItem<CustomCropShape>(
+                        value: shape,
+                        child: getShapeIcon(shape),
+                      );
+                    },
+                  ).toList();
                 },
-              )
+              ),
             ],
           ),
           if (_currentShape == CustomCropShape.Ratio)

pubspec.yaml

@@ -1,6 +1,6 @@
 name: custom_image_crop
 description: An image cropper that is customizable. You can rotate, scale and translate either through gestures or a controller
-version: 0.0.6
+version: 0.0.7
 homepage: https://github.com/icapps/flutter-custom-image-crop
 
 environment: