Requirements • Usage • Installation • Contribution • Contact • License
Requirements
- iOS 8.0+ / tvOS 9.0+
- Xcode 9.0+
- Swift 4.2+
Usage
Hello World
The first example is the simplest way to use the Splitflap component. Here how to display this "Hello" text:
import Splitflap
let splitflapView = Splitflap(frame: CGRect(x: 0, y: 0, width: 370, height: 53))
splitflapView.datasource = self
// Set the text to display by animating the flaps
splitflapView.setText("Hello", animated: true)
// MARK: - Splitflap DataSource Methods
// Defines the number of flaps that will be used to display the text
func numberOfFlapsInSplitflap(_ splitflap: Splitflap) -> Int {
return 5
}
Theming
Splitflap allows you to customize each flap individually by providing a splitflap:builderForFlapAtIndex: delegate method:
let splitflapView = Splitflap(frame: CGRect(x: 0, y: 0, width: 370, height: 53))
splitflapView.delegate = self
splitflapView.datasource = self
// Set the text with an emoji
splitflap.text = "Cat \u{1F63B}"
// MARK: - Splitflap Delegate Methods
// Configure the appearance for each flaps
func splitflap(_ splitflap: Splitflap, builderForFlapAtIndex index: Int) -> FlapViewBuilder {
return FlapViewBuilder { builder in
builder.backgroundColor = UIColor(red: 251/255, green: 249/255, blue: 243/255, alpha: 1)
builder.cornerRadius = 5
builder.font = UIFont(name: "Avenir-Black", size:45)
builder.textAlignment = .center
builder.textColor = UIColor(red: 0, green: 0, blue: 0, alpha: 0.5)
builder.lineColor = UIColor(red: 0, green: 0, blue: 0, alpha: 0.3)
}
}
// MARK: - Splitflap DataSource Methods
func tokensInSplitflap(_ splitflap: Splitflap) -> [String] {
return " Cat\u{1F63B}".characters.map { String($0) }
}
And many more...
To go further, take a look at the documentation and the example project.
Note: All contributions are welcome
Installation
CocoaPods
Install CocoaPods if not already available:
$ [sudo] gem install cocoapods
$ pod setup
Go to the directory of your Xcode project, and Create and Edit your Podfile and add Splitflap:
$ cd /path/to/MyProject
$ touch Podfile
$ edit Podfile
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!
pod 'Splitflap', '~> 4.1.0'
Install into your project:
$ pod install
Open your project in Xcode from the .xcworkspace file (not the usual project file):
$ open MyProject.xcworkspace
You can now import Splitflap framework into your files.
Carthage
Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
You can install Carthage with Homebrew using the following command:
$ brew update
$ brew install carthage
To integrate Splitflap into your Xcode project using Carthage, specify it in your Cartfile file:
github "yannickl/Splitflap" >= 4.1.0
Swift Package Manager
You can use The Swift Package Manager to install Splitflap by adding the proper description to your Package.swift file:
import PackageDescription
let package = Package(
name: "YOUR_PROJECT_NAME",
targets: [],
dependencies: [
.Package(url: "https://github.com/yannickl/Splitflap.git", versions: "4.1.0" ..< Version.max)
]
)
Note that the Swift Package Manager is still in early design and development, for more information checkout its GitHub Page.
Manually
Download the project and copy the Splitflap folder into your project to use it in.
Contribution
Contributions are welcomed and encouraged ♡.
Contact
Yannick Loriot
License (MIT)
Copyright (c) 2015-present - Yannick Loriot
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 May 14, 2022
867 Dec 27, 2022
26 Nov 26, 2022
567 Dec 20, 2022
89 Feb 25, 2022
12k Jan 2, 2023
34 Sep 26, 2022
117 Sep 2, 2022
5 Jul 12, 2022
16 Dec 28, 2022
851 Dec 17, 2022
600 Nov 24, 2022
60 Feb 4, 2022
2.4k Jan 6, 2023
2.5k Jan 5, 2023
1.6k Jan 3, 2023
2.2k Jan 4, 2023
3 Aug 22, 2022