FlutterValuableBackup/rive-flutter
1
0
Fork 0
mirror of https://github.com/rive-app/rive-flutter synced 2025-06-22 01:55:59 +00:00
Code Issues Releases Wiki Activity

docs: update README and CHANGELOG

Browse Source 
This PR adds a community contribution and updates the Readme with the latest information.

Diffs=
060a6cf61 docs: update README and CHANGELOG (#7416)
7e1b3027d Optimize image encoding/decoding in debug builds (#7418)
da0b71559 Replace computeIntrinsicSize with measureLayout (#7410)
6c76b425f Yoga layout runtimes (#6787)

Co-authored-by: Emad Rad <codewithemad@gmail.com>
Co-authored-by: Gordon <pggordonhayes@gmail.com>
This commit is contained in:
HayesGordon
2024-06-17 09:08:46 +00:00
parent fc13a2063e
commit 767bfa6979
3 changed files with 49 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.rive_head
View File

@ -1 +1 @@
e103006c8fae9308598e00891980fd464edf61a2
060a6cf619c0aafbe125d5dcbc0eb42123ce1fd1

6
CHANGELOG.md
View File

@ -35,7 +35,7 @@
## 0.12.4
- Adds `behavior` argument to `RiveAnimation` and `Rive`. An enum `RiveHitTestBehavior` specifies how to handle hit testing on an animation. Default is `RiveHitTestBehavior.opaque` - comsuming all hit events for the artboard bounds.
- Adds `behavior` argument to `RiveAnimation` and `Rive`. An enum `RiveHitTestBehavior` specifies how to handle hit testing on an animation. Default is `RiveHitTestBehavior.opaque` - consuming all hit events for the artboard bounds.
- Collapsed nested artboards don't listen to pointer events anymore
- Constraints pointing to collapsed targets are not applied
@ -167,7 +167,7 @@ Deprecated:
## 0.10.1
- Fix [[277](https://github.com/rive-app/rive-flutter/issues/277)] and [[278](https://github.com/rive-app/rive-flutter/issues/278)] that resuled in `onInit` being called with each `setState` - thank you [xuelongqy](https://github.com/xuelongqy).
- Fix [[277](https://github.com/rive-app/rive-flutter/issues/277)] and [[278](https://github.com/rive-app/rive-flutter/issues/278)] that resulted in `onInit` being called with each `setState` - thank you [xuelongqy](https://github.com/xuelongqy).
## 0.10.0
@ -263,7 +263,7 @@ Fix for setState being called while mounted in RiveAnimation. [`#172`](https://g
- Adds ability to pass controllers into RiveAnimation widgets
- Adds autoplay option to SimpleAnimation controller
- Adds one-shot animation contoller
- Adds one-shot animation controller
- Updates examples
## 0.7.17 - (2021-06-11)

60
README.md
View File

@ -13,12 +13,16 @@ This library allows you to fully control Rive files with a high-level API for si
## Table of contents
- :star: [Rive Overview](#rive-overview)
- 🚀 [Getting Started & API docs](#getting-started)
- :mag: [Supported Platforms](#supported-platforms)
- :books: [Examples](#examples)
- 👨‍💻 [Contributing](#contributing)
- :question: [Issues](#issues)
- [Rive Flutter](#rive-flutter)
- [Table of contents](#table-of-contents)
- [Overview of Rive](#overview-of-rive)
- [Getting started](#getting-started)
- [Choosing a Renderer](#choosing-a-renderer)
- [Note on the Impeller renderer](#note-on-the-impeller-renderer)
- [Supported platforms](#supported-platforms)
- [Awesome Rive](#awesome-rive)
- [Contributing](#contributing)
- [Issues](#issues)
## Overview of Rive
@ -28,26 +32,52 @@ For more information, check out the following resources:
:house_with_garden: [Homepage](https://rive.app/)
:blue_book: [General help docs](https://help.rive.app/)
:blue_book: [General help docs](https://rive.app/community/doc/introduction/docvphVOrBbl)
🛠 [Learning Rive](https://rive.app/learn-rive)
🛠 [Rive Forums](https://rive.app/community/forums/home)
## Getting started
To get started with Rive Flutter, check out the following resources:
- [Getting Started with Rive in Flutter](https://help.rive.app/runtimes/overview/flutter)
- [Alternative Widget Setup](https://help.rive.app/runtimes/overview/flutter/alternative-widget-setup)
- [Getting Started with Rive in Flutter](https://rive.app/community/doc/flutter/docqzmYRZmvF)
For additional help, see the Runtime sections of the Rive help documentation, such as:
- [Animation Playback](https://help.rive.app/runtimes/playback)
- [State Machines](https://help.rive.app/runtimes/state-machines)
For more information, see the Runtime sections of the Rive help documentation:
- [Animation Playback](https://rive.app/community/doc/animation-playback/docDKKxsr7ko)
- [Layout](https://rive.app/community/doc/layout/docBl81zd1GB)
- [State Machines](https://rive.app/community/doc/state-machines/docxeznG7iiK)
- [Rive Text](https://rive.app/community/doc/text/docn2E6y1lXo)
- [Rive Events](https://rive.app/community/doc/rive-events/docbOnaeffgr)
- [Loading Assets](https://rive.app/community/doc/loading-assets/doct4wVHGPgC)
More advanced usage:
- [Caching a RiveFile](https://rive.app/community/doc/caching-a-rive-file/docrLMDw15AJ)
- [Alternative Widget Setup](https://rive.app/community/doc/alternative-widget-setup/docNlDD0H0rp)
- [Custom Rive RenderObject](https://rive.app/community/doc/custom-rive-renderobject/docnbX5AnjkW)
- [Custom Painter](https://rive.app/community/doc/custom-rive-renderobject/docnbX5AnjkW)
## Choosing a Renderer
For more information see: https://rive.app/community/doc/overview/docD20dU9Rod
### Note on the Impeller renderer
Starting in Flutter v3.10, [Impeller](https://docs.flutter.dev/perf/impeller) has replaced [Skia](https://skia.org/) to become the default renderer for apps on the iOS platform and may continue to be the default on future platforms over time. As such, there is a possibility of rendering and [performance discrepancies](https://github.com/flutter/flutter/issues/134432) when using the Rive Flutter runtime with platforms that use the Impeller renderer that may not have surfaced before. If you encounter any visual or performance errors at runtime compared to expected behavior in the Rive editor, we recommend trying the following steps to triage:
1. Try running the Flutter app with the `--no-enable-impeller` flag to use the Skia renderer. If the visual discrepancy does not show when using Skia, it may be a rendering bug on Impeller. However, before raising a bug with the Flutter team, try the second point below👇
```bash
flutter run --no-enable-impeller
```
2. Try running the Flutter app on the latest master channel. It is possible that visual bugs may be resolved on the latest Flutter commits, but not yet released in the beta or stable channel.
3. If you are still seeing visual discrepancies with just the Impeller renderer on the latest master branch, we recommend raising a detailed issue to the [Flutter Github repo](https://github.com/flutter/flutter) with a reproducible example, and other relevant details that can help the team debug any possible issues that may be present.
## Supported platforms
Be sure to read the [platform specific considerations](platform_considerations.md) for the Rive Flutter package.
### Awesome Rive
## Awesome Rive
For even more examples and resources on using Rive at runtime or in other tools, checkout the [awesome-rive](https://github.com/rive-app/awesome-rive) repo.
@ -57,4 +87,4 @@ We love contributions and all are welcome! 💙
## Issues
Have an issue with using the runtime, or want to suggest a feature/API to help make your development life better? Log an issue in our [issues](https://github.com/rive-app/flutter/issues) tab! You can also browse older issues and discussion threads there to see solutions that may have worked for common problems.
Have an issue with using the runtime, or want to suggest a feature/API to help make your development life better? Log an issue in our [issues](https://github.com/rive-app/flutter/issues) tab! You can also browse older issues and discussion threads there to see solutions that may have worked for common problems.