PageViewController current page index in Swift

Question

I want to get current index of a pageViewController, I don't know how I get the visible pages index.

func pageViewController(pageViewController: UIPageViewController, didFinishAnimating finished: Bool,previousViewControllers: [UIViewController],transitionCompleted completed: Bool)
{
    // How to get it?

}

see this link may be helps you http://stackoverflow.com/questions/8400870/uipageviewcontroller-return-the-current-visible-view — Anbu.Karthik, Sep 28 '15 at 12:23

score 37 · Accepted Answer · answered Sep 28 '15 at 12:38

37

You can use didFinishAnimating, and set tags to viewcontrollers. try this

func pageViewController(pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool)
{
   if (!completed)
  {
    return
  }
  self.pageControl.currentPageIndex = pageViewController.viewControllers!.first!.view.tag //Page Index
}

answered Sep 28 '15 at 12:38

manukv

2,031
18
30

17

but `pageViewController.viewControllers!.first!.view.tag` is always `0` because it's always first :( – David Seek Sep 17 '16 at 09:14
Yes David Seek, you could use the `func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool)` – Pierre Perrin Aug 30 '17 at 09:46
1

This comes across as a hack. Use of UIView tags and explicitly unwrapped optionals are both bad practices. Not only is there a performance overhead -- tags are implemented with `objc_get/setAssociatedObject()` which requires a dictionary lookup for each get or set -- but there's always a way to accomplish what's done with a tag some other way. – FrothSturgeon Feb 19 '20 at 18:33
3

**THIS IS NOW DEAD EASY** scroll down to @igor 's answer. For anyone googling here DON'T use this very out of date answer. – Fattie Jun 27 '20 at 21:06
@igor's answer link https://stackoverflow.com/a/60562632/3145189 – Sheshnath Mar 17 '22 at 11:47

score 36 · Answer 2 · answered Mar 06 '20 at 10:56

36

Add this code to your UIPageViewController.

var pages = [UIViewController]()
var currentIndex: Int {
    guard let vc = viewControllers?.first else { return 0 }
    return pages.firstIndex(of: vc) ?? 0
}

answered Mar 06 '20 at 10:56

Igor

12,165
4
57
73

In implementation of class UIPageViewController. – Igor Nov 27 '20 at 09:36
perfect, still works great in 2023! – Jan L Feb 15 '23 at 15:41

George Bikas · Answer 3 · 2017-06-29T09:38:29.557

In Swift 3

Override didFinishAnimating function of UIPageViewControllerDelegate like this:

func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool) {
    if completed {
        if let currentViewController = pageViewController.viewControllers![0] as? WalkthroughContentViewController {
            pageControl.currentPage = currentViewController.index
        }
    }
}

where WalkthroughContentViewController is the UIViewController presented by UIPageViewController

Remember to keep an index variable inside the WalkthroughContentViewController. Also, in the viewDidLoad method set:

delegate = self

Peter Kreinz · Answer 4 · 2017-02-06T22:30:07.773

Swift 3: full programmatic PageViewController example to get/set the current page index without view tagging:

enum PageViewType:String {
        case green = "greenView"
        case blue = "blueView"
        case red = "redView"  
}

class MyPageViewController: UIPageViewController {

    private (set) lazy var orderedViewControllers:[UIViewController] = {
         return [self.newPageView(.green),
                self.newPageView(.blue),
                self.newPageView(.red)
        ]
    }

    var currentIndex:Int {
            get {
                return orderedViewControllers.index(of: self.viewControllers!.first!)!
            }

            set {
                guard newValue >= 0,
                    newValue < orderedViewControllers.count else {
                    return
                }

                let vc = orderedViewControllers[newValue]
                let direction:UIPageViewControllerNavigationDirection = newValue > currentIndex ? .forward : .reverse            
                self.setViewControllers([vc], direction: direction, animated: true, completion: nil) 
            }
        }

    override func viewDidLoad() {
        super.viewDidLoad()

        dataSource = self

        if let firstViewController = orderedViewControllers.first {
            setViewControllers([firstViewController],
                           direction: .forward,
                           animated: true,
                           completion: nil)
        }
    }

    private func newPageView(_ viewType:PageViewType) -> UIViewController {
        let vc = self.storyboard?.instantiateViewController(withIdentifier: viewType.rawValue)       
        return vc
    }
}

UIPageViewController DataSource implementation:

extension MyPageViewController:UIPageViewControllerDataSource {

    func pageViewController(_ pageViewController: UIPageViewController, viewControllerBefore viewController: UIViewController) -> UIViewController? {

        let previousIndex = currentIndex - 1

        guard previousIndex >= 0 else {
            return nil
        }

        guard orderedViewControllers.count > previousIndex else {
            return nil
        }

        return orderedViewControllers[previousIndex]   
    }

    func pageViewController(_ pageViewController: UIPageViewController, viewControllerAfter viewController: UIViewController) -> UIViewController? {         
        let nextIndex = currentIndex + 1

        guard orderedViewControllers.count != nextIndex else {
            return nil
        }

        guard orderedViewControllers.count > nextIndex else {
            return nil
        }

        return orderedViewControllers[nextIndex]
    }

    func presentationCountForPageViewController(pageViewController: UIPageViewController) -> Int {
        return orderedViewControllers.count
    }

    func presentationIndexForPageViewController(pageViewController: UIPageViewController) -> Int {

        return currentIndex
    }
}

your code crashing if i swipe left or right .... Fatal error: Unexpectedly found nil while unwrapping an Optional — karthikeyan, Dec 01 '20 at 13:14

FrothSturgeon · Answer 5 · 2020-02-07T15:42:32.037

First, have your UIPageViewController implement the UIPageViewControllerDataSource method presentationIndex(for pageViewController: UIPageViewController) -> Int to return the index for each of the PageViewController's ViewControllers.

Then in your delegate, access the datasource through the passed-in PageViewController:

func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool) {
    guard let dataSource = pageViewController.dataSource, 
          let currentIndex = dataSource.presentationIndex?(for: pageViewController) else { preconditionFailure() }

}

score 3 · Answer 6 · answered Feb 20 '18 at 18:37

Dont forget to set pageviewcontroller's delegate.

 func createPageViewController() {
    // Create page view controller
    pageViewController = storyboard?.instantiateViewController(withIdentifier: "PageViewController") as? UIPageViewController
    pageViewController?.delegate = self
    pageViewController?.dataSource = self

    let startingViewController: ChildViewController = viewControllerAtIndex(index: 0)!
    let viewControllers: Array = [startingViewController]
    pageViewController?.setViewControllers(viewControllers, direction: .forward, animated: true, completion: nil)

    self.addChildViewController(pageViewController!)
    self.view.frame = CGRect(x: 0, y: 0, width: self.view.bounds.size.width, height: self.view.bounds.size.height)
    self.view.addSubview((pageViewController?.view)!)
    self.pageViewController?.didMove(toParentViewController: self)
}

func viewControllerAtIndex(index: Int) -> ChildViewController? {  
    // return nil here, if there won't be any page in pageviewcontroller

    // Create a new view controller and pass suitable data.
    let pageContentViewController: ChildViewController = storyboard?.instantiateViewController(withIdentifier: "ChildViewController") as! ChildViewController

    pageContentViewController.pageIndex = index
    return pageContentViewController
}

//Also add viewControllerAfter and viewControllerBefore methods

func pageViewController(_ pageViewController: UIPageViewController, willTransitionTo pendingViewControllers: [UIViewController]) {
    self.pendingIndex = (pendingViewControllers.first as! ChildViewController).pageIndex
}

func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool) {
    if completed {
        self.currentIndex = self.pendingIndex!
        //Perform your task here
    }
}

score 3 · Answer 7 · answered Mar 26 '18 at 10:29

You can use next method:

func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool) {
    guard
        completed,
        let viewControllerIndex = tutorialViews.index(of: pageViewController.viewControllers!.first!) else
            return
        }

    self.currentIndex = viewControllerIndex
}

Where tutorialViews is an array of pages (ViewControllers).
And initialize currentIndex like that:

var currentIndex = 0 {
    didSet {
        self.updateContentForPage(withIndex: currentIndex)
    }
}

score 2 · Answer 8 · answered Sep 28 '15 at 12:49

2

Try it..

func pageViewController(pageViewController: UIPageViewController,didFinishAnimating finished: Bool,previousViewControllers: [UIViewController],transitionCompleted completed: Bool){
guard completed else { return }

self.pageControl.currentPage = pageViewController.viewControllers!.first!.view.tag
    }

answered Sep 28 '15 at 12:49

Sankalap Yaduraj Singh

1,167
2
14
32

Getting error Value of type 'UIPageVieController' has no member 'currentPage' – Mahesh Narla Feb 11 '17 at 07:58

score 1 · Answer 9 · edited Feb 08 '20 at 19:35

Swift 4 version

Extending the ViewController class with these protocols (UIPageViewControllerDelegate, UIPageViewControllerDataSource) and adding the following functions helped me to make my page control work correctly.

class ViewController : UIPageViewControllerDelegate,UIPageViewControllerDataSource {

    func pageViewController(_ pageViewController: UIPageViewController, willTransitionTo pendingViewControllers: [UIViewController]) {
        if let viewController = pendingViewControllers[0] as? DataViewController {
            self.lastPendingViewControllerIndex = viewController.index!
        }
    }

    func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool) {
        if completed {
            pageControl.currentPage = self.lastPendingViewControllerIndex
            if lastPendingViewControllerIndex == 4 {
                self.getstartedButton.isHidden=false
            } else {
                self.getstartedButton.isHidden=true
            }
        }
    }
}

score 0 · Answer 10 · answered Sep 18 '18 at 21:15

Create a method within, for example, class -> WalkthroughPageViewController), such that:

 /* The method takes in a page index and creates the next content view controller. If the controller can
 be created, we call the built-in setViewControllers method and navigate to the next view controller.*/
func forward(index: Int) {
    if let nextViewController = contentViewController(at: index + 1) {
        setViewControllers([nextViewController], direction: .forward, animated: true, completion: nil)
    }
}

And in the class that controls said UIPageController, which will be a controller view (class -> WalkthroughContentViewController) and that contains a following button that passes to the next page and updates the property "pageControl.currentPage" (which is itself the UIpageControl), implements:

class WalkthroughContentViewController: UIViewController {

@IBOutlet var headingLabel: UILabel!
@IBOutlet var contentLabel: UILabel!
@IBOutlet var forwardButton: UIButton!
@IBOutlet var pageControl: UIPageControl!
@IBOutlet var contentImageView: UIImageView!

var index     = 0
var heading   = ""
var content   = ""
var imageFile = ""

override func viewDidLoad() {
    super.viewDidLoad()

    headingLabel.text = heading
    contentLabel.text = content
    contentImageView.image = UIImage(named: imageFile)

    // Update the 'currentPage' property of the page control.
    pageControl.currentPage = index

    if case 0...1 = index {
        forwardButton.setTitle("NEXT", for : .normal)
    } else if case 2 = index {
        forwardButton.setTitle("DONE", for : .normal)
    }
}

// MARK: - Actions

@IBAction func nextButtonTapped(sender: UIButton) {
    switch index {
    case 0...1: /* Get the parent controller & call to the "forward" method from the 'WalkthroughPageViewController'. */
        let pageViewController = parent as! WalkthroughPageViewController
        pageViewController.forward(index: index)
    case 2: /* Dismiss the page view controller and show the main screen of the app*/
        dismiss(animated: true, completion: nil)
    default: break
    }
}

}

score 0 · Answer 11 · answered Oct 09 '19 at 22:13

Just check apple's docs (https://developer.apple.com/tutorials/swiftui/interfacing-with-uikit) -> Section 3 -> Step 5

You can get the current index like this

func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool) {
            if completed,
                let visibleViewController = pageViewController.viewControllers?.first,
                let index = parent.controllers.firstIndex(of: visibleViewController)
            {
                parent.currentPage = index
            }
        }

or if you are keeping viewControllers in an array you can do this

func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool) {
        if completed,
            let visibleViewController = pageViewController.viewControllers?.first,
            let index = orderedViewControllers.firstIndex(of: visibleViewController)
        {
            statisticsPageDelegate?.statisticsPageViewController(statisticsPageViewController: self, didUpdatePageIndex: index)
        }
    }

This is the full code

class StatisticsPageViewController: UIPageViewController,UIPageViewControllerDataSource, UIPageViewControllerDelegate {

    var currentIndex: Int?
    var statisticsPageDelegate: StatisticsPageViewControllerDelegate?
    private var pendingIndex: Int?

    required init?(coder aDecoder: NSCoder) {
        super.init(transitionStyle: .scroll, navigationOrientation: .horizontal, options: nil)
    }
    override func viewDidLoad() {
        super.viewDidLoad()
        dataSource = self
        delegate = self

        if let firstViewController = orderedViewControllers.first {
            setViewControllers([firstViewController],
                               direction: .forward,
                               animated: true,
                               completion: nil)
        }

        statisticsPageDelegate?.statisticsPageViewController(
            statisticsPageViewController: self,
            didUpdatePageCount: orderedViewControllers.count
        )
    }

    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // Dispose of any resources that can be recreated.
    }

    func pageViewController(_ pageViewController: UIPageViewController, viewControllerBefore viewController: UIViewController) -> UIViewController? {
        guard let viewControllerIndex = orderedViewControllers.index(of:viewController) else {
            return nil
        }

        let previousIndex = viewControllerIndex - 1

        guard previousIndex >= 0 else {
            return nil
        }

        guard orderedViewControllers.count > previousIndex else {
            return nil
        }

        return orderedViewControllers[previousIndex]
    }

    func pageViewController(_ pageViewController: UIPageViewController, viewControllerAfter viewController: UIViewController) -> UIViewController? {
        guard let viewControllerIndex = orderedViewControllers.index(of:viewController) else {
            return nil
        }

        let nextIndex = viewControllerIndex + 1
        let orderedViewControllersCount = orderedViewControllers.count

        guard orderedViewControllersCount != nextIndex else {
            return nil
        }

        guard orderedViewControllersCount > nextIndex else {
            return nil
        }

        return orderedViewControllers[nextIndex]
    }

    func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool) {
        if completed,
            let visibleViewController = pageViewController.viewControllers?.first,
            let index = orderedViewControllers.firstIndex(of: visibleViewController)
        {
            statisticsPageDelegate?.statisticsPageViewController(statisticsPageViewController: self, didUpdatePageIndex: index)
        }
    }

    private(set) lazy var orderedViewControllers: [UIViewController] = {
        return [self.newStatisticsViewController(identifier: Identifiers.PROGRAM_VIEW_CONTROLLER),
        self.newStatisticsViewController(identifier: Identifiers.LOGIN_VIEW_CONTROLLER)]
    }()

    private func newStatisticsViewController(identifier: String) -> UIViewController {
        return UIStoryboard(name: "Main", bundle: nil) .
            instantiateViewController(withIdentifier: identifier)
    }
}

protocol StatisticsPageViewControllerDelegate: class {
    func statisticsPageViewController(statisticsPageViewController:
        StatisticsPageViewController, didUpdatePageCount count: Int)
    func statisticsPageViewController(statisticsPageViewController:
        StatisticsPageViewController, didUpdatePageIndex index: Int)
}

score 0 · Answer 12 · answered Jan 24 '20 at 10:41

Use viewDidAppear that mark page as visible and viewDidDisappear that mark page as invisible

Item ViewController:

class PageItemViewController: UIViewController {

    private(set) var isVisible: Bool = false

    override func viewDidAppear(_ animated: Bool) {
        super.viewDidAppear(animated)
        isVisible = true
    }

    override func viewDidDisappear(_ animated: Bool) {
        super.viewDidDisappear(animated)
        isVisible = false
    }   
}

Get index of the visible page

class PageViewController: UIPageViewController, UIPageViewControllerDelegate {

    var items: [PageItemViewController] = [] {
        didSet {
            if let last = items.last {
                setViewControllers([last], direction: .forward, animated: true, completion: nil)
            }
        }
    }

    // ...

    public func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool) {
        if finished {
            guard let currentIndex = items.firstIndex(where: { $0.isVisible }) else { return }
            print(currentIndex)
        }
    }
}

PageViewController current page index in Swift

12 Answers12

Linked