Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 3.02 KB

README.md

File metadata and controls

83 lines (60 loc) · 3.02 KB
Raw

FragmentOperator

A library to make managing Android fragment backstack easier!

Usage

Add to your project build.gradle file:

dependencies {
  implementation 'com.tubitv:fragmentoperator:1.1'
}

Single Activity Backstack Usage

Your Activity for Fragment operation has to extend from FoActivity. All your fragments have to extend from FoFragment.

When your Activity is ready, you need register current active Activity.

  FragmentOperator.INSTANCE.setCurrentActivity(CURRENT_ACTIVITY)

When you need to show a Fragment, use APIs in FragmentOperator:

  FragmentOperator.INSTANCE.showFragment
  • clearStack: Flag for clearing all previous backstack
  • skipOnPop: Mark new fragment to be skipped when pop backstack
  • containerId: Res ID for where the fragment should be loaded to

When you need to set a Fragment class to be single instance in backstack, just add annotation SingleInstanceFragment to your Fragment class.

  @SingleInstanceFragment
  public class CategoryFragment {}

Tabs Navigation Usage (Fragment child backstack)

FragmentOperator also supports another level of backstack navigation along with Activity backstack. It fully supports iOS tabs style navigation, which means it keeps and maintains multiple child Fragment backstacks.

Same here, to use FragmentOperator, you need make sure your Activity extend from FoActivity and Fragment extend from FoFragment.

You need build a Fragment to host all tabs and implement TabsNavigator.

Then for any fragments you want to display on a specific tab, you just add annotation TabChildFragment and put tab index. When you show fragment instance with

  FragmentOperator.INSTANCE.showFragment

FragmentOperator will automatically switch to correct tab and display Fragment instance on that tab.

FragmentOperator also supports popping all the way back to root child fragment, just like iOS.

Please refer demo project for how to use tabs navigation.

MIT License

Copyright (c) 2018 Tubi, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.