Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Commit

Permalink
📝 Update README.md
Browse files Browse the repository at this point in the history
Add known issues
  • Loading branch information
tinyjin committed Mar 17, 2024
1 parent d96fa33 commit 137080a
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,36 @@ class MyApp extends StatelessWidget {
}
```

## Known Issues

> [!WARNING]
> As an experimental project, we anticipate the following issues may render the use of this library unstable. Please verify before using `lottie-thorvg`.
### iOS

#### Unexpected white background rendered ([#2](https://github.com/tinyjin/lottie-thorvg/issues/2))

This seems to be appeared by the Impeller renderer, affecting rendered canvas that has unexpected white background.

**Workaround**:
- Open `Info.plist`
- Turn off Impeller by adding:
```plist
<key>FLTEnableImpeller</key>
<false/>
```

#### Apple Silicon simulator build error ([#4](https://github.com/tinyjin/lottie-thorvg/issues/4))

Currently, ThorVG Flutter iOS binding operates with a dylib. To support universal dynamic library, We should transition to using xcframework. However `dart-ffi` faces an issue where it can't open dynamic libraries through the xcframework.

It only triggers an error when buliding on iOS Simulator under Apple Silicon.

**Workaround**:
- If you're using mac OS(Intel), no effects
- Do use iOS Simulator by rosetta
It won't effect to real device & store uploading

# License

MIT

0 comments on commit 137080a

Please sign in to comment.