Skip to content

Commit 4ea7047

Browse files
chore: Add missing default for allowEdits
1 parent 471df14 commit 4ea7047

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ Allows the user to pick multiple pictures from the photo gallery.
382382
| **`encodingType`** | <code><a href="#encodingtype">EncodingType</a></code> | The encoding type for the captured photo - JPEG or PNG. Note: This option is only supported on Android and iOS. | <code>EncodingType.JPEG</code> | 8.1.0 |
383383
| **`saveToGallery`** | <code>boolean</code> | Whether to save the photo to the gallery. Note: This option is only supported on Android and iOS. | <code>false</code> | 8.1.0 |
384384
| **`cameraDirection`** | <code><a href="#cameradirection">CameraDirection</a></code> | iOS and Web only: The camera direction. | <code>CameraDirection.Rear</code> | 8.1.0 |
385-
| **`allowEdit`** | <code>boolean</code> | Whether to allow the user to crop or make small edits. Note: This option is only supported on Android and iOS. | | 8.1.0 |
385+
| **`allowEdit`** | <code>boolean</code> | Whether to allow the user to crop or make small edits. Note: This option is only supported on Android and iOS. | <code>false</code> | 8.1.0 |
386386
| **`editInApp`** | <code>boolean</code> | If `true`, will use an in-app editor for photo edition. If `false`, will open a separate (platform-specific) native app to handle photo edition, falling back to the in-app editor if none is available. Only applicable with `allowEdit` set to true. Note: This option is only supported on Android and iOS. | <code>true</code> | 8.1.0 |
387387
| **`presentationStyle`** | <code>'fullscreen' \| 'popover'</code> | iOS only: The presentation style of the Camera. | <code>'fullscreen'</code> | 8.1.0 |
388388
| **`webUseInput`** | <code>boolean</code> | Web only: Whether to use the PWA Element experience or file input. The default is to use PWA Elements if installed and fall back to file input. To always use file input, set this to `true`. Learn more about PWA Elements: https://capacitorjs.com/docs/web/pwa-elements | | 8.1.0 |
@@ -420,7 +420,7 @@ Allows the user to pick multiple pictures from the photo gallery.
420420
| **`allowMultipleSelection`** | <code>boolean</code> | Whether or not to allow selecting multiple media files from the gallery. | <code>false</code> | 8.1.0 |
421421
| **`limit`** | <code>number</code> | The maximum number of media files that the user can choose. Only applicable if `allowMultipleSelection` is `true`. Any non-positive number will be treated as unlimited. Note: This option is only supported on Android 13+ and iOS. | <code>0</code> | 8.1.0 |
422422
| **`includeMetadata`** | <code>boolean</code> | Whether or not <a href="#mediaresult">MediaResult</a> should include its metadata. If an error occurs when obtaining the metadata, it will return empty. Note: This option is only supported on Android and iOS. | <code>false</code> | 8.1.0 |
423-
| **`allowEdit`** | <code>boolean</code> | Whether to allow the user to crop or make small edits. Only applicable for <a href="#mediatype">`MediaType.picture`</a> and `allowMultipleSelection` set to `false`. Note: This option is only supported on Android and iOS. | | 8.1.0 |
423+
| **`allowEdit`** | <code>boolean</code> | Whether to allow the user to crop or make small edits. Only applicable for <a href="#mediatype">`MediaType.picture`</a> and `allowMultipleSelection` set to `false`. Note: This option is only supported on Android and iOS. | <code>false</code> | 8.1.0 |
424424
| **`editInApp`** | <code>boolean</code> | If `true`, will use an in-app editor for photo edition. If `false`, will open a separate (platform-specific) native app to handle photo edition, falling back to the in-app editor if none is available. Only applicable with `allowEdit` set to true. Note: This option is only supported on Android and iOS. | <code>true</code> | 8.1.0 |
425425
| **`presentationStyle`** | <code>'fullscreen' \| 'popover'</code> | iOS only: The presentation style of media picker. | <code>'fullscreen'</code> | 8.1.0 |
426426
| **`quality`** | <code>number</code> | The quality of images to return, from 0-100. Only applicable for <a href="#mediatype">`MediaType.picture`</a> and JPEG format. Note: This option is only supported on Android and iOS. | <code>100</code> | 8.1.0 |

src/definitions.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ export interface TakePhotoOptions {
173173
/**
174174
* Whether to allow the user to crop or make small edits.
175175
* Note: This option is only supported on Android and iOS.
176+
* @default false
176177
*
177178
* @since 8.1.0
178179
*/
@@ -300,6 +301,7 @@ export interface ChooseFromGalleryOptions {
300301
* Whether to allow the user to crop or make small edits.
301302
* Only applicable for `MediaType.picture` and `allowMultipleSelection` set to `false`.
302303
* Note: This option is only supported on Android and iOS.
304+
* @default false
303305
*
304306
* @since 8.1.0
305307
*/

0 commit comments

Comments
 (0)