diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Changelog.md | 7 | ||||
| -rw-r--r-- | docs/Migration.md | 35 |
2 files changed, 42 insertions, 0 deletions
diff --git a/docs/Changelog.md b/docs/Changelog.md index 6a032e8..2d09855 100644 --- a/docs/Changelog.md +++ b/docs/Changelog.md @@ -1,5 +1,12 @@ # Changelog +## v3.6.0 +* :core: Created BundleUtils +* :core: [Breaking] Refactored startActivity functions +* :kpref-activity: [Breaking] Simplified listener function parameters +* :kpref-activity: [Breaking] Added dynamic string loading options +* (See Migrations.md for further details on breaking changes) + ## v3.5.1 * Add Portuguese translations * Add Galician translations diff --git a/docs/Migration.md b/docs/Migration.md new file mode 100644 index 0000000..1d8cd9d --- /dev/null +++ b/docs/Migration.md @@ -0,0 +1,35 @@ +# Migrations + +Below are some highlights on major refactoring/breaking changes + +# v3.6.0 + +## startActivity + +Before, startActivity attempted to bind a lot of options with defaults. +Instead, we will now rely on the builder pattern so users may supply their own. +Attributes like `transition` have been replaced with bundle functions such as `withSceneTransitionAnimation(context)`. +The ordering of the builder functions have also been unified so that `bundleBuilder` is always before `intentBuilder`. + +## kpref-activity + +### Click Events + +Instead of passing parameters through the click functions, which were often unused, +they will now be provided through extensions from `KClick`. + +`KClick` holds the same values you'd expect (`itemView`, `innerView` (renamed), `item`), +and adds on `context` and is loaded lazily where possible. + +### Title Res + +In an attempt to make kprefs functional and thus easy to configure, +two new functions, `titleFun` and `descFun` have been introduced. +They will be triggered whenever kprefs are updated to get an up to date stringRes +based on whatever conditions you specify. Most conditions are passed through anyways, +which is why these functions supply no additional information. + +You are still free to use the original `descRes` +and the constructor title, which has been renamed to `titleId` to emphasis its immutability. +Reloading kprefs are always done through the original `titleId`, +regardless of the actual resource currently used.
\ No newline at end of file |