Repository navigation
docs(flutter): migration guide for 0.15.0 - #956
Conversation
- Add a Version 0.15.0 section covering the two migrations in the release: Data Binding now binds when RiveWidgetController is constructed (removed controller.dataBind, RiveWidgetBuilder.dataBind and RiveLoaded.viewModelInstance, the package:rive/legacy.dart bridge, instance ownership, read-backs that cannot be bound again) and the Rive Renderer's deferred rendering on native (threading contract, batch advance API removal, riveFactory, one artboard instance per texture, Factory.rive session resolution, rive_deferred.dart). - Note the corrected Flutter 3.32.0 / Dart 3.8.0 floor. - Open the guide with a version table linking each major's section. - Bump versionDevFlutter to 0.15.0-dev.2.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
There was a problem hiding this comment.
🟡 Changes recommended
The version links are broken, and the shared version bump makes existing Flutter examples target incompatible APIs.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Adds Flutter 0.15.0 migration guidance for breaking runtime changes.
Changes:
- Documents Data Binding API migration and ownership.
- Explains deferred native rendering requirements.
- Updates the Flutter development version.
File summaries
| File | Description |
|---|---|
runtimes/flutter/migration-guide.mdx |
Adds the 0.15.0 migration section and version index. |
docs.json |
Bumps Flutter’s development version to 0.15.0-dev.2. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 3
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| # pubspec.yaml | ||
| dependencies: | ||
| rive: ^{{versionDevFlutter}} | ||
| rive: ^{{versionFlutter}} |
There was a problem hiding this comment.
@lancesnider this reverts what you did. We should from now on always link to stable releases for Flutter (and any runtime in the getting-started sections)
There was a problem hiding this comment.
🟢 Approval recommended
The documentation is coherent and appropriately scoped, with only a non-blocking grammar correction remaining.
Review details
Suppressed comments (1)
Previously missed (1) — in code that hasn't changed since the last review.
runtimes/flutter/migration-guide.mdx:55
- Use the present passive tense here so the sentence is grammatical: “before anything is rendered.”
- Files reviewed: 3/3 changed files
- Comments generated: 0 new
- Review effort level: Balanced
Adds a Version 0.15.0 section to the Flutter migration guide, and a version table at the top of the page linking each major.
Two migrations are covered.
Data binding.
RiveWidgetControllerbinds at construction (main plus every global view model), socontroller.dataBind,RiveWidgetBuilder.dataBindandRiveLoaded.viewModelInstanceare gone. The section gives the per-call replacements, the unbound to authored-defaults behavior change,package:rive/legacy.dartas a bridgethat needs no call-site changes, instance ownership, and why read-backs cannot be bound again.
Deferred rendering. The Rive Renderer is deferred-only on native: UI-thread contract,
Rive.batchAdvance/batchAdvanceAndRenderremoval, theRenderTexturePainter.riveFactorydefault, one artboard instance per texture,Factory.rivesession resolution, andrive_deferred.dart.Also notes the corrected Flutter 3.32.0 (Dart 3.8.0) floor and bumps
versionDevFlutterto 0.15.0-dev.2.Scope is deliberately this one page. 0.15 is still a dev release, so no other Flutter page is bumped to 0.15.x yet. The deferred renderer page sweep (custom-painter rewrite, FAQ entries, flutter.mdx, rive-native, renderer overview) waits for the stable release. See BACKLOG "docs: flutter deferred renderer page sweep (0.15 stable)".