Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicholasbellucci/statefultabview
A SwiftUI TabView that retains the state of each tab as well as some other goodies.
https://github.com/nicholasbellucci/statefultabview
swift-package-manager swiftui tabview xcode
Last synced: 7 days ago
JSON representation
A SwiftUI TabView that retains the state of each tab as well as some other goodies.
- Host: GitHub
- URL: https://github.com/nicholasbellucci/statefultabview
- Owner: NicholasBellucci
- License: mit
- Created: 2020-05-08T23:16:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-31T17:03:30.000Z (about 2 years ago)
- Last Synced: 2024-12-05T10:50:14.496Z (18 days ago)
- Topics: swift-package-manager, swiftui, tabview, xcode
- Language: Swift
- Homepage:
- Size: 49.8 KB
- Stars: 325
- Watchers: 4
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StatefulTabView
A SwiftUI UITabBarController implementation that retains state between tab changes. Big thanks to [Amzd](https://gist.github.com/Amzd) and everyone who helped to refine this [gist](https://gist.github.com/Amzd/2eb5b941865e8c5cccf149e6e07c8810) as it was a major jumping off point for setting up this project.
#### Requirements
- iOS 13.0+
- Xcode 11.2+
- Swift 5+
## Installation
### Swift Package Manager
In Xcode 11 or greater, navigate to `File > Swift Packages > Add Package Dependency...`. From there just simply add `https://github.com/NicholasBellucci/StatefulTabView` as the package repository url and use the master branch or the most recent version. Master will always be inline with the newest release.
## Table of Contents
* [Features](#features)
* [Usage](#usage)
* [Basic](#basic)
* [Appearance Modifications](#appearance-modifications)
* [Selected Index](#selected-index)
* [Badge Value](#badge-value)
* [Scroll to Top with Large Titles](#scroll-to-top-with-large-titles)
* [License](#license)
## Features
- [x] State driven selected index
- [x] TabBar appearance configuration
- [x] TabBar custom tint color
- [x] TabBar custom background color
- [x] TabBarItem custom title and image
- [x] TabBarItem badge value
- [x] State retention from tab to tab
- [x] Pop to root functionality when selecting the already selected tab
- [x] Scroll to top functionality when selecting the already selected tab at the root view
## Usage
Setting up StatefulTabView is relatively simple and works similar to the native TabView. The main difference is that the content of the tabs is wrapped in a Tab struct. There is no limitation on how many tabs can be used. Once more than 5 are used, the Apple standard more tab will become available. Feel free to check out the example project for the exact usage.
### Basic
```Swift
StatefulTabView {
Tab(title: "Tab 1", systemImageName: "circle.fill") {
NavigationView {
List {
Section {
ForEach(0..<20, id: \.self) { index in
NavigationLink(destination: PushedView(text: "Pushed number \(index)")) {
Text("\(index)")
}
}
}
}
.navigationBarTitle("Navigation View 1")
}
}
}
```
### Appearance Modifications
All appearance modifications can be made by using extensions for the StatefulTabView.
```Swift
StatefulTabView {
...
}
.barTintColor(.red)
.unselectedItemTintColor(.green)
.barBackgroundColor(.yellow)
.barAppearanceConfiguration(.transparent)
```
### Selected Index
The selected index of the StatefulTabView can be set within the initializer. The passed value is a binding.
```Swift
@State var selectedIndex: Int = 2
StatefulTabView(selectedIndex: $selectedIndex) {
...
}
```
### Badge Value
The TabBarItem badge value can be set in the initializer of a Tab.
```Swift
@State var badgeValue: String = "1"
Tab(title: "Tab 1", systemImageName: "circle.fill", badgeValue: badgeValue) {
...
}
```
### Scroll to Top with Large Titles
Scroll to top is handled when selecting the already selected tab that contains a scrollView in the heirarchy. The only issue is that large titles in navigation bars are not factored in when calling `scrollRectToVisible(CGRect(x: 0, y: 0, width: 1, height: 1), animated: true)` for obvious reasons. Due to this limitation adding `.prefersLargeTitle(true)` to a `Tab` will fix this issue. For root navigation views that do not use a large title no change to a `Tab` is needed.
```Swift
Tab(title: "Tab 1", systemImageName: "circle.fill") {
NavigationView {
List {
...
}
.navigationBarTitle("Navigation View 1", displayMode: .large)
}
}
.prefersLargeTitle(true)
```
## License
StatefulTabView is, and always will be, MIT licensed. See [LICENSE](LICENSE) for details.