aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBenedikt Betz <benedikt.betz@bueroscharf.de>2024-01-23 16:46:05 +0100
committerBenedikt Betz <benedikt.betz@bueroscharf.de>2024-01-23 16:46:05 +0100
commit374da20bcbabdffac725142b71f906fe29dfcfbb (patch)
treee814281e3e36a036bb7fe0801efa6b4ccd853b8c /README.md
parentd128aa7d0f09d474921b2cd26f228324ee6ea3d9 (diff)
Adjust README and Tests
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 139b9c3..b6368c6 100644
--- a/README.md
+++ b/README.md
@@ -136,12 +136,14 @@ You can also configure `SwiftyCropView` by passing a `SwiftyCropConfiguration`.
| ----------- | ----------- |
| `maxMagnificationScale` | `CGFloat`: The maximum scale factor that the image can be magnified while cropping. Defaults to `4.0`. |
| `maskRadius` | `CGFloat`: The radius of the mask used for cropping. Defaults to `130`. A good way is to make it dependend on the screens size. |
+| `cropImageCircular` | `Bool`: When using the cropping mask `circle`, whether the resulting image should also be masked as circle. Defaults to `false`. |
Create a configuration like this:
```swift
let configuration = SwiftyCropConfiguration(
maxMagnificationScale = 4.0,
- maskRadius: 130
+ maskRadius: 130,
+ cropImageCircular: false
)
```
and use it like this:
@@ -164,6 +166,8 @@ and use it like this:
All issue reports, feature requests, pull requests and GitHub stars are welcomed and much appreciated.
+Thanks to @leoz for adding the circular crop mode 🎉
+
## ✍️ Author
Benedikt Betz & CHECK24