Need help with PagingKit?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

kazuhiro4949
1.1K Stars 92 Forks MIT License 630 Commits 18 Opened issues

Description

PagingKit provides customizable menu UI. It has more flexible layout and design than the other libraries.

Services available

!
?

Need anything else?

Contributors list

img

Platform Swift 5.1 License Version Carthage compatible Swift Package Manager compatible

PagingKit provides customizable menu & content UI. It has more flexible layout and design than the other libraries.

What's this?

There are many libraries providing "Paging UI" which have menu and content area. They are convenient but not customizable because your app has to be made compatible with the libraries' layout and view components. When a UI desgin in your app doesn't fit the libraries, you need to fork them or find another one.

PagingKit has more flexible layout and design than the other libraries. You can construct "Menu" and "Content" UI, and they work together. That's all features this library provides. You can fit any design to your apps as you like.

paging_sample

Customized layout

You can align views as you like.

| changing position | placing a view between content and menu | added floating button on right-side | on navigation bar | |:------------:|:------------:|:------------:|:------------:| | sample_5 | sample_4 | sample6 | 2018-12-04 10 00 51 |

Customized menu design

You can customize menu as you like.

| tag like menu | text highlighted menu | underscore menu | App Store app like indicator | |:------------:|:------------:|:------------:|:------------:| | sample_3 | | sample_1 | indicator |

I'm looking for a pull request of your custom menu design :)

Feature

  • [x] easy to construct Paging UI
  • [x] customizable layout and design
  • [x] UIKit like API
  • [x] Supporting iPhone, iPad and iPhone X

Requirements

  • iOS 9.0+
  • Xcode 11.0+
  • Swift 5.1

Installation

Swift Package Manager

open Swift Packages (which is next to Build Settings). You can add and remove packages from this tab.

See Adding Package Dependencies to Your App

CocoaPods

  • Install CocoaPods
    > gem install cocoapods
    > pod setup
    
  • Create Podfile
    > pod init
    
  • Edit Podfile ```ruby target 'YourProject' do use_frameworks!

pod "PagingKit" # add

target 'YourProject' do inherit! :search_paths end

target 'YourProject' do inherit! :search_paths end

end ```

  • Install
> pod install

open .xcworkspace

Carthage

  • Install Carthage from Homebrew
    > ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
    > brew update
    > brew install carthage
    
  • Move your project dir and create Cartfile
    > touch Cartfile
    
  • add the following line to Cartfile
    github "kazuhiro4949/PagingKit"
    
  • Create framework ```

    carthage update --platform iOS ```

  • In Xcode, move to "Genera > Build Phase > Linked Frameworks and Library"

  • Add the framework to your project

  • Add a new run script and put the following code

    /usr/local/bin/carthage copy-frameworks
    
  • Click "+" at Input file and Add the framework path

    $(SRCROOT)/Carthage/Build/iOS/PagingKit.framework
    
  • Write Import statement on your source file

    import PagingKit
    

Getting Started

There are some samples in this library.

https://github.com/kazuhiro4949/PagingKit/tree/master/iOS%20Sample/iOS%20Sample

You can fit PagingKit into your project as the samples do. Check out this repository and open the workspace.

PagingKit has two essential classes. - PagingMenuViewController - PagingContentViewController

PagingMenuViewController provides interactive menu for each content. PagingContentViewController provides the contents on a scrollview.

If you make a new project which contains PagingKit, follow the steps.

  1. Add PagingMenuViewController & PagingContentViewController
  2. Assign them to properties
  3. Create menu UI
  4. display data
  5. Synchronize Menu and Content view controllers

1. Add PagingMenuViewController & PagingContentViewController

First, add PagingMenuViewController & PagingContentViewController on container view with Stroyboard.

1. Put container views on Storyboard

Put container views on stroyboard for each the view controllers.

2017-08-25 16 33 51

2. Change class names

input PagingMenuViewController on custom class setting. 2017-08-25 16 36 36

input PagingContentViewController on custom class setting.

2017-08-25 16 36 54

2. Assign them to properties

Assign them on code of the container view controller.

1. Declare properties for the view controllers

Declare properties in container view controller. ```swift class ViewController: UIViewController {

var menuViewController: PagingMenuViewController!
var contentViewController: PagingContentViewController!
### 2. override prepare(segue:sender:) and assign the view controllers
Assigin view controllers to each the property on ```prepare(segue:sender:)```.

```swift override func prepare(for segue: UIStoryboardSegue, sender: Any?) { if let vc = segue.destination as? PagingMenuViewController { menuViewController = vc } else if let vc = segue.destination as? PagingContentViewController { contentViewController = vc } }

3. Build App

Change menu color. 2017-08-25 17 47 58

Build and check the current state.

2017-08-25 17 47 29

It shows a container view controller that has PagingMenuViewController and PagingContentViewController.

3. Create menu UI

Next, you needs to prepare the menu elements.

1. Inherite PagingMenuViewCell and create custom cell

PagingKit has PagingMenuViewCell. PagingMenuViewController uses it to construct each menu element.

import UIKit
import PagingKit

class MenuCell: PagingMenuViewCell { @IBOutlet weak var titleLabel: UILabel! }

2017-08-25 16 56 56

2. Inherite PagingFocusView and create custom view

PagingKit has PagingFocusView. PagingMenuViewController uses it to point the current focusted menu.

2017-08-25 16 59 07

3. register the above views to PagingMenuViewController

class ViewController: UIViewController {

var menuViewController: PagingMenuViewController!
var contentViewController: PagingContentViewController!

override func viewDidLoad() {
    super.viewDidLoad()

    menuViewController.register(nib: UINib(nibName: "MenuCell", bundle: nil), forCellWithReuseIdentifier: "MenuCell")
    menuViewController.registerFocusView(nib: UINib(nibName: "FocusView", bundle: nil))
}

4. display data

Then, implement the data sources to display contents. They are a similar to UITableViewDataSource.

1. prepare data

class ViewController: UIViewController {
    static var viewController: (UIColor) -> UIViewController = { (color) in
       let vc = UIViewController()
        vc.view.backgroundColor = color
        return vc
    }

var dataSource = [(menuTitle: "test1", vc: viewController(.red)), (menuTitle: "test2", vc: viewController(.blue)), (menuTitle: "test3", vc: viewController(.yellow))]

2. set menu data source

Return number of menus, menu widthes and PagingMenuViewCell objects.

    override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
        if let vc = segue.destination as? PagingMenuViewController {
            menuViewController = vc
            menuViewController.dataSource = self //  Int {
        return dataSource.count
    }

func menuViewController(viewController: PagingMenuViewController, widthForItemAt index: Int) -> CGFloat {
    return 100
}

func menuViewController(viewController: PagingMenuViewController, cellForItemAt index: Int) -> PagingMenuViewCell {
    let cell = viewController.dequeueReusableCell(withReuseIdentifier: "MenuCell", for: index) as! MenuCell
    cell.titleLabel.text = dataSource[index].menuTitle
    return cell
}

}

3. configure content data source

Return the number of contents and view controllers.

    override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
        if let vc = segue.destination as? PagingMenuViewController {
            menuViewController = vc
            menuViewController.dataSource = self
        } else if let vc = segue.destination as? PagingContentViewController {
            contentViewController = vc
            contentViewController.dataSource = self //  Int {
        return dataSource.count
    }

func contentViewController(viewController: PagingContentViewController, viewControllerAt index: Int) -> UIViewController {
    return dataSource[index].vc
}

}

4. load UI

Call reloadData() methods with starting point.

    override func viewDidLoad() {
        super.viewDidLoad()
        //...
        //...
        menuViewController.reloadData()
        contentViewController.reloadData()
    }

Build and display data source.

2017-08-25 17 54 30

5. Synchronize Menu and Content view controllers

Last, synchronize user interactions between Menu and Content.

1. set menu delegate

    override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
        if let vc = segue.destination as? PagingMenuViewController {
            menuViewController = vc
            menuViewController.dataSource = self
            menuViewController.delegate = self // 

Implement menu delegate to handle the event. It is a similar to UITableViewDelegate. You need to implement scroll method of PagingContentViewController in the delegate method.

extension ViewController: PagingMenuViewControllerDelegate {
    func menuViewController(viewController: PagingMenuViewController, didSelect page: Int, previousPage: Int) {
        contentViewController.scroll(to: page, animated: true)
    }
}

2. set content delegate

    override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
        if let vc = segue.destination as? PagingMenuViewController {
            menuViewController = vc
            menuViewController.dataSource = self
            menuViewController.delegate = self
        } else if let vc = segue.destination as? PagingContentViewController {
            contentViewController = vc
            contentViewController.dataSource = self
            contentViewController.delegate = self // 

Implement content delegate to handle the event. It is similar to UIScrollViewDelegate. You need to implement the scroll event of PagingMenuViewController. "percent" is distance from "index" argument to the right-side page index.

extension ViewController: PagingContentViewControllerDelegate {
    func contentViewController(viewController: PagingContentViewController, didManualScrollOn index: Int, percent: CGFloat) {
        menuViewController.scroll(index: index, percent: percent, animated: false)
    }
}

That's it.

Tips

Class Design

There are some design policy in this library.

  • The behavior needs to be specified by the library.
  • The layout should be left to developers.
  • Arrangement of the internal components must be left to developers.

Because of that, PagingKit has responsiblity for the behavior. But it doesn't specify a structure of the components. PagingKit favours composition over inheritance. This figure describes overview of the class diagram.

Work with RxSwift

PagingKit goes well with RxSwift.

https://github.com/kazuhiro4949/RxPagingKit

    let items = PublishSubject()

override func viewDidLoad() {
    super.viewDidLoad()

    menuViewController?.register(type: TitleLabelMenuViewCell.self, forCellWithReuseIdentifier: "identifier")
    menuViewController?.registerFocusView(view: UnderlineFocusView())

    // PagingMenuViewControllerDataSource
    items.asObserver()
        .map { items in items.map({ ($0.menu, $0.width) }) }
        .bind(to: menuViewController.rx.items(
            cellIdentifier: "identifier",
            cellType: TitleLabelMenuViewCell.self)
        ) { _, model, cell in
            cell.titleLabel.text = model
        }
        .disposed(by: disposeBug)

    // PagingContentViewControllerDataSource
    items.asObserver()
        .map { items in items.map({ $0.content }) }
        .bind(to: contentViewController.rx.viewControllers())
        .disposed(by: disposeBug)

    // PagingMenuViewControllerDelegate
    menuViewController.rx.itemSelected.asObservable().subscribe(onNext: { [weak self] (page, prev) in
        self?.contentViewController.scroll(to: page, animated: true)
    }).disposed(by: disposeBug)

    // PagingContentViewControllerDelegate
    contentViewController.rx.didManualScroll.asObservable().subscribe(onNext: { [weak self] (index, percent) in
        self?.menuViewController.scroll(index: index, percent: percent, animated: false)
    }).disposed(by: disposeBug)
}

License

Copyright (c) 2017 Kazuhiro Hayashi

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.