Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivanvorobei/sppagecontroller
Mimicrate to UIPageViewController. Has native system and scroll view paging. Support scroll to page and layout margins from container.
https://github.com/ivanvorobei/sppagecontroller
controller onboarding page pages swift tutorial uikit uipageviewcontroller xcode
Last synced: 22 days ago
JSON representation
Mimicrate to UIPageViewController. Has native system and scroll view paging. Support scroll to page and layout margins from container.
- Host: GitHub
- URL: https://github.com/ivanvorobei/sppagecontroller
- Owner: ivanvorobei
- License: mit
- Created: 2021-10-14T14:07:20.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-27T17:21:02.000Z (over 2 years ago)
- Last Synced: 2024-09-17T15:43:34.979Z (about 2 months ago)
- Topics: controller, onboarding, page, pages, swift, tutorial, uikit, uipageviewcontroller, xcode
- Language: Swift
- Homepage: https://opensource.ivanvorobei.io
- Size: 1.67 MB
- Stars: 57
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SPPageController
Mimicrate to native `UIPageViewController`. Each page is new controller, it can be even navigation controller. You can add any class of controllers like child. Support parent layout margins, paging and scroll by index.
You can scroll to any page programatically. If you need pages for onboarding, you can disable scroll by gester and disable swipe to dismiss.
## Navigate
- [Installation](#installation)
- [Swift Package Manager](#swift-package-manager)
- [CocoaPods](#cocoapods)
- [Manually](#manually)
- [Usage](#usage)
- [Present](#usage)
- [Scroll](#scroll)
- [Dismiss](#dismiss)
- [Russian Community](#russian-community)
## Installation
Ready for use on iOS 12+.
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.
Once you have your Swift package set up, adding as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/ivanvorobei/SPPageController", .upToNextMajor(from: "1.3.0"))
]
```
### CocoaPods:
[CocoaPods](https://cocoapods.org) is a dependency manager. For usage and installation instructions, visit their website. To integrate using CocoaPods, specify it in your `Podfile`:
```ruby
pod 'SPPageController'
```
### Manually
If you prefer not to use any of dependency managers, you can integrate manually. Put `Sources/SPPageController` folder in your Xcode project. Make sure to enable `Copy items if needed` and `Create groups`.
## Usage
`SPPageController` is container controller. Now available 2 system of paging - `.scroll` and `.page`. First using `UICollectionView` like basic view, its good work with content offset but not perfect when device rotated. Second using native `UIPageViewController`. You shoud choose which better for you.
Pass child controllers which using like pages and simple present page controller as you need:
```swift
// Here your controllers
let controllers: [UIViewController] = []
let pageController = SPPageController(childControllers: controllers, system: .page)
present(pageController, animated: true, completion: nil)
```
You can manage layout margins of container. Apple still has bug with it, but my way support it correctly:
```swift
pageController.view.layoutMargins = .init(horizontal: 50, vertical: 0)
// Don't forget enable preserve layout margins for childs:
// childController.view.preservesSuperviewLayoutMargins = true
```
Now for all childs left and right margins will be +50pt.
### Scroll
If you want scroll only programatically, disable scroll between pages by gester:
```swift
pageController.allowScroll = false
```
For scroll by index call this function:
```swift
pageController.safeScrollTo(index: 3, animated: true)
```
### Dismiss
If need disable dismiss by gester (related for modal controllers), set flag to `false`:
```swift
pageController.allowDismissWithGester = false
```
## Russian Community
Я веду [телеграм-канал](https://sparrowcode.io/telegram), там публикую новости и туториалы.
С проблемой помогут [в чате](https://sparrowcode.io/telegram/chat).
Видео-туториалы выклыдываю на [YouTube](https://ivanvorobei.io/youtube):
[](https://ivanvorobei.io/youtube)