Documentation improvements for ViewModel lifecycle and Android Presenter #2229
Conversation
This file contains 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
…general improvements
…FragmentPresentationAttribute
martijn00
approved these changes
Sep 26, 2017
MarcBruins
reviewed
Sep 26, 2017
|
|
||
| It should be noted however that it is not 100% reliable but it should work for most of the apps. We don't know what you do in the lifecycle of your app and what could interfere with the called order of the viewmodel lifecycle events. |
There was a problem hiding this comment.
Typo: What whether that
|
|
||
| ### MvxFragmentPresentationAttribute | ||
|
|
||
| A Fragment is hosted inside an Activity (or a fragment). By using this ViewPresenter, you can decide whether to make all of your screens Activities, or to use an Activity host and many Fragments inside of it. The framework will then help you setting up the navigation and backstack. |
There was a problem hiding this comment.
This sentence seems weird to me: "will then help you setting up the navigation and backstack"
|
|
||
| A Fragment is hosted inside an Activity (or a fragment). By using this ViewPresenter, you can decide whether to make all of your screens Activities, or to use an Activity host and many Fragments inside of it. The framework will then help you setting up the navigation and backstack. | ||
|
|
||
| The ViewPresenter supports also nested fragments in one level: This means you can show fragments inside of a Fragment without extending any code!. |
|
|
||
| ### MvxViewPagerFragmentPresentationAttribute | ||
| This attribute extends `MvxViewPagerFragmentPresentationAttribute`, which means you can use all the properties it provedes to customize the presentation. use this attribute over a Fragment view class to display a fragment inside of a ViewPager with TabLayout and take advantage of even more customization with this property: |
| @@ -75,16 +106,20 @@ The presenter is completely extensible! You can override any attribute and custo | |||
| You can also define new attributes to satisfy your needs. The steps to do so are: | |||
|
|
|||
| 1. Add a new attribute that extends `MvxBasePresentationAttribute` | |||
| 2. Subclass `MvxAppCompatViewPresenter` and make it the presenter of your application in Setup.cs (by overriding the method `CreatePresenter`). | |||
| 2. Subclass `MvxAndroidViewPresente` or `MvxAppCompatViewPresenter` and make it the presenter of your application in Setup.cs (by overriding the method `CreatePresenter`). | |||
There was a problem hiding this comment.
"MvxAndroidViewPresente"
|
@MarcBruins thanks for flagging 👍! I'll make a new PR today fixing this |
5 tasks
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.
✨ What kind of change does this PR introduce? (Bug fix, feature, docs update...)
Documentation update and minor code improvement.
Documentation for Android Presenter is very limited, also new lifecycle is not explicitly detailed anywhere.
🆕 What is the new behavior (if this is a feature change)?
Improved documentation.
💥 Does this PR introduce a breaking change?
No.
🐛 Recommendations for testing
Read the docs.
📝 Links to relevant issues/docs
🤔 Checklist before submitting