Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shoheiyokoyama/SYBlinkAnimationKit
SYBlinkAnimationKit is a blink effect animation framework for iOS, written in Swift.
https://github.com/shoheiyokoyama/SYBlinkAnimationKit
animation animation-framework carthage swift swift3 ui ux
Last synced: about 1 month ago
JSON representation
SYBlinkAnimationKit is a blink effect animation framework for iOS, written in Swift.
- Host: GitHub
- URL: https://github.com/shoheiyokoyama/SYBlinkAnimationKit
- Owner: shoheiyokoyama
- License: mit
- Archived: true
- Created: 2015-12-13T08:24:08.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-21T01:30:10.000Z (about 7 years ago)
- Last Synced: 2024-10-15T20:05:41.722Z (about 2 months ago)
- Topics: animation, animation-framework, carthage, swift, swift3, ui, ux
- Language: Swift
- Homepage:
- Size: 4.33 MB
- Stars: 125
- Watchers: 9
- Forks: 15
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-swift-cn - SYBlinkAnimationKit - A blink effect animation framework. (Libs / UI)
README
[](https://developer.apple.com/iphone/index.action)
[](https://github.com/Carthage/Carthage)
[](https://swift.org)
[](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/LICENSE)
**SYBlinkAnimationKit** is a blink effect animation framework for iOS, written in **Swift** :bowtie:
## :eyes: Demo
There are 5 types of animation for component.
**border**
**borderWithShadow**
**background**
**ripple**
**text**
## :octocat: Features
- Animation like blink effect for `UIKit`
- The 5 types of animation : `border`, `borderWithShadow`, `background`, `ripple`, `text`
- Easily usable :stuck_out_tongue_closed_eyes:
- Customizable in any properties for animation
- [x] Support Swift 3.0 :tada:
- [x] Support `@IBDesignable` and `@IBInspectable`.
you can change properties in Interface Builder(IB) inspector. then IB update your custom objects automatically.
- [x] Compatible with ***Carthage***
- [x] [SYButton](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYButton.swift)
- [x] [SYLabel](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYLabel.swift)
- [x] [SYTextField](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYTextField.swift)
- [x] [SYView](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYView.swift)
- [x] [SYTableViewCell](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYTableViewCell.swift)
- [x] [SYCollectionViewCell](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYCollectionViewCell.swift)
***Coming Soon***
- [ ] SYTextView
- [ ] SYImageView
## Demo App
Open `Example/SYBlinkAnimationKit.xcworkspace` and run `SYBlinkAnimationKit-Example` to see a simple demonstration.
To run the example project, run `pod install` from the Example directory first.
## :large_orange_diamond: Usage
First, Import **SYBlinkAnimationKit** in class.
```swift
import SYBlinkAnimationKit
```
**SYBlinkAnimationKit** is designed to be easy to use.
1. Call the SYClass. for example,` SYButton`, `SYLabel`, `SYTextField`, etc.
2. If you use custom animation, call animation method ` startAnimating()`, ` stopAnimating()`
### [SYButton](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYButton.swift)
```swift
let button = SYButton(frame: CGRect(x: 40, y: 50, width: 300, height: 50 ))
button.setTitle("Border Animation", forState: .normal)
button.animationType = .border
view.addSubview(button)
//Run Animation
syButton.startAnimating()
//End Animation
syButton.stopAnimating()
```
#### Text Animation
Available ***Text Animation*** because of handleable text.
If you change text font size, name, you are supposed to call the `setFont()
```swift
button
.setFont(name: "ArialHebew", ofSize: 21)
.startAnimating()
```
### [SYLabel](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYLabel.swift)
```swift
let label = SYLabel(frame: CGRect(x: 40, y: 50, width: 300, height: 50 ))
label.text = "Text Animation"
label.labelTextColor = .darkGray
label.animationType = .text
view.addSubview(label)
```
#### Text Animation
`SYLabel` Available ***Text Animation*** because of handleable text.
If you set text color, you are supposed to set the ` labelTextColor` property.
To change text font, use font method as with `SYButton`.
```swift
label
.setFont(name: "ArialHebew", ofSize: 21)
.startAnimating()
```
### [SYTableViewCell](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYTableViewCell.swift)
Inherit `SYTableViewCell`. customize your `TableViewCell` in `UITableViewDataSource`.
```swift
class YourCell: SYTableViewCell {
...
```
```swift
func tableView(tableView: UITableView, cellForRowAtIndexPath indexPath: NSIndexPath) -> UITableViewCell {
let cell = tableView.dequeueReusableCellWithIdentifier("YourCell", forIndexPath: indexPath) as! YourCell
cell.animationType = .background
cell.startAnimating()
return cell
}
```
### [SYCollectionViewCell](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYCollectionViewCell.swift)
Inherit `SYCollectionViewCell`. customize your `CollectionViewCell` in `UICollectionViewDataSource`.
```swift
class YourCell: SYCollectionViewCell {
...
```
```swift
func collectionView(collectionView: UICollectionView, cellForItemAtIndexPath indexPath: NSIndexPath) -> UICollectionViewCell {
let cell = collectionView.dequeueReusableCellWithReuseIdentifier("YourCell", forIndexPath: indexPath) as! YourCell
cell.animationType = .background
cell.startAnimating()
return cell
}
```
### [SYTextField](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/Source/SYTextField.swift)
SYTextField stop animation. when a touch.
but you can control this behavior.
```swift
//The animation stop. when a touch. default is true
syTextField.stopAnimationWithTouch = true
```
## :wrench: Customize animation properties
### Animation Type
If you just want to change the types of animation, you can customize `animationType`.
```swift
// default is border
var animationType: AnimationType
// Support 5 types of animation
enum AnimationType: Int {
case border
case borderWithShadow
case background
case ripple
case text
}
```
#### *inspectable*
Set `animationAdapter` (with Integer) in place of `animationType` in `IB`.
- `border`: 0
- `borderWithShadow`: 1
- `background`: 2
- `ripple`: 3
- `text`: 4
### Animation Color
You can customize the properties of the color.
These properties are *inspectable*.
```swift
var animationBorderColor: UIColor
```
```swift
var animationBackgroundColor: UIColor
```
```swift
var animationTextColor: UIColor
```
```swift
var animationRippleColor: UIColor
```
### Animation Duration, Timing
You can customize `animationTimingFunction`, `animationDuration`.
```swift
//default is linear
var animationTimingFunction: SYMediaTimingFunction
enum SYMediaTimingFunction: Int {
case linear
case easeIn
case easeOut
case easeInEaseOut
}
```
```swift
//default is 1.5
public var animationDuration: CGFloat
```
#### *inspectable*
Set `animationTimingAdapter` (with Integer) in place of `animationTimingFunction` in `IB`.
- `linear`: 0
- `easeIn`: 1
- `easeOut`: 2
- `easeInEaseOut`: 3
### Customize Animatable Text
You can customize Animatable Text alignment.
Support 9 types of alignment.
Available `SYButton`, `SYLabel` now.
````swift
var textAlignmentMode: TextAlignmentMode
enum TextAlignmentMode {
case topLeft, topCenter, topRight
case left, center, right
case bottomLeft, bottomCenter, bottomRight
}
````
### Whether animating or not
If SYClass is in middle of animation, this property is `true`
```swift
public var isAnimating: Bool
```
## :computer: Installation
### CocoaPods
***SYBlinkAnimationKit*** is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod "SYBlinkAnimationKit"
```
### Carthage
Add the following line to your `Cartfile`:
```ruby
github "shoheiyokoyama/SYBlinkAnimationKit"
```
## :pencil: Requirements
- iOS 8.3+
- Xcode 9.0+
- Swift 3.2+
## :coffee: Author
Shohei Yokoyama, [email protected]
## :unlock: License
***SYBlinkAnimationKit*** is available under the MIT license. See the [LICENSE file](https://github.com/shoheiyokoyama/SYBlinkAnimationKit/blob/master/LICENSE) for more info.