Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielsaidi/Sheeeeeeeeet
Sheeeeeeeeet is a Swift library for creating menus, custom action sheets, context menus etc.
https://github.com/danielsaidi/Sheeeeeeeeet
actionsheet carthage cocoapods context-menu ios popover spm swift uialertcontroller
Last synced: 10 days ago
JSON representation
Sheeeeeeeeet is a Swift library for creating menus, custom action sheets, context menus etc.
- Host: GitHub
- URL: https://github.com/danielsaidi/Sheeeeeeeeet
- Owner: danielsaidi
- License: mit
- Created: 2017-11-18T10:08:03.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-29T08:26:45.000Z (over 1 year ago)
- Last Synced: 2024-10-16T13:05:11.135Z (25 days ago)
- Topics: actionsheet, carthage, cocoapods, context-menu, ios, popover, spm, swift, uialertcontroller
- Language: Swift
- Homepage:
- Size: 16.2 MB
- Stars: 1,729
- Watchers: 22
- Forks: 110
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## About Sheeeeeeeeet
Sheeeeeeeeet is a UIKit library that lets you create menus that can be presented as custom action sheets, context menus, alert controllers, or in any way you like.
The result can look like this or completely different:
Sheeeeeeeeet comes with many item types (standard items, buttons, titles, toggles, etc.) and can be extended with your own custom item types.
## About this repository
Since I have personally moved over to SwiftUI, this repository is no longer under active development. I will however gladly merge any PRs that add value to it or fixes problems with new iOS versions.
## Installation
Sheeeeeeeeet can be installed with the Swift Package Manager:
```
https://github.com/danielsaidi/Sheeeeeeeeet.git
```
or with CocoaPods:
```
pod Sheeeeeeeeet
```
If you prefer to not have external dependencies, you can also just copy the source code into your app.
## Supported Platforms
Sheeeeeeeeet supports `iOS 9` and later.
## Getting Started
### Creating a menu
With Sheeeeeeeeet, you start with creating a menu, like this:
```swift
let item1 = MenuItem(title: "Int", value: 1)
let item2 = MenuItem(title: "Car", value: Car())
let button = OkButton(title: "OK")
let items = [item1, item2, button]
let menu = Menu(title: "Select a type", items: items)
```
The library has many built-in item types, e.g. buttons, select items, links, etc. A complete list can be found [here][MenuItems].
You can also [create your own custom item types][CustomItems] by inheriting any of the existing ones. For instance, if you build a car rental app, you can create a car-specific item that takes a `Car` model.
You can even create your own menu types by subclassing `Menu`. This makes it possible to create app-specific menus that provide specific functionality, handle specific tasks, etc.
### Presenting a menu as an action sheet
You can present menus as custom action sheets:
```swift
let sheet = menu.toActionSheet(...) { sheet, item in ... }
sheet.present(in: vc, from: view) { sheet, item in ...
print("You selected \(item.title)")
}
```
You can find more information in [this action sheet guide][ActionSheet].
### Adding a menu as a context menu
You can add menus as iOS 13 context menus to any view you like:
```swift
menu.addAsContextMenu(to: view) { sheet, item in ...
print("You selected \(item.title)")
}
```
You can find more information in [this context menu guide][ContextMenu].
### Presenting a menu as an alert controller
You can present menus as `UIAlertController`s:
```swift
let delegate = menu.presentAsAlertController(in: self, from: view) { sheet, item in ...
print("You selected \(item.title)")
}
```
You can find more information in [this alert controller guide][AlertController].
## Demo Application
The demo demonstrates different menus and menu items, including subclassing and appearance adjustments. To try it out, just open and run the `Sheeeeeeeeet` project.
## Support
You can sponsor this project on [GitHub Sponsors][Sponsors] or get in touch for paid support.
## Contact me
Feel free to reach out if you have questions or if you want to contribute in any way:
* Website: [danielsaidi.com][Website]
* Mastodon: [@[email protected]][Mastodon]
* Twitter: [@danielsaidi][Twitter]
* E-mail: [[email protected]][Email]
## License
Sheeeeeeeeet is available under the MIT license. See the [LICENSE][License] file for more info.
[Email]: mailto:[email protected]
[Website]: https://www.danielsaidi.com
[Twitter]: https://www.twitter.com/danielsaidi
[Mastodon]: https://mastodon.social/@danielsaidi
[Sponsors]: https://github.com/sponsors/danielsaidi
[License]: https://github.com/danielsaidi/Sheeeeeeeeet/blob/master/LICENSE
[ActionSheet]: https://github.com/danielsaidi/Sheeeeeeeeet/blob/master/Readmes/ActionSheet.md
[AlertController]: https://github.com/danielsaidi/Sheeeeeeeeet/blob/master/Readmes/AlertController.md
[ContextMenu]: https://github.com/danielsaidi/Sheeeeeeeeet/blob/master/Readmes/ContextMenu.md
[CustomItems]: https://github.com/danielsaidi/Sheeeeeeeeet/blob/master/Readmes/CustomItems.md
[MenuItems]: https://github.com/danielsaidi/Sheeeeeeeeet/blob/master/Readmes/MenuItems.md