Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/touchlane/SlideController

Swipe between pages with an interactive title navigation control. Configure horizontal or vertical chains for unlimited pages amount.
https://github.com/touchlane/SlideController

awesome cocoapods ios library swift uipageviewcontroller uiscrollview

Last synced: 3 months ago
JSON representation

Swipe between pages with an interactive title navigation control. Configure horizontal or vertical chains for unlimited pages amount.

Awesome Lists containing this project

README 

        
![LOGO](https://github.com/touchlane/SlideController/blob/master/Assets/logo.svg)



![Language](https://img.shields.io/badge/swift-5.0-orange.svg)

[![Build Status](https://travis-ci.org/touchlane/SlideController.svg?branch=master)](https://travis-ci.org/touchlane/SlideController)

[![codecov.io](https://codecov.io/gh/touchlane/SlideController/branch/master/graphs/badge.svg)](https://codecov.io/gh/codecov/SlideController/branch/master)

[![Version](https://img.shields.io/cocoapods/v/SlideController.svg?style=flat)](http://cocoapods.org/pods/SlideController)

[![License](https://img.shields.io/cocoapods/l/SlideController.svg?style=flat)](http://cocoapods.org/pods/SlideController)

[![Platform](https://img.shields.io/cocoapods/p/SlideController.svg?style=flat)](http://cocoapods.org/pods/SlideController)



SlideController is a simple and flexible UI component fully written in Swift. Built using power of generic types, it is a nice alternative to UIPageViewController.



![Horizontal](Example/Assets/horizontal.gif)

![Vertical](Example/Assets/vertical.gif)

![Carousel](Example/Assets/carousel.gif)



# Requirements



* iOS 9.0+

* Xcode 10.2+

* Swift 5.0+



# Installation



## CocoaPods



[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:



```$ gem install cocoapods```



To integrate SlideController into your Xcode project using CocoaPods, specify it in your ```Podfile```:



```ruby

source 'https://github.com/CocoaPods/Specs.git'

platform :ios, '9.0'

use_frameworks!



target '' do

    pod 'SlideController'

end

```



Then, run the following command:



```$ pod install```



# Usage



```swift

import SlideController

```



1) Create content

```swift

let content = [

            SlideLifeCycleObjectBuilder(),

            SlideLifeCycleObjectBuilder(),

            SlideLifeCycleObjectBuilder()

        ]

 ```

 

* ``PageLifeCycleObject`` is any object conforms to ``Initializable, Viewable, SlidePageLifeCycle `` protocols



2) Initialize SlideController

```swift

slideController = SlideController(

    pagesContent: content,

    startPageIndex: 0,

    slideDirection: .horizontal)

```



* ``CustomTitleView`` is subclass of ``TitleScrollView``

* ``CustomTitleItem`` is subclass of ``UIView`` and conforms to ``Initializable, ItemViewable, Selectable`` protocols



3) Add ``slideController.view`` to view hierarchy



4) Call ``slideController.viewDidAppear()`` and ``slideController.viewDidDisappear()`` in appropriate UIViewController methods:



 ```swift

 override func viewDidAppear(_ animated: Bool) {

     super.viewDidAppear(animated)

     slideController.viewDidAppear()

 }

 ```

 

 ```swift

override func viewDidDisappear(_ animated: Bool) {

    super.viewDidDisappear(animated)

    slideController.viewDidDisappear()

}

```



# Documentation



### SlideController



Default initializer of `SlideController`.  

`pagesContent` - initial content of controller, can be empty.  

`startPageIndex` - page index that should be displayed initially.  

`slideDirection` - slide direction. `.horizontal` or `.vertical`. 

```swift

public init(pagesContent: [SlideLifeCycleObjectProvidable],

            startPageIndex: Int = 0,

            slideDirection: SlideDirection)

```



Returns `titleView` instanсe of `TitleScrollView`.

```swift 

public var titleView: T { get }

```



Returns `LifeCycleObject` for currently displayed page.

```swift

public var currentModel: SlideLifeCycleObjectProvidable? { get }

```



Returns array of `LifeCycleObject` that corresponds to `SlideController`'s content.

 ```swift

public private(set) var content: [SlideLifeCycleObjectProvidable]

```

When set to `true` unloads content when it is out of screen bounds. The default value is `true`.

```swift

public var isContentUnloadingEnabled: Bool { get set }

```



When set to `true` scrolling in the direction of last item will result jumping to the first item.  Makes scrolling infinite. The default value is `false`.

```swift

public var isCarousel: Bool { get set }

```



If the value of this property is `true`, content scrolling is enabled, and if it is `false`, content scrolling is disabled. The default is `true`.

```swift

public var isScrollEnabled: Bool { get set }

```



Appends pages array of `SlideLifeCycleObjectProvidable` to the end of sliding content.

```swift

public func append(object objects: [SlideLifeCycleObjectProvidable])

```



Inserts `SlideLifeCycleObjectProvidable` page object at `index` in sliding content.

```swift

public func insert(object: SlideLifeCycleObjectProvidable, index: Int)

```

Removes a page at `index`.

```swift

public func removeAtIndex(index: Int)

```



Slides content to page at `pageIndex` with sliding animation if `animated` is set to `true`. Using `forced` is not recommended, it will perform shift even if other shift animation in progress or `pageIndex` equals current page. The default value of `animated` is `true`. The default value of `forced` is `false`.

```swift

public func shift(pageIndex: Int, animated: Bool = default, forced: Bool = default)

```



Slides content the next page with sliding animation if `animated` is set to `true`. The default value of `animated` is `true`.

```swift

public func showNext(animated: Bool = default)

```



Lets the `SlideController` know when it is displayed on the screen. Used for correctly triggering `LifeCycle` events.

```swift

public func viewDidAppear()

```



Lets the `SlideController` know when it is not displayed on the screen. Used for correctly triggering `LifeCycle` events.

```swift

public func viewDidDisappear()

```

___

### TitleScrollView



Alignment of title view. Supports `.top`, `.bottom`, `.left`, `.right`. The default value of `alignment` is `.top`.

```swift

public var alignment: SlideController.TitleViewAlignment { get set }

```



The size of `TitleScrollView`. For `.horizontal` slide direction of `SlideController` the `titleSize` corresponds to `height`. For `.vertical` slide direction of `SlideController` the `titleSize` corresponds to `width`.  The default value of `titleSize` is `84`.

```swift 

open var titleSize: CGFloat { get set }

```



Array of title items that displayed in `TitleScrollView`.

```swift

open var items: [TitleItem] { get }

```

___