Ecosyste.ms: Awesome

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

https://github.com/Ramotion/paper-onboarding

:octocat: PaperOnboarding is a material design UI slider. Swift UI library by @Ramotion
https://github.com/Ramotion/paper-onboarding

component ios library swift

Last synced: about 2 months ago
JSON representation

:octocat: PaperOnboarding is a material design UI slider. Swift UI library by @Ramotion

Lists

README 

        








PAPER ONBOARDING



iOS library Paper Onboarding is a material design UI slider written on Swift.



___



We specialize in the designing and coding of custom UI for Mobile Apps and Websites.







Stay tuned for the latest updates:






Get Free Mockup For your project →



[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](http://twitter.com/Ramotion)

[![CocoaPods](https://img.shields.io/cocoapods/p/paper-onboarding.svg)](https://cocoapods.org/pods/paper-onboarding)

[![CocoaPods](https://img.shields.io/cocoapods/v/paper-onboarding.svg)](http://cocoapods.org/pods/paper-onboarding)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Ramotion/paper-onboarding)

[![Travis](https://img.shields.io/travis/Ramotion/paper-onboarding.svg)](https://travis-ci.org/Ramotion/paper-onboarding)

[![codebeat badge](https://codebeat.co/badges/d06237c6-6ff7-4560-9602-b6cc65063383)](https://codebeat.co/projects/github-com-ramotion-paper-onboarding)

[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://paypal.me/Ramotion)



## Requirements



- iOS 10.0+

- Xcode 10.2



## Installation



Just add the Source folder to your project.



or use [CocoaPods](https://cocoapods.org) with Podfile:



``` ruby

pod 'paper-onboarding'

```



or [Carthage](https://github.com/Carthage/Carthage) users can simply add to their `Cartfile`:

```

github "Ramotion/paper-onboarding"

```



or [Swift Package Manager](https://swift.org/package-manager/) by adding:

```

dependencies: [

.package(url: "https://github.com/Ramotion/paper-onboarding.git", from: "6.1.4")

]

```

to `Package.swift`



## Usage



#### Storyboard



1) Create a new UIView inheriting from ```PaperOnboarding```



2) Set dataSource in attribute inspector



#### or Code



``` swift

override func viewDidLoad() {

  super.viewDidLoad()



  let onboarding = PaperOnboarding()

  onboarding.dataSource = self

  onboarding.translatesAutoresizingMaskIntoConstraints = false

  view.addSubview(onboarding)



  // add constraints

  for attribute: NSLayoutAttribute in [.Left, .Right, .Top, .Bottom] {

    let constraint = NSLayoutConstraint(item: onboarding,

                                        attribute: attribute,

                                        relatedBy: .Equal,

                                        toItem: view,

                                        attribute: attribute,

                                        multiplier: 1,

                                        constant: 0)

    view.addConstraint(constraint)

  }

}

```



#### For adding content use dataSource methods:



``` swift

  func onboardingItem(at index: Int) -> OnboardingItemInfo {



   return [

     OnboardingItemInfo(informationImage: IMAGE,

                                   title: "title",

                             description: "description",

                                pageIcon: IMAGE,

                                   color: UIColor.RANDOM,

                              titleColor: UIColor.RANDOM,

                        descriptionColor: UIColor.RANDOM,

                               titleFont: UIFont.FONT,

                         descriptionFont: UIFont.FONT),



     OnboardingItemInfo(informationImage: IMAGE,

                                    title: "title",

                              description: "description",

                                 pageIcon: IMAGE,

                                    color: UIColor.RANDOM,

                               titleColor: UIColor.RANDOM,

                         descriptionColor: UIColor.RANDOM,

                                titleFont: UIFont.FONT,

                          descriptionFont: UIFont.FONT),



    OnboardingItemInfo(informationImage: IMAGE,

                                 title: "title",

                           description: "description",

                              pageIcon: IMAGE,

                                 color: UIColor.RANDOM,

                            titleColor: UIColor.RANDOM,

                      descriptionColor: UIColor.RANDOM,

                             titleFont: UIFont.FONT,

                       descriptionFont: UIFont.FONT)

     ][index]

 }



 func onboardingItemsCount() -> Int {

    return 3

  }



```



#### configuring content item:



``` swift

func onboardingConfigurationItem(item: OnboardingContentViewItem, index: Int) {



//    item.titleLabel?.backgroundColor = .redColor()

//    item.descriptionLabel?.backgroundColor = .redColor()

//    item.imageView = ...

  }

```



## 🗂 Check this library on other language:






## 📄 License



Paper Onboarding is released under the MIT license.

See [LICENSE](./LICENSE) for details.



This library is a part of a selection of our best UI open-source projects.



If you use the open-source library in your project, please make sure to credit and backlink to www.ramotion.com



## 📱 Get the Showroom App for iOS to give it a try

Try this UI component and more like this in our iOS app. Contact us if interested.