https://github.com/3sidedcube/messagestackview
Wrapper of a UIStackView for posting and removing messages.
https://github.com/3sidedcube/messagestackview
Last synced: 4 months ago
JSON representation
Wrapper of a UIStackView for posting and removing messages.
- Host: GitHub
- URL: https://github.com/3sidedcube/messagestackview
- Owner: 3sidedcube
- License: mit
- Created: 2019-11-26T14:22:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T14:23:13.000Z (almost 2 years ago)
- Last Synced: 2024-12-02T12:29:36.265Z (over 1 year ago)
- Language: Swift
- Size: 1.53 MB
- Stars: 2
- Watchers: 8
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Example
This is an example of posting a message from the top of the window:
```swift
UIApplication.shared.postView.post(badgeMessage:
BadgeMessage(
title: "This is a window notification",
subtitle: "This notification has been posted on the key window",
image: UIImage(named: "donations"),
fillColor: .red
)
)
```
1. The `BadgeMessage` model defines what the message should look like
2. A `BadgeMessageView` is created with properties defined by the `BadgeMessage`
3. The `BadgeMessageView` is posted on a `PostView` on the `keyWindow`
This `PostView` adds and removes itself from the `keyWindow` dynamically based on what is in its queue.
See the Example project for more on what this framework can do!
## Installation
### CocoaPods
[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. To integrate MessageStackView into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
pod 'MessageStackView', :git => 'https://github.com/3sidedcube/MessageStackView.git', :tag ~> '3.0.0'
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate MessageStackView into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "3sidedcube/MessageStackView" ~> 3.0.0
```
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler. To integrate MessageStackView into your project using Swift Package Manager, specify it in the `dependencies` of your `Package.swift`:
```swift
dependencies: [
.package(url: "https://github.com/3sidedcube/MessageStackView.git", .upToNextMajor(from: "3.0.0"))
]
```
## Core Entities
### PostManager
Encaspsulates the logic of when and how `UIView`s should be posted and removed.
Internally `PostManager` handles:
1. Dismissal `Timer`s which, after a given time, request to remove a previously posted `UIView`
2. A `PostGestureManager` for gesture related dismissals, e.g. pan.
3. Serial `Queue` if required
### UIViewPoster
While `PostManager` handles the logic of when to post and remove a `UIView`, `UIViewPoster` handles the actual posting and subviews.
Specifically, adding and removing the subview to the subview hierarchy, and animating when required.
`PostManager` references a `UIViewPoster` communicating when to post and remove.
There are a few common implementations of `UIViewPoster` provided in this framwork.
### PostView
A `UIView` for posting other `UIView`s in a serial manner.
The animation of posted `UIView`s is via a `translation` from the top.
Commonly, `PostView` is constrained to the top, leading, trailing edges of a `UIView` e.g. `UIWindow`.
When a subview is posted, the `PostView` constrains its edges to the added subview.
So, in this case, a posted `UIView` would define its height either intrinsically or via explicit constraints, with its width determined by the `PostView`.
### MessageStackView
A simple wrapper of a vertical `UIStackView` for posting and removing `UIView`s.
These `UIView`s, being a `UIStackView`, are part of the `arrangedSubviews`.
The animation of posted `UIView`s is handled via the `UIStackView` by setting `isHidden`.
## Models
### Message
Properties include:
1. `title` - required
2. `subtitle` - Optional
3. `leftImage` - Optional
3. `rightImage` - Optional
A `Message` describes how a `MessageView` should look, which is the view which is posted on the `UIViewPoster`.
### BadgeMessage
`BadgeMessage` is similar to `Message` with an updated design and interface.
## Other
### MessageStackView + Custom View
The posted `UIView`s width will be determined by the `UIStackView` as the `distribution` is `fill` and the `UIStackView` axis is `.vertical`.
However the height of the `UIView` is driven by the `UIView` itself, e.g. autolayout.
If, when posting and removing this `UIView` from the `MessageStackView` you want the animation to be smooth, then consider a "breakable" constraint for the height. Since the `UIStackView` will animate the `isHidden` property on the `UIView`, which will set an explict height during animation.