Close Menu

mxpagerview

Introduction

Welcome to the documentation for MXPageView, a powerful and customizable page view library for iOS.

Features

  • Effortlessly create and manage multiple pages
  • Customize the appearance and layout of each page
  • Add interactive gestures and animations
  • Scroll to specific pages programmatically
  • Supports different page transition styles
  • Seamlessly integrates with your existing iOS project

Installation

CocoaPods

To integrate MXPageView into your Xcode project using CocoaPods, simply add the following line to your Podfile:


pod 'MXPageView'

Then, run the command pod install and you’re good to go!

Manual Installation

If you prefer manual installation, follow these steps:

  1. Download the latest version of MXPageView from the official GitHub repository.
  2. Unzip the downloaded file and locate the MXPageView folder.
  3. Drag and drop the MXPageView folder into your Xcode project.
  4. Make sure the option “Copy items if needed” is selected and click Finish.

Getting Started

Follow the steps below to get started with MXPageView:

1. Import


import MXPageView

2. Create an instance

Create an instance of MXPageView and add it to your view hierarchy.


let pageView = MXPageView(frame: yourFrame)
view.addSubview(pageView)

3. Configure appearance and layout

Customize the appearance and layout of the pages, including their background color, border, corner radius, etc.


pageView.pageBackgroundColor = .white
pageView.pageCornerRadius = 10.0

4. Add pages

Add your desired number of pages to the MXPageView instance.


pageView.addPages(yourArrayOfViews)

5. Scroll to a specific page

Scroll to a specific page programmatically using the scrollToPage(at index: Int) method.


pageView.scrollToPage(at: yourPageIndex)

Customization

MXPageView provides various customization options to tailor the appearance and behavior of your pages:

Page Appearance

You can customize the appearance of each page individually:

  • Set the background color using pageBackgroundColor
  • Define the corner radius using pageCornerRadius
  • Set a border and configure its attributes using pageBorderColor, pageBorderWidth, pageBorderDashPattern
  • Adjust the shadow properties using pageShadowColor, pageShadowOffset, pageShadowOpacity, pageShadowRadius

Gestures and Animations

MXPageView allows you to add and configure interactive gestures and animations:

  • Enable or disable swipe gestures using isSwipeEnabled
  • Choose between horizontal and vertical scrolling orientation using scrollDirection
  • Customize the animation duration and timing function using animationDuration and animationTimingFunction
  • Add your own custom animations and apply them to pages using setAnimation(_:forPageAt index: Int)

Delegate Methods

MXPageView provides delegate methods that you can implement to further customize the behavior and respond to events:

  • willScrollToPage(at index: Int) – Called just before the scrolling animation starts
  • didScrollToPage(at index: Int) – Called after the scrolling animation completes
  • didTapPage(at index: Int) – Called when a page is tapped

Additional Resources

Here are some additional resources to help you make the most of MXPageView:

Conclusion

Congratulations! You have successfully set up and customized your MXPageView. Now you can create stunning page-based interfaces with ease. Happy coding!