Skip to content

♻️ Update documentation for SplashMaster API changes and lifecycle methods#121

Open
lavigarg-simform wants to merge 1 commit into
masterfrom
fix/I119-update-docs
Open

♻️ Update documentation for SplashMaster API changes and lifecycle methods#121
lavigarg-simform wants to merge 1 commit into
masterfrom
fix/I119-update-docs

Conversation

@lavigarg-simform

Copy link
Copy Markdown
Contributor

Description

This PR updates the documentation to clearly document the removal of the SplashMaster.initialize() and SplashMaster.resume() lifecycle methods in the migration / breaking changes sections.

Specifically:

  • Updates doc/documentation.md to reflect that SplashMaster.initialize() and SplashMaster.resume() are no longer supported in v1.0.0.
  • Updates the "Breaking Changes Summary" table row for Initialization / Lifecycle methods to state removal.
  • Adds a new section ## 7) Removed SplashMaster Lifecycle Methods to the migration guide with:
    • A clear statement that SplashMaster.initialize() and SplashMaster.resume() have been removed.
    • Guidance for native image/color splash (no action required).
    • Migration examples showing before (0.0.3) and after (1.0.0) usage, with concrete suggestions to use the widget-specific methods (SplashMasterRive.initialize(), SplashMasterVideo.initialize(), SplashMasterLottie.initialize()).
  • No code changes were made — documentation-only.

Files changed:

  • doc/documentation.md
  • splash_master/doc/documentation.md
  • CHANGELOG.md

Checklist

  • The title of my PR starts with a [Conventional Commit] prefix (docs: suggested).
  • I have followed the [Contributor Guide] when preparing my PR (docs-only change; follows repository docs conventions).
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in doc/ and/or package README(s), and added dartdoc comments with /// where applicable.
  • I have updated/added relevant examples in example/ and/or splash_master_{rive,video,lottie}/example/.
  • I have updated impacted package metadata/docs (for example: README.md, CHANGELOG.md, and package-level docs where applicable). (Documentation file updated — doc/documentation.md.)

Impacted package(s)

  • splash_master (core) — documentation updated
  • splash_master_rive
  • splash_master_video
  • splash_master_lottie

Breaking Change?

  • Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

Related Issues

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 SplashMaster factory class and SplashMaster.initialize() / SplashMaster.resume() are removed.
  • Adds a dedicated “Removed SplashMaster Lifecycle Methods” section with before/after migration examples.
  • Updates splash_master package 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() in main(). In the animation widgets, resume() is invoked automatically when the source finishes loading (unless onSourceLoaded is overridden), so instructing users to call resume() in main() defeats the first-frame deferral. Please update the guidance to call <Widget>.initialize() before runApp(), and only call <Widget>.resume() manually if you override onSourceLoaded (or equivalent) and don’t call resume() 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() in main(). In the animation widgets, resume() is invoked automatically when the source finishes loading (unless onSourceLoaded is overridden), so instructing users to call resume() in main() defeats the first-frame deferral. Please update the guidance to call <Widget>.initialize() before runApp(), and only call <Widget>.resume() manually if you override onSourceLoaded (or equivalent) and don’t call resume() 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. |

Comment thread doc/documentation.md Outdated
Comment thread splash_master/doc/documentation.md Outdated
Comment thread splash_master/CHANGELOG.md Outdated
@lavigarg-simform lavigarg-simform marked this pull request as ready for review May 18, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SplashMaster undefined after updating to latest version (v1.0.0)

2 participants