https://github.com/tubitv/fragmentoperator
A library to make managing Android fragment backstack easier!
https://github.com/tubitv/fragmentoperator
android fragment fragment-backstack
Last synced: 9 months ago
JSON representation
A library to make managing Android fragment backstack easier!
- Host: GitHub
- URL: https://github.com/tubitv/fragmentoperator
- Owner: Tubitv
- License: mit
- Created: 2018-08-31T18:35:27.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-20T22:01:42.000Z (about 6 years ago)
- Last Synced: 2025-07-28T08:14:27.035Z (11 months ago)
- Topics: android, fragment, fragment-backstack
- Language: Kotlin
- Homepage:
- Size: 198 KB
- Stars: 16
- Watchers: 8
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FragmentOperator
A library to make managing Android fragment backstack easier!
## Usage
Add to your project `build.gradle` file:
```groovy
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`.
```java
FragmentOperator.INSTANCE.setCurrentActivity(CURRENT_ACTIVITY)
```
When you need to show a `Fragment`, use APIs in FragmentOperator:
```java
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.
```java
@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
```java
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.