🚥 PageControl in SwiftUI

This is a custom SwiftUI View called PageControl. It is used to represent a series of pages or a carousel of views, where each page is represented by a dot. The active page's dot is highlighted.

Features

• Customizable: You can customize the color of the dots, the color of the active dot, and whether the control hides itself when there is only one page.
• Interactive: Tapping on a dot will animate to that page.
• SwiftUI: Built entirely with SwiftUI, it can be used across all Apple platforms.

Installation

To install this package, add the following line to the dependencies array in your Package.swift file:

.package(url: "https://github.com/sentryco/PageControl", .branch("main"))

How to Use

To use this PageControl, initialize it with the following parameters:

• currentPage: The initial page that the control should display. Default is 0.
• numberOfPages: The total number of pages that the control should display. Default is 0.
• hidesForSinglePage: A boolean value that determines whether the control hides itself when there is only one page. Default is true.
• pageIndicatorTintColor: The color of the dots in the control. Default is gray.
• currentPageIndicatorTintColor: The color of the active dot in the control. Default is white.

Here is an example of how to use it:

PageControl(currentPage: 1, numberOfPages: 5)
   .padding()
   .frame(width: 300, height: 300)

This will create a PageControl with 5 pages, with the second page as the current page. The control will be 300x300 points, with padding around it.

Preview

You can preview this control in Xcode by using the #Preview directive. Here is an example:

#Preview(traits: .fixedLayout(width: 300, height: 300)) {
   PageControl(currentPage: 1, numberOfPages: 5)
      .padding()
      .frame(width: 300, height: 300)
}

This will display a preview of the PageControl in the Xcode canvas.

Constants

The PageControl view uses some constants for its design:

• dotDiameter: The diameter of each dot in the control. Default is 8.0.
• dotSpacing: The space between each dot in the control. Default is 0.0.
• animationDuration: The duration of the animation used to update the control. Default is 0.08.

These constants can be adjusted to fit the design of your app.

Links:

• DSFPagerControl - complex, feature rich
• NSPageControl - improved? clone of DTPageControl
• BFPageControl - objc, complex code
• DTPageControl - simple, minimal code, example code
• NSPageController tutorial
• NSPageController documentation
• NSPageController tutorial

License

This project is licensed under the terms of the MIT license. For more details, see the LICENSE file.