docs: add migration guide from 8.0 to 8.1.0 and other docs#28
docs: add migration guide from 8.0 to 8.1.0 and other docs#28alexgerardojacinto wants to merge 11 commits intofeat/RMET-4099/camera-unificationfrom
Conversation
alexgerardojacinto
requested review from
OS-pedrogustavobilro,
OS-ruimoreiramendes and
andredestro
and removed request for
OS-pedrogustavobilro and
OS-ruimoreiramendes
alexgerardojacinto
changed the title
| source: CameraSource.Camera, | ||
| quality: 90, | ||
| allowEditing: true, | ||
| resultType: CameraResultType.Uri, |
There was a problem hiding this comment.
Somewhere here or before, we should state that the other CameraResultType's are not supported, and maybe link to "Result type changes" section or something like that?
README.md
Outdated
| const imageUrl = result.webPath; | ||
| ``` | ||
|
|
||
| #### `CameraSource.Photos` → `chooseFromGallery` |
There was a problem hiding this comment.
Maybe this is a non-problem, but just wondered if the capacitor-docs website support these unicode characters for sections, or would links to those sections be broken? I mean they probably do, but worth checking first as I can't think of one place where we have these kinds of characters in section title?
Or, if we don't want to bother checking, the safe route is changing "→" to "with" or "to"
There was a problem hiding this comment.
Yeah that's a good point, I think we should just play it safe then
| | `height` | `targetHeight` | `takePhoto`, `chooseFromGallery` | | ||
| | `direction` | `cameraDirection` | `takePhoto` | | ||
| | `allowEditing` | `editable: 'in-app'` | `takePhoto`, `chooseFromGallery` | | ||
| | `resultType` | — (removed) | — | |
There was a problem hiding this comment.
Link to "result type changes" section?
| * [Enums](#enums) | ||
|
|
||
| </docgen-index> |
There was a problem hiding this comment.
Usually here in other plugins with this error structure we have added a line saying:
For list of existing error codes, see [Errors](#errors).
There was a problem hiding this comment.
Yeah you're right. Just a minor correction, I believe it should be:
For a list of existing error codes, see Errors
There was a problem hiding this comment.
Yeah fair enough, I copy-pasted that from another plugin (I think file transfer, but maybe there's others), which could probably use a typo correction then heh.
README.md
Outdated
|
|
||
| ### Errors | ||
|
|
||
| The plugin returns structured errors on Android and iOS. Each error has a `code` (e.g. `OS-PLUG-CAMR-0003`) and a `message` with a human-readable description. |
There was a problem hiding this comment.
Worth stating, only available for native, and only since 8.1.0, and only for the new methods added in 8.1.0
There was a problem hiding this comment.
Added that, can you check? Thank you!
Co-authored-by: Pedro Bilro <pedro.gustavo.bilro@outsystems.com>
Co-authored-by: Pedro Bilro <pedro.gustavo.bilro@outsystems.com>
Co-authored-by: Pedro Bilro <pedro.gustavo.bilro@outsystems.com>
Co-authored-by: Pedro Bilro <pedro.gustavo.bilro@outsystems.com>
3 participants
getPhotoandpickImagesto the new functions.takePhotoinstead of deprecatedgetPhotoCONTRIBUTING.mdfile, similar to the one for the capacitor-geolocation plugin: https://github.com/ionic-team/capacitor-geolocation/blob/main/CONTRIBUTING.md