search

danielsaidi / BottomSheet

BottomSheet lets you add custom bottom sheets to your SwiftUI apps.
MIT License
189 stars 12 forks source link
bottomsheet sheet swiftui ui ui-components

readme

BottomSheet Logo

Version Swift 5.6 MIT License Twitter: @danielsaidi

Deprecation notice

This library will be deprecated, due to the new SwiftUI 4 custom sheet size capabilities that makes this library no longer needed.

In SwiftUI 4, you can now use the new presentationDetents view modifier to apply custom sheet sizes. You can also make your sheets non-dismissable, hide the resize handle, etc. You can read more about these new capabilities here.

It's not yet possible to undim the sheet background with native SwiftUI, like Apple does in Apple Maps, but you can achieve the same effect using the custom undimmedPresentationDetents view modifier that I write more about here. It's basically just a replacement of the native presentationDetents.

This library will not be developed further, but will be around for a while, for those of you who use it. It will be archived before it's completely removed in a few years.

About BottomSheet

BottomSheet makes it easy to add custom bottom sheets to your SwiftUI apps. The result can look like this, or completely different:

These sheets can be resized manually and programatically and can be customized to fit your specific needs. You can change colors, fonts, corner radius, expanded height etc. and add any content to them.

Supported Platforms

BottomSheet supports iOS 13 and macOS 11.

Installation

BottomSheet can be installed with the Swift Package Manager:

https://github.com/danielsaidi/BottomSheet.git

or with CocoaPods:

pod DSBottomSheet

Getting started

To get started with BottomSheet, have a look at this getting started guide.

Documentation

The online documentation contains more information, code examples etc. and makes it easy to overview the various parts of the library.

The online documentation is currently iOS only. To generate documentation for other platforms, open the package in Xcode, select a simulator then run Product/Build Documentation.

Demo Application

This project contains a demo app that lets you explore BottomSheet on iOS. To run it, just open and run Demo/Demo.xcodeproj.

Acknowledgements

This library is based on this amazing gist by @mecid. It would not have been made without him, so big thanks for putting that gist out into the world.

Support

You can sponsor this project on GitHub Sponsors or get in touch for paid support.

Contact

Feel free to reach out if you have questions or if you want to contribute in any way:

License

BottomSheet is available under the MIT license. See the LICENSE file for more info.