APPagedScrollViewController

public class APPagedScrollViewController: UIViewController, APPagedScrollViewDelegate, APPagedScrollViewDataSource

A utility view controller class that lets you easily setup APPagedScrollView for an entire view controller, providing automatic layout and page control support.

Public Functions and Accessors

  • Align the current page of the scroll view to the closest or most appropriate one.

    If you have a view controller that could rotate, implement this method in your UIViewController’s viewWillTransition(to:, with:) and pass along the coordinator so that we can adjust the scroll view’s page for rotations.

    Declaration

    Swift

    public func alignScrollView(with coordinator: UIViewControllerTransitionCoordinator? = nil)

    Parameters

    coordinator

    Specify a transition coordinator to animate alongside, making it look seamless for events like device rotations or animated view size changes.
    Show on GitHub

  • Reloads the pages of the scroll view.

    Declaration

    Swift

    public func reloadData()
    Show on GitHub

  • The index of the current page.

    Declaration

    Swift

    public var currentPageIndex: Int
    Show on GitHub

  • Scrolls to the page with the provided index.

    Declaration

    Swift

    public func scroll(to index: Int, animated: Bool)

    Parameters

    index

    The index of the page to scroll to.
    animated

    Whether or not to animate this change.
    Show on GitHub

  • Scroll forward one page, if possible.

    Declaration

    Swift

    public func goForward(animated: Bool = true)
    Show on GitHub

  • Scroll back one page, if possible.

    Declaration

    Swift

    public func goBack(animated: Bool = true)
    Show on GitHub

  • The number of pages within this scroll view.

    Declaration

    Swift

    public var numberOfPages: Int
    Show on GitHub

  • Register a page control with the paged scroll view controller so that it automatically changes to match the current page and number of pages correctly.

    This will also add an event listener so that taps to the page control automatically control the current page index of the scroll view.

    Declaration

    Swift

    public var pageControl: UIPageControl?
    Show on GitHub

  • Whether or not to have movedTo: events include elastic scrolling

    Declaration

    Swift

    public var elasticScrollingEvents: Bool
    Show on GitHub

Paged Scroll View Delegate

  • Called when the scroll view has moved to a new page.

    Declaration

    Swift

    public func pagedScrollView(_ pagedScrollView: APPagedScrollView, movedTo index: Int, from oldIndex: Int?)

    Parameters

    pagedScrollView

    The scroll view that has moved.
    index

    The index of the page that the scroll view has moved to.
    Show on GitHub

  • Called during the transition between two pages inside the scroll view.

    Declaration

    Swift

    public func pagedScrollView(_ pagedScrollView: APPagedScrollView, movingTo index: Int, from oldIndex: Int, progress: CGFloat)

    Parameters

    pagedScrollView

    The scroll view that has moved.
    newIndex

    The index of the page that the scroll view is moving to.
    oldIndex

    The index of the page that the scroll view is moving from.
    progress

    The progress of the transition as a value from 0.0 to 1.0.
    Show on GitHub

Paged Scroll View Data Source

  • Asks the data source to return the number of pages in the scroll view.

    Declaration

    Swift

    public func numberOfPages(in pagedScrollView: APPagedScrollView) -> Int

    Parameters

    pagedScrollView

    The scroll view to return the amount of pages for.

    Return Value

    The number of pages in the scroll view.

    Show on GitHub

  • Asks the data source to return the page view for the provided index in the scroll view.

    Declaration

    Swift

    public func view(forPageAt index: Int, in pagedScrollView: APPagedScrollView) -> UIView

    Parameters

    index

    The index of the page view to return.
    pagedScrollView

    The scroll view to return the amount of pages for.

    Return Value

    The page view for the provided index in the scroll view.

    Show on GitHub