♻️ Update documentation for SplashMaster API changes and lifecycle methods#121
Open
lavigarg-simform wants to merge 1 commit into
Open
♻️ Update documentation for SplashMaster API changes and lifecycle methods#121lavigarg-simform wants to merge 1 commit into
lavigarg-simform wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Splash Master migration documentation to clarify the removal of the legacy SplashMaster factory API and its lifecycle methods in v1.0.0, addressing user confusion seen in issue #119.
Changes:
- Updates migration guides to state the
SplashMasterfactory class andSplashMaster.initialize()/SplashMaster.resume()are removed. - Adds a dedicated “Removed SplashMaster Lifecycle Methods” section with before/after migration examples.
- Updates
splash_masterpackage changelog to mention the lifecycle-method removal.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
doc/documentation.md |
Updates migration guide + breaking changes summary; adds new section on removed lifecycle methods. |
splash_master/doc/documentation.md |
Mirrors the migration documentation updates inside the splash_master package docs. |
splash_master/CHANGELOG.md |
Adds a v1.0.0 changelog bullet documenting lifecycle method removal. |
Comments suppressed due to low confidence (4)
doc/documentation.md:438
- The migration guide says to call the widget's
.initialize()and.resume()inmain(). In the animation widgets,resume()is invoked automatically when the source finishes loading (unlessonSourceLoadedis overridden), so instructing users to callresume()inmain()defeats the first-frame deferral. Please update the guidance to call<Widget>.initialize()beforerunApp(), and only call<Widget>.resume()manually if you overrideonSourceLoaded(or equivalent) and don’t callresume()there.
#### For Animation Widgets
If using `SplashMasterRive`, `SplashMasterVideo`, or `SplashMasterLottie`, call the respective widget's `.initialize()` and `.resume()` methods in your main function.
doc/documentation.md:452
- Inconsistency within this document: this row says
SplashMaster.initialize()/resume()were "required for all splash types" in 0.0.3, but later the migration guide states native image/color splash "never needed these methods". Please adjust the 0.0.3 behavior text to match the native-vs-animation distinction (e.g., first-frame control for animation widgets only).
| `SplashMaster` factory class | Unified entry point for all splash animations | Removed — use dedicated sub-package widgets instead |
| **Initialization / Lifecycle methods** | **`SplashMaster.initialize()` and `SplashMaster.resume()` required for all splash types** | **`SplashMaster.initialize()` and `SplashMaster.resume()` are no longer supported.** Use the respective animation widget's `.initialize()` and `.resume()` methods instead (e.g., `SplashMasterRive.initialize()`). Not needed for native image/color splash. |
splash_master/doc/documentation.md:234
- The migration guide says to call the widget's
.initialize()and.resume()inmain(). In the animation widgets,resume()is invoked automatically when the source finishes loading (unlessonSourceLoadedis overridden), so instructing users to callresume()inmain()defeats the first-frame deferral. Please update the guidance to call<Widget>.initialize()beforerunApp(), and only call<Widget>.resume()manually if you overrideonSourceLoaded(or equivalent) and don’t callresume()there.
#### For Animation Widgets
If using `SplashMasterRive`, `SplashMasterVideo`, or `SplashMasterLottie`, call the respective widget's `.initialize()` and `.resume()` methods in your main function.
splash_master/doc/documentation.md:248
- Inconsistency within this document: this row says
SplashMaster.initialize()/resume()were "required for all splash types" in 0.0.3, but later the migration guide states native image/color splash "never needed these methods". Please adjust the 0.0.3 behavior text to match the native-vs-animation distinction (e.g., first-frame control for animation widgets only).
| `SplashMaster` factory class | Unified entry point for all splash animations | Removed — use dedicated sub-package widgets instead |
| **Initialization / Lifecycle methods** | **`SplashMaster.initialize()` and `SplashMaster.resume()` required for all splash types** | **`SplashMaster.initialize()` and `SplashMaster.resume()` are no longer supported.** Use the respective animation widget's `.initialize()` and `.resume()` methods instead (e.g., `SplashMasterRive.initialize()`). Not needed for native image/color splash. |
6ea5ff1 to
f8f5dd5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the documentation to clearly document the removal of the
SplashMaster.initialize()andSplashMaster.resume()lifecycle methods in the migration / breaking changes sections.Specifically:
doc/documentation.mdto reflect thatSplashMaster.initialize()andSplashMaster.resume()are no longer supported in v1.0.0.## 7) Removed SplashMaster Lifecycle Methodsto the migration guide with:SplashMaster.initialize()andSplashMaster.resume()have been removed.SplashMasterRive.initialize(),SplashMasterVideo.initialize(),SplashMasterLottie.initialize()).Files changed:
doc/documentation.mdsplash_master/doc/documentation.mdCHANGELOG.mdChecklist
docs:suggested).doc/and/or package README(s), and added dartdoc comments with///where applicable.example/and/orsplash_master_{rive,video,lottie}/example/.README.md,CHANGELOG.md, and package-level docs where applicable). (Documentation file updated —doc/documentation.md.)Impacted package(s)
Breaking Change?
Related Issues