Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IdeasOnCanvas/Aiolos
A floating panel for your iOS Apps
https://github.com/IdeasOnCanvas/Aiolos
ios ios-ui panel swift uikit
Last synced: 3 months ago
JSON representation
A floating panel for your iOS Apps
- Host: GitHub
- URL: https://github.com/IdeasOnCanvas/Aiolos
- Owner: IdeasOnCanvas
- License: mit
- Created: 2017-07-11T13:17:38.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-09-29T07:05:40.000Z (about 1 year ago)
- Last Synced: 2024-07-18T22:22:55.877Z (4 months ago)
- Topics: ios, ios-ui, panel, swift, uikit
- Language: Swift
- Homepage: https://mindnode.com
- Size: 934 KB
- Stars: 1,604
- Watchers: 26
- Forks: 66
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.mdown
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - Aiolos - A floating panel for your iOS Apps (uikit)
- awesome - Aiolos - A floating panel for your iOS Apps (ios-ui)
README
# Aiolos
#### Yet another iOS Floating Panel
[](https://github.com/Carthage/Carthage)
[](https://swift.org/package-manager)
[](https://twitter.com/myell0w)
Aiolos, ancient greek for *quick-moving*/*nimble*, is a Swift UI framework inspired by the floating panel, that was introduced to Maps app in iOS 11. Give it a try in [MindNode 5 for iOS](https://itunes.apple.com/app/mindnode-5/id1218718027?l=en&mt=8&pt=14265&uo=4&at=11l5H7&ct=web) (free trial available).
It is fully **gesture-driven**, takes **safe area** insets into account, has support for **right-to-left languages** baked in and automatically reacts to the on-screen **keyboard**. Compared to many other open source panel solutions, Aiolos is designed to be an always-visible child view controller, and therefore does not use the custom view controller transition API of iOS.
## Integration with Carthage
Add this line to your Cartfile.
```
github "IdeasOnCanvas/Aiolos"
```
## Integration with Swift Package Manager
Aiolos can be integrated with [Swift Package Manager](https://swift.org/package-manager) directly [within Xcode](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app).
## Usage in Code
There's a demo app, that demonstrates how the Panel can be set up with a different configuration for iPhones and iPads.
```swift
func makePanel(with contentViewController: UIViewController) -> Panel {
// create Panel with default configuration
let configuration = Panel.Configuration.default
let panelController = Panel(configuration: configuration)
// specify, which ViewController is displayed in the panel
panelController.contentViewController = contentViewController
// setup delegates that handle size configuration and animation callbacks
panelController.sizeDelegate = self
panelController.animationDelegate = self
// change the configuration to fit you needs
panelController.configuration.position = self.panelPosition(for: self.traitCollection)
panelController.configuration.margins = self.panelMargins(for: self.traitCollection)
panelController.configuration.appearance.separatorColor = .white
// we want a different look/behaviour on iPhone compared to iPad
if self.traitCollection.userInterfaceIdiom == .pad {
panelController.configuration.appearance.maskedCorners = [.layerMinXMinYCorner, .layerMaxXMinYCorner, .layerMinXMaxYCorner, .layerMaxXMaxYCorner]
} else {
panelController.configuration.supportedModes = [.minimal, .compact, .expanded, .fullHeight]
panelController.configuration.appearance.maskedCorners = [.layerMinXMinYCorner, .layerMaxXMinYCorner]
}
return panelController
}
```
### Configuring the size
```swift
extension ViewController: PanelSizeDelegate {
func panel(_ panel: Panel, sizeForMode mode: Panel.Configuration.Mode) -> CGSize {
let width = self.panelWidth(for: self.traitCollection, position: panel.configuration.position)
switch mode {
case .minimal:
return CGSize(width: width, height: 0.0)
case .compact:
return CGSize(width: width, height: 64.0)
case .expanded:
let height: CGFloat = self.traitCollection.userInterfaceIdiom == .phone ? 270.0 : 320.0
return CGSize(width: width, height: height)
case .fullHeight:
return CGSize(width: width, height: 0.0)
}
}
}
```
### Reacting to Panel animations
```swift
extension ViewController: PanelAnimationDelegate {
func panel(_ panel: Panel, willTransitionTo size: CGSize) {
print("Panel will transition to size \(size)")
}
func panel(_ panel: Panel, willTransitionFrom oldMode: Panel.Configuration.Mode?, to newMode: Panel.Configuration.Mode, with coordinator: PanelTransitionCoordinator) {
print("Panel will transition from \(oldMode) to \(newMode)")
// we can animate things along the way
coordinator.animateAlongsideTransition({
print("Animating alongside of panel transition")
}, completion: { animationPosition in
print("Completed panel transition to \(newMode)")
})
}
}
```
## Credits
Aiolos is brought to you by [IdeasOnCanvas GmbH](https://ideasoncanvas.com), the creator of [MindNode for iOS, macOS & watchOS](https://mindnode.com)