Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hituziando/mkapopupkit
Simple and customizable popup view for iOS.
https://github.com/hituziando/mkapopupkit
bottom-sheet cocoapods indicator ios objective-c popup swift toast uikit view
Last synced: about 2 months ago
JSON representation
Simple and customizable popup view for iOS.
- Host: GitHub
- URL: https://github.com/hituziando/mkapopupkit
- Owner: HituziANDO
- License: mit
- Created: 2019-03-18T14:11:16.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-02T09:38:44.000Z (over 4 years ago)
- Last Synced: 2024-10-28T20:02:35.754Z (2 months ago)
- Topics: bottom-sheet, cocoapods, indicator, ios, objective-c, popup, swift, toast, uikit, view
- Language: Objective-C
- Homepage:
- Size: 4.36 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MKAPopupKit
MKAPopupKit is the framework provides simple and customizable popup view for iOS. See following samples.
## Require
- iOS 13.0+
- Xcode 11.6+
## Get Started
### Install Framework to Your iOS App
You have three ways to install this framework.
#### 1. CocoaPods
MKAPopupKit is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod "MKAPopupKit"
```
#### 2. Carthage
You can use [Carthage](https://github.com/Carthage/Carthage) to install MKAPopupKit by adding it to your Cartfile:
```
github "HituziANDO/MKAPopupKit"
```
If you use Carthage to build your dependencies, make sure you have added MKAPopupKit.framework to the "Frameworks, Libraries and Embedded Content" section of your target, and have included them in your Carthage framework copying build phase.
#### 3. Manual Installation
1. Download latest [MKAPopupKit](https://github.com/HituziANDO/MKAPopupKit/releases) framework and copy it into your Xcode project
1. Open the "General" panel
1. Click on the + button under the "Frameworks, Libraries and Embedded Content" section
1. After click "Add Other...", choose MKAPopupKit.xcframework
### Quick Usage
1. Import the framework
```swift
import MKAPopupKit
```
1. Create an instance
Let's see following code. The MKAPopup can contain a content view has the layout created by you.
```swift
// Creates your content view.
let contentView = ...YOUR CONTENT VIEW CREATION...
// Creates a popup using your content view.
let popup = MKAPopup(contentView: contentView)
// Customizes...
// Title (default is nil)
popup.popupView.titleLabel.text = "About Swift"
// Title Text Color (default is system default color)
popup.popupView.titleLabel.textColor = .white
// Title Font (default is system default font)
popup.popupView.titleLabel.font = UIFont.boldSystemFont(ofSize: 20.0)
// Title Text Padding (default is (16, 16, 16, 16))
popup.popupView.titleLabel.padding = UIEdgeInsets(top: 24.0, left: 16.0, bottom: 24.0, right: 16.0)
// Popup Background Color (default is white)
popup.popupView.backgroundColor = UIColor(red: 0, green: 0.5, blue: 1.0, alpha: 1.0)
// Popup Corner Radius (default is 5)
popup.popupView.layer.cornerRadius = 20.0
// Popup Size (default is (300, 400))
popup.popupSize = CGSize(width: 320.0, height: 480.0)
// Overlay Color (default is black with alpha=0.4)
popup.backgroundColor = UIColor.black.withAlphaComponent(0.8)
// Can hide when a user touches up outside a popup (default is true)
popup.canHideWhenTouchUpOutside = false
// Showing Animation (default is fade)
popup.showingAnimation = .fade
// Hiding Animation (default is fade)
popup.hidingAnimation = .fade
// Animation Duration (default is 0.3)
popup.duration = 0.3
// Delegate
popup.delegate = self
```
1. Show the popup
```swift
popup.show()
```
1. Hide the popup
```swift
popup.hide()
```
## Animation Types
The MKAPopup has some animations showing and hiding the popup.
### Fade
### SlideUp
### SlideDown
### SlideLeft
### SlideRight
## Toast
The toast is the view that disappears automatically after displaying a short message for a few seconds. It is inspired by Android's Toast.
### Most Simple Usage
It's very simple! See below.
```swift
MKAToast("Display short message!").show()
```
### Customize Toast
Customize the toast view and show it.
```swift
// Make the style.
let config = MKAToastStyleConfiguration()
config.width = 320.0
config.height = 56.0
config.backgroundColor = UIColor.red.withAlphaComponent(0.9)
config.textColor = .black
config.font = UIFont.systemFont(ofSize: 17.0, weight: .bold)
// Create the toast with options.
MKAToast("Something error occurred!", style: config)
.withDelegate(self)
.withTag(1)
.withTime(MKAToastTimeLong)
.withAnimationDuration(0.5)
.withDelay(0.5)
.show()
```
## Indicator
MKAIndicator makes you to create the powerful indicator view easily. See following samples.
**Basic Type Indicator**
**Custom Type Indicator**
**Sprite Animation Type Indicator**
### Most Simple Usage
1. Set the indicator as default is able to use like a singleton
```swift
// ViewController
override func viewDidLoad() {
super.viewDidLoad()
// Set new indicator as default.
MKAIndicator.setDefault(MKAIndicator(activityIndicatorViewStyle: .medium))
}
```
1. Show the indicator
```swift
MKAIndicator.default().showIgnoringUserInteraction(false)
```
1. Hide the indicator
```swift
MKAIndicator.default().hide()
```
### Style
#### Basic Type Indicator
The basic type indicator is simple using the style prepared by UIKit.
```swift
// Show the basic indicator.
let indicator = MKAIndicator(activityIndicatorViewStyle: .medium)
indicator.showIgnoringUserInteraction(false)
```
#### Custom Type Indicator
The custom type indicator uses an indicator image you created or prepared. The indicator image automatically rotates at the specified animation interval.
```swift
// Show the custom indicator with the image.
let indicator = MKAIndicator(image: UIImage(named: "spinner")!)
.withAnimationDuration(2.0)
indicator.showIgnoringUserInteraction(false)
```
#### Sprite Animation Type Indicator
The sprite animation type indicator uses indicator images you created or prepared. Images are composed of the keyframe animation at the specified animation interval.
```swift
// Show the sprite animation indicator.
let indicator = MKAIndicator(imagesFormat: "indicator%d", count: 8)
.withAnimationDuration(0.5)
indicator.showIgnoringUserInteraction(false)
```
### Disable User Intraction
When ignoring user interaction is true, the user can not operate while the indicator is displayed.
```swift
let indicator = MKAIndicator(image: UIImage(named: "spinner")!)
.withAnimationDuration(2.0)
.withOverlayColor(UIColor.white.withAlphaComponent(0.7))
// Show the indicator and disable user interaction.
indicator.showIgnoringUserInteraction(true)
```
## Bottom Sheet
### Usage
```swift
// Creates your content view.
let contentView = ...YOUR CONTENT VIEW CREATION...
// Creates the bottom sheet object.
let bottomSheet = MKABottomSheet(contentView: contentView)
// Sets the sheet height.
bottomSheet.sheetHeight = 320.0
// Sets the delegate (for MKAPopupDelegate).
bottomSheet.delegate = self
// Shows the bottom sheet.
bottomSheet.show()
// Hides the bottom sheet.
bottomSheet.hide()
```
----
More info, see my [sample code](https://github.com/HituziANDO/MKAPopupKit/tree/master/Sample).