https://github.com/y-okudera/NeumorphismKit
Neumorphism framework for UIKit.
https://github.com/y-okudera/NeumorphismKit
carthage cocoapods ios neumorphism storyboard swift uikit
Last synced: 20 days ago
JSON representation
Neumorphism framework for UIKit.
- Host: GitHub
- URL: https://github.com/y-okudera/NeumorphismKit
- Owner: y-okudera
- License: mit
- Created: 2020-08-18T14:15:16.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-23T17:09:19.000Z (over 4 years ago)
- Last Synced: 2025-03-11T08:03:08.598Z (about 1 month ago)
- Topics: carthage, cocoapods, ios, neumorphism, storyboard, swift, uikit
- Language: Swift
- Homepage:
- Size: 54.7 KB
- Stars: 45
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-swift - NeumorphismKit - Neumorphism framework for UIKit. (Libs / UI)
- awesome-swift - NeumorphismKit - Neumorphism framework for UIKit. ` 📝 8 months ago ` (UI [🔝](#readme))
- awesome-swift - NeumorphismKit - Neumorphism framework for UIKit. (Libs / UI)
README
[](http://cocoapods.org/pods/NeumorphismKit)
[](https://github.com/y-okudera/NeumorphismKit)
[](http://cocoapods.org/pods/NeumorphismKit)
[](http://cocoapods.org/pods/NeumorphismKit)
NeumorphismKit is neumorphism framework for UIKit.
 
## Requirements
- iOS 12.0+
- Swift 5.1+
### Versions
| NeumorphismKit version | Xcode version |
| :--------------------: | :-----------: |
| 1.0.0 | Xcode 11+ |
| 1.1.0 | Xcode 12+ |
## Installation
### CocoaPods
To integrate NeumorphismKit into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
platform :ios, '12.0'
use_frameworks!
target '' do
pod 'NeumorphismKit', '~> 1.0'
end
```
Then, run the following command:
```
$ pod install
```
### Carthage
To integrate NeumorphismKit into your Xcode project using Carthage, specify it in your `Cartfile`:
```
github "y-okudera/NeumorphismKit" ~> 1.0
```
Run `carthage update` to build the framework and drag the built `NeumorphismKit.framework` into your Xcode project.
## Usage
### Storyboard
You can start NeumorphismKit on the storyboard.
1. Set 'NeumorphismButton' to a custom class of UIButton.
2. Set the same color as the background color of SuperView to the base color of the button.
### Code
You can also start NeumorphismKit on code.
```
let neumorphismButton = NeumorphismButton(frame: .init(x: 0, y: 0, width: 120.0, height: 40.0))
neumorphismButton.baseColor = self.view.backgroundColor ?? .white
neumorphismButton.center = self.view.center
neumorphismButton.setTitle("BUTTON", for: .normal)
let titleColor = UIColor(red: 160 / 255, green: 70 / 255, blue: 255 / 255, alpha: 1.0)
neumorphismButton.setTitleColor(titleColor, for: .normal)
self.view.addSubview(neumorphismButton)
```
#### NeumorphismTabBarController
When using NeumorphismTabBarController, implement the inherited class.
```
import NeumorphismKit
import UIKit
class YourTabBarController: NeumorphismTabBarController {
override func viewDidLoad() {
super.viewDidLoad()
self.nskDelegate = self
}
override func viewWillAppear(_ animated: Bool) {
super.viewWillAppear(animated)
// If it is an empty string, the title will be hidden.
let btn1 = NeumorphismTabBarItem(title: "", icon: UIImage(named: "your_tab_img1")!)
let btn2 = NeumorphismTabBarItem(title: "", icon: UIImage(named: "your_tab_img2")!)
let btn3 = NeumorphismTabBarItem(title: "", icon: UIImage(named: "your_tab_img3")!)
let btn4 = NeumorphismTabBarItem(title: "Timeline", icon: UIImage(named: "your_tab_img4")!)
let btn5 = NeumorphismTabBarItem(title: "Users", icon: UIImage(named: "your_tab_img5")!)
// Set tuples for viewController and NeumorphismTabBarItem.
self.setup(viewControllers: [
(viewController: MainViewController.instantiate(), tabBarItem: btn1),
(viewController: OtherViewController.instantiate(text: "View1"), tabBarItem: btn2),
(viewController: OtherViewController.instantiate(text: "View2"), tabBarItem: btn3),
(viewController: OtherViewController.instantiate(text: "View3"), tabBarItem: btn4),
(viewController: OtherViewController.instantiate(text: "View4"), tabBarItem: btn5),
])
}
}
extension YourTabBarController: NeumorphismTabBarControllerDelegate {
// Delegate when switching tabs.
func finishedSwitchingTab(fromIndex: Int, toIndex: Int) {
print("fromIndex: \(fromIndex) toIndex: \(toIndex)")
}
}
```
Then set YourTabBarController on the storyboard.
Other components can be used as well.
See [Demo project](https://github.com/y-okudera/NeumorphismKit/blob/master/Demo).
## Author
Yuki Okudera, [email protected]
## License
NeumorphismKit is available under the MIT license. See the [LICENSE file](https://github.com/y-okudera/NeumorphismKit/blob/master/LICENSE) for more info.