Skip to content

Commit

Permalink
Remove deprecated method names from README.
Browse files Browse the repository at this point in the history
  • Loading branch information
ditman committed Jul 17, 2023
1 parent 537463d commit 738cbb4
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions packages/image_picker/image_picker_for_web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ A web implementation of [`image_picker`][1].

## Limitations on the web platform

### `XFile`

This plugin uses `XFile` objects to abstract files picked/created by the user.

Read more about `XFile` on the web in [`package:cross_file`'s README](https://pub.dev/packages/cross_file)
Read more about `XFile` on the web in
[`package:cross_file`'s README](https://pub.dev/packages/cross_file).

### input file "accept"

Expand Down Expand Up @@ -34,11 +37,19 @@ The [`cancel` event](https://caniuse.com/mdn-api_htmlinputelement_cancel_event)
used by the plugin to detect when users close the file selector without picking
a file is relatively new, and will only work in recent browsers.

### pickImage()
The arguments `maxWidth`, `maxHeight` and `imageQuality` are not supported for gif images.
The argument `imageQuality` only works for jpeg and webp images.
### `getImage()` parameters and `MediaOptions`

The `getImage`, `getMultiImage` and `getMedia` methods receive either a
`MediaOptions` object with `maxWidth`, `maxHeight` and `imageQuality` options,
or separately as individual parameters.

On the web:

* `maxWidth`, `maxHeight` and `imageQuality` are not supported for `gif` images.
* `imageQuality` only affects `jpg` and `webp` images.

### `getVideo()`

### pickVideo()
The argument `maxDuration` is not supported on the web.

## Usage
Expand Down

0 comments on commit 738cbb4

Please sign in to comment.