Skip to content

fix(docs): reflect supported file formats in readme #120

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

Open
DaveyEke wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(docs): reflect supported file formats in readme #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 17 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,14 +212,25 @@ const path = await image.saveToTemporaryFileAsync('jpg', 50) // 50% compre
const compressed = await image.toEncodedImageData('jpg', 50) // 50% compression
```

#### HEIC/HEIF
#### Supported Formats

NitroImage supports `HEIC`/`HEIF` format if the host OS natively supports it.
NitroImage uses the host OS for decoding, so loading supports any format the platform does. Writing is limited to `jpg`, `png` and `heic`.

| | iOS | Android |
|--------------|----------------|----------------|
| Loading HEIC | ✅ | ✅ (>= SDK 28) |
| Writing HEIC | ✅ (>= iOS 17) | ❌ |
| | Loading (iOS) | Loading (Android) | Writing (iOS) | Writing (Android) |
|-------|---------------|-------------------|----------------|-------------------|
| JPEG | ✅ | ✅ | ✅ | ✅ |
| PNG | ✅ | ✅ | ✅ | ✅ |
| HEIC | ✅ | ✅ (>= SDK 28) | ✅ (>= iOS 17) | ❌ |
| WebP | ✅ | ✅ | ❌ | ❌ |
| GIF | ✅ | ✅ | ❌ | ❌ |
| BMP | ✅ | ✅ | ❌ | ❌ |
| TIFF | ✅ | ❌ | ❌ | ❌ |

Animated formats (GIF, WebP, APNG) decode to a single frame - `<NitroImage />` does not play animations.

For loading remote images, [react-native-nitro-web-image](https://www.npmjs.com/package/react-native-nitro-web-image) additionally supports AVIF via SDWebImage (iOS) and Coil (Android).

##### HEIC/HEIF

You can check whether your OS supports `HEIC` via NitroImage:

Expand Down