Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(imagepicker): consolidate API / Fix typings #530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 16, 2023
Merged

fix(imagepicker): consolidate API / Fix typings #530

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1d1fbfe
Initial
jcassidyav Sep 4, 2023
cd372b2
fix(imagePicker): consolidate API
jcassidyav Sep 8, 2023
feac5b4
chore(ImagePicker): Typos in readme
jcassidyav Sep 8, 2023
7c5f766
chore(imagepicker): typo in README
jcassidyav Sep 8, 2023
e8cd017
Merge branch 'main' into consolidate-image-picker
NathanWalker Sep 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore(ImagePicker): Typos in readme
  • Loading branch information
@jcassidyav
jcassidyav committed Sep 8, 2023
commit feac5b4a35b9bd7686fb84e7af334a824f538f61
8 changes: 4 additions & 4 deletions packages/imagepicker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ Install the plugin by running the following command in the root directory of you
npm install @nativescript/imagepicker
```

**Note: Version 3.0 contains breaking changes.**
**Note: Version 3.0 contains breaking changes:**
* authorise() now returns a `Promise<AuthorizationResult>` for both android and ios.
* In the returned result from `present()` each `result[i].thumbnail` is now an ImageSource.
* `result[i].duration` is not typed correctly as a `number`.
* In the returned result from `present()` each `result[i].thumbnail` is now an `ImageSource`.
* `result[i].duration` is now typed correctly as a `number`.

**Note: Version 2.0 contains breaking changes. In order supply more information about your selection, the ImageSource asset is nested in the response so you'll need to update your code to use `result.asset` instead of `result` as your src for your Images.**

Expand Down Expand Up @@ -139,7 +139,7 @@ The class that provides the media selection API. It offers the following methods
| Method | Returns | Description
|:-------|:--------|:-----------
| `constructor(options: Options)` | `ImagePicker` | Instanciates the ImagePicker class with the optional `options` parameter. See [Options](#options)
| `authorize()` | `Promise<AuthorizationResult>` | Requests the required permissions. Call it before calling `present()`. In case of a failed authorization, consider notifying the user for degraded functionality. The returned `AuthorizationResult` will have it's `authorized` property to `true` if permission was granted.
| `authorize()` | `Promise<AuthorizationResult>` | Requests the required permissions. Call it before calling `present()`. In case of a failed authorization, consider notifying the user for degraded functionality. The returned `AuthorizationResult` will have it's `authorized` property set to `true` if permission has been granted.
| `present()` | `Promise<ImagePickerSelection[]>` | Presents the image picker UI.
| `create(options: Options, hostView: View)` | `ImagePicker` | Creates an instance of the ImagePicker class. The `hostView` parameter can be set to the view that hosts the image picker. Intended to be used when opening the picker from a modal page.

Expand Down