Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yalantis/segmentio
Animated top/bottom segmented control written in Swift.
https://github.com/yalantis/segmentio
animation carthage cocoapods ios segmentio swift yalantis
Last synced: 6 days ago
JSON representation
Animated top/bottom segmented control written in Swift.
- Host: GitHub
- URL: https://github.com/yalantis/segmentio
- Owner: Yalantis
- License: mit
- Created: 2016-07-04T08:54:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-12T05:33:14.000Z (4 months ago)
- Last Synced: 2024-10-29T15:34:15.731Z (about 2 months ago)
- Topics: animation, carthage, cocoapods, ios, segmentio, swift, yalantis
- Language: Swift
- Homepage: https://yalantis.com/
- Size: 3.99 MB
- Stars: 2,523
- Watchers: 67
- Forks: 323
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
## Segmentio
[](https://cocoapods.org/?q=segmentio) [](https://github.com/Yalantis/Segmentio/blob/master/LICENSE)  [](https://github.com/Carthage/Carthage) 
Animated top/bottom segmented control written in Swift.
Check this project on dribbble.
## Requirements
- Xcode 10
- iOS 8.x+
- Swift 5.0
## Installation
#### [CocoaPods](http://cocoapods.org)
```ruby
use_frameworks!
pod 'Segmentio'
```
*CocoaPods v1.1.0 or later required*
#### [Carthage](http://github.com/Carthage/Carthage)
```ruby
github "Yalantis/Segmentio"
```
## Usage
#### Import `Segmentio` module
```swift
import Segmentio
```
#### Init
You can initialize a `Segmentio` instance from code:
```swift
var segmentioView: Segmentio!
let segmentioViewRect = CGRect(x: 0, y: 0, width: UIScreen.main.bounds.width, height: 125)
segmentioView = Segmentio(frame: segmentioViewRect)
view.addSubview(segmentioView)
```
or
add a `UIView` instance in your .storyboard or .xib, set `Segmentio` class and connect `IBOutlet`:
```swift
@IBOutlet weak var segmentioView: Segmentio!
```
#### Setup `Segmentio`
```swift
segmentioView.setup(
content: [SegmentioItem],
style: SegmentioStyle,
options: SegmentioOptions?
)
```
To start with default options you can just pass `nil` to the `options` parameter.
```swift
segmentioView.setup(
content: [SegmentioItem],
style: SegmentioStyle,
options: nil
)
```
#### Configuring items
In order to set items you need to create an array of `SegmentioItem` instances:
```swift
var content = [SegmentioItem]()
let tornadoItem = SegmentioItem(
title: "Tornado",
image: UIImage(named: "tornado")
)
content.append(tornadoItem)
```
#### Handling selection
You can specify selected item manually:
```swift
segmentioView.selectedSegmentioIndex = 0
```
#### Handling callback
```swift
segmentioView.valueDidChange = { segmentio, segmentIndex in
print("Selected item: ", segmentIndex)
}
```
#### Customization
`Segmentio` can be customized by passing an instance of `SegmentioOptions` struct:
```swift
SegmentioOptions(
backgroundColor: .white,
segmentPosition: SegmentioPosition,
scrollEnabled: true,
indicatorOptions: SegmentioIndicatorOptions,
horizontalSeparatorOptions: SegmentioHorizontalSeparatorOptions,
verticalSeparatorOptions: SegmentioVerticalSeparatorOptions,
imageContentMode: .center,
labelTextAlignment: .center,
segmentStates: SegmentioStates
)
```
Segment width rely on `SegmentioPosition` enum. Width can be fixed according to maximum visible items or dynamic according to segment's content size:
```swift
enum SegmentioPosition {
case dynamic
case fixed(maxVisibleItems: Int)
}
```
Selection indicator can be customized by passing an instance of `SegmentioIndicatorOptions`:
```swift
SegmentioIndicatorOptions(
type: .bottom,
ratio: 1,
height: 5,
color: .orange
)
```
Horizontal borders can be customized by passing an instance of `SegmentioHorizontalSeparatorOptions`:
```swift
SegmentioHorizontalSeparatorOptions(
type: SegmentioHorizontalSeparatorType.topAndBottom, // Top, Bottom, TopAndBottom
height: 1,
color: .gray
)
```
Separators between segments can be customized by passing an instance of `SegmentioVerticalSeparatorOptions`:
```swift
SegmentioVerticalSeparatorOptions(
ratio: 0.6, // from 0.1 to 1
color: .gray
)
```
In order to set `SegmentioStates` you need to create a tuple of `SegmentioState` instances:
```swift
SegmentioStates(
defaultState: SegmentioState(
backgroundColor: .clear,
titleFont: UIFont.systemFont(ofSize: UIFont.smallSystemFontSize),
titleTextColor: .black
),
selectedState: SegmentioState(
backgroundColor: .orange,
titleFont: UIFont.systemFont(ofSize: UIFont.smallSystemFontSize),
titleTextColor: .white
),
highlightedState: SegmentioState(
backgroundColor: UIColor.lightGray.withAlphaComponent(0.6),
titleFont: UIFont.boldSystemFont(ofSize: UIFont.smallSystemFontSize),
titleTextColor: .black
)
)
```
#### Let us know!
We’d be really happy if you sent us links to your projects where you use our component. Just send an email to [email protected] And do let us know if you have any questions or suggestion regarding the animation.
P.S. We’re going to publish more awesomeness wrapped in code and a tutorial on how to make UI for iOS (Android) better than better. Stay tuned!
## License
The MIT License (MIT)
Copyright © 2019 Yalantis
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.