Repository navigation
Support ViewModel Reassignment on CurrentWidget Rebuilds - #17
Merged
Merged
Conversation
…stance of a widget
…ake to support reassignment of view models
jshep23
added a commit
that referenced
this pull request
Apr 28, 2026
* Support ViewModel Reassignment on CurrentWidget Rebuilds (#17) * Added option to allow reassigning an existing view model to an new instance of a widget * Assign the ViewModel to the hash of the state instead of the CurrentWidget * Fix assignedTo check in ViewModel * Update the already assigned exception to explain steps the user can take to support reassignment of view models * Grammar... * Grammar... * Format exception message * Add documentation to CurrentState * Allow setting CurrentProperty by directly setting the value * Enhance State Change Handling (#18) * Changed StateChanged Stream to a single Event broadcaster Added listenable support to busy status changes * Updated example app to use new state changes * Expand ErrorEvent handling options. Allow specific subscribing, and handling internal errors * Add error handling example to example application * Added isDirty property. Added factory shorthands for current specific primary property types * Export CurrentClonable * Update example view model to use new shorthand factory * Added calculated isDirty getter to CurrentViewModel * Add tests for isDirty prop * Add docs to new BusyStatusChanged event * Current Text Controller (#19) * Implemented controller. Fixed vm reset not clearing busy status. * Added CurrentTextController to Example project * Fix type check on date time controller * Fix default value, and hash equality assignments and checks * Updated text field carrot snapback to select text when backspacing on a non-null field * Fix date time asString when cant be parsed. added tests for other supported types * Fix issue when resetting view model or using setMultiple manually. add test * Update example. Added missing test. * Clean up * Make example page scrollable * Add seperate custom and any state change listener * Add seperate custom and any error event listeners * Fix issue where lists and maps marked as dirty on initial set. * Fixed an issue where calling resetAll on the view model behaved differently for lists and maps * Report prop name and hash on list/map change. report inserted item instead of whole list. added tests * Optionally allow external / parent widget to handle viewmodel lifecycle. * Fix issue where setMultiple always issued notifications, even if nothing actually changed. * Update value equality implementation. This fixes issues with map keys, and odd comparison results. Updated stale test descriptions. * deprecated math functions on int property (generics were odd since you can't impl num) * added tests for the new int property functions. * added tests to cover null scenarios in double property math functions * Current Validation & Revamp Example App (#20) * Clean up statle documentation * added current validation state. added additive extension (nonbreaking). * add docs to new current validation classes. fix docs in view model. export current validation * add some docs around the _omitted internal variable. added unit tests * progress on integrating current validation with new current text controller. * Add option to localize default validation errors * Add additional docs to the current text controller * update core web files for example app * Progress on new space themed example app. added logos. removed old example page * added flight forms page. redfactored app view model * added launch missing, map and telemetry examples * added widget tests * add third version branding * Move viewmodels out of widget pages * clean up * clean up * clean up * add code examples to example app. add link to third version website * Restructure validation results to produce typed issues. This is to support localization without coupling ui to view models * Update Readmes * Change current validation to explicit opt in. Reduces footguns. Update docs and examples. * clean up example propery initialization * Clean up validation registration. better support context based localization * Remove unused mixin. Remove tests * Tie validation execution to TextFormFields. Added convenience Current text widgets without losing native support * Added tests for text form field integration * Update readme * add convenience setter functions for various properties * Rename factories on CurrentTextController for consistency * 3.0.0 Beta 1 (#21) * bump version, generate docs * Add changelog entry * Improve DX When Binding CurrentTextControllers (#23) * Add type specific controllers to tighten api around binding * update documentation
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
1 participant
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.
This pull request introduces several improvements and updates to both the example app and the core library. The most significant changes include enhancing the counter example with a form for direct count input, updating SDK and dependency versions, clarifying error messages and documentation around view model assignment, and improving property reactivity. There are also minor updates to macOS deployment targets.
Example App Enhancements:
Formwith aTextFormFieldto the counter example, allowing users to set the counter value directly by entering a number. This form is managed with a newformKey. [1] [2] [3] [4]Dependency and Platform Updates:
>=3.0.0 <4.0.0, bumped theuuidandflutter_lintspackage versions, and updated the macOS deployment target from 10.14 to 10.15. [1] [2] [3] [4]Error Handling and Documentation Improvements:
CurrentViewModelAlreadyAssignedExceptionmessage to provide clearer guidance and actionable steps, especially regarding widget rebuilding and use ofAutomaticKeepAliveClientMixin. [1] [2]CurrentViewModelto clarify that assignment is to aCurrentState(not just a widget), and improved the logic to prevent multiple assignments. [1] [2] [3]Reactivity Improvements:
valueproperty inCurrentPropertythat updates the value and triggers UI updates only when the value actually changes, with clear documentation on its behavior.