https://github.com/codeandtheory/ybottomsheet-ios
An easy-to-use bottom sheet controller for iOS.
https://github.com/codeandtheory/ybottomsheet-ios
Last synced: 3 months ago
JSON representation
An easy-to-use bottom sheet controller for iOS.
- Host: GitHub
- URL: https://github.com/codeandtheory/ybottomsheet-ios
- Owner: codeandtheory
- License: apache-2.0
- Created: 2023-02-21T18:39:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-26T15:41:37.000Z (over 2 years ago)
- Last Synced: 2025-11-17T11:23:16.627Z (3 months ago)
- Language: Swift
- Homepage:
- Size: 263 KB
- Stars: 5
- Watchers: 6
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://swiftpackageindex.com/yml-org/ybottomsheet-ios) [](https://swiftpackageindex.com/yml-org/ybottomsheet-ios)
_An easy-to-use bottom sheet controller for iOS._
This framework offers a bottom sheet view controller that can be initialized to host any view or view controller.
Licensing
----------
Y—BottomSheet is licensed under the [Apache 2.0 license](LICENSE).
Documentation
----------
Documentation is automatically generated from source code comments and rendered as a static website hosted via GitHub Pages at: https://yml-org.github.io/ybottomsheet-ios/
Usage
----------
### Initializers
The Bottom sheet controller can be initialized with either a title and a view or else with a view controller.
When initializing with a view controller, the title is drawn from `UIViewController.title`. When the view controller is a `UINavigationController`, the header appearance options are ignored and the navigation controller's navigation bar is displayed as the sheet's header. In this situation, if you wish to have a close button, then that should be set using the view controller's `navigationItem.rightBarButtonItem` or `.leftBarButtonItem`.
Both initializers include an appearance parameter that allows you to fully customize the sheet's appearance. You can also update the sheet's appearance at any time.
#### Simple use case 1: Passing a title and a view
```swift
import YBottomSheet
final class ViewController: UIViewController {
override func viewDidLoad() {
super.viewDidLoad()
showBottomSheet()
}
func showBottomSheet() {
let yourView = UIView()
let sheet = BottomSheetController(
title: "Title",
childView: yourView
)
present(sheet, animated: true)
}
}
```
#### Simple use case 2: Passing a view controller.
```swift
import YBottomSheet
final class ViewController: UIViewController {
override func viewDidLoad() {
super.viewDidLoad()
showBottomSheet()
}
func showBottomSheet() {
let yourViewController = UIViewController()
let sheet = BottomSheetController(
childController: yourViewController
)
present(sheet, animated: true)
}
}
```
### Customization
`BottomSheetController` has an `appearance` property of type `Appearance`.
`Appearance` lets you customize how the bottom sheet both appears and behaves. You can customize:
* drag indicator (whether you have one at all or what its size and color are)
* header (whether you have one at all or what its text color, typography, and optional close button image are)
* layout (corner radius and minimum, maximum, and ideal sizes for the sheet's contents)
* drop shadow (if any)
* dimmer color
* present animation
* dismiss animation
**Update or customize appearance**
```swift
// Declare a resizable sheet.
let sheet = BottomSheetController(
childController: yourViewController,
appearance: .defaultResizable
)
// Change corner radius, remove dimmer,
// and use a shadow instead.
sheet.appearance.layout.cornerRadius = 24
sheet.appearance.dimmerColor = nil
sheet.appearance.elevation = Elevation(
xOffset: 0,
yOffset: 4,
blur: 16,
spread: 0,
color: .black,
opacity: 0.4
)
sheet.appearance.presentAnimation = Animation(
duration: 0.4,
curve: .spring(damping: 0.6, velocity: 0.4)
)
// Present the sheet with a spring animation.
present(sheet, animated: true)
```
Dependencies
----------
Y—BottomSheet depends upon our [Y—CoreUI](https://github.com/yml-org/ycoreui) and [Y—MatterType](https://github.com/yml-org/ymattertype) frameworks (both also open source and Apache 2.0 licensed).
Installation
----------
You can add Y—BottomSheet to an Xcode project by adding it as a package dependency.
1. From the **File** menu, select **Add Packages...**
2. Enter "[https://github.com/yml-org/ybottomsheet-ios](https://github.com/yml-org/ybottomsheet-ios)" into the package repository URL text field
3. Click **Add Package**
Contributing to Y—BottomSheet
----------
### Requirements
#### SwiftLint (linter)
```
brew install swiftlint
```
#### Jazzy (documentation)
```
sudo gem install jazzy
```
### Setup
Clone the repo and open `Package.swift` in Xcode.
### Versioning strategy
We utilize [semantic versioning](https://semver.org).
```
{major}.{minor}.{patch}
```
e.g.
```
1.0.5
```
### Branching strategy
We utilize a simplified branching strategy for our frameworks.
* main (and development) branch is `main`
* both feature (and bugfix) branches branch off of `main`
* feature (and bugfix) branches are merged back into `main` as they are completed and approved.
* `main` gets tagged with an updated version # for each release
### Branch naming conventions:
```
feature/{ticket-number}-{short-description}
bugfix/{ticket-number}-{short-description}
```
e.g.
```
feature/CM-44-button
bugfix/CM-236-textview-color
```
### Pull Requests
Prior to submitting a pull request you should:
1. Compile and ensure there are no warnings and no errors.
2. Run all unit tests and confirm that everything passes.
3. Check unit test coverage and confirm that all new / modified code is fully covered.
4. Run `swiftlint` from the command line and confirm that there are no violations.
5. Run `jazzy` from the command line and confirm that you have 100% documentation coverage.
6. Consider using `git rebase -i HEAD~{commit-count}` to squash your last {commit-count} commits together into functional chunks.
7. If HEAD of the parent branch (typically `main`) has been updated since you created your branch, use `git rebase main` to rebase your branch.
* _Never_ merge the parent branch into your branch.
* _Always_ rebase your branch off of the parent branch.
When submitting a pull request:
* Use the [provided pull request template](.github/pull_request_template.md) and populate the Introduction, Purpose, and Scope fields at a minimum.
* If you're submitting before and after screenshots, movies, or GIF's, enter them in a two-column table so that they can be viewed side-by-side.
When merging a pull request:
* Make sure the branch is rebased (not merged) off of the latest HEAD from the parent branch. This keeps our git history easy to read and understand.
* Make sure the branch is deleted upon merge (should be automatic).
### Releasing new versions
* Tag the corresponding commit with the new version (e.g. `1.0.5`)
* Push the local tag to remote
Generating Documentation (via Jazzy)
----------
You can generate your own local set of documentation directly from the source code using the following command from Terminal:
```
jazzy
```
This generates a set of documentation under `/docs`. The default configuration is set in the default config file `.jazzy.yaml` file.
To view additional documentation options type:
```
jazzy --help
```
A GitHub Action automatically runs each time a commit is pushed to `main` that runs Jazzy to generate the documentation for our GitHub page at: https://yml-org.github.io/ybottomsheet-ios/