https://github.com/ohkanghoon/floatingbottomsheet

An easy way to present a bottom sheet with a floating effect
https://github.com/ohkanghoon/floatingbottomsheet

bottomsheet ios swift ui

Last synced: 2 months ago
JSON representation

An easy way to present a bottom sheet with a floating effect

• Host: GitHub
• URL: https://github.com/ohkanghoon/floatingbottomsheet
• Owner: OhKanghoon
• License: mit
• Created: 2023-10-01T15:20:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-04T12:31:15.000Z (5 months ago)
• Last Synced: 2024-10-28T00:54:01.733Z (2 months ago)
• Topics: bottomsheet, ios, swift, ui
• Language: Swift
• Homepage:
• Size: 1.86 MB
• Stars: 26
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FloatingBottomSheet



[![Build Status](https://github.com/OhKanghoon/FloatingBottomSheet/workflows/CI/badge.svg?branch=main)](https://github.com/OhKanghoon/FloatingBottomSheet/actions?query=branch%3Amain+workflow%3ACI)

[![Swift Package Manager compatible](https://img.shields.io/badge/SPM-compatible-4BC51D.svg?style=flat)](https://github.com/apple/swift-package-manager)

[![Swift Versions](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FOhKanghoon%2FFloatingBottomSheet%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/OhKanghoon/FloatingBottomSheet)

[![Platform](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FOhKanghoon%2FFloatingBottomSheet%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/OhKanghoon/FloatingBottomSheet)

A library that displays floating bottom sheet.

See the [FloatingBottomSheet DocC documentation](https://swiftpackageindex.com/OhKanghoon/FloatingBottomSheet/main/documentation/floatingbottomsheet) hosted on the [Swift Package Index](https://swiftpackageindex.com/).

## Compatibility

FloatingBottomSheet requires **iOS 11+** and is compatible with **Swift 5** projects.

## Installation

### [Swift Package Manager](https://swift.org/package-manager).

The preferred way of installing FloatingBottomSheet is via the Swift Package Manager

1. In Xcode, open your project and navigate to **File** → **Add Packages**

2. Paste the repository URL (`https://github.com/OhKanghoon/FloatingBottomSheet`) and click **Next**.

3. For **Rules**, select **Up to Next Major Version**.

4. Click **Add Package**.

### [CocoaPods](https://guides.cocoapods.org/using/using-cocoapods.html)

```ruby

# Podfile

use_frameworks!

target 'YOUR_TARGET_NAME' do

  pod 'FloatingBottomSheet'

end

```

Replace `YOUR_TARGET_NAME` and then, in the `Podfile` directory, type:

```bash

$ pod install

```

## Usage



### Configuration

To use the FloatingBottomSheet, your ViewController must conform to the `FloatingBottomSheetPresentable` protocol.

Start by implementing the `bottomSheetScrollable` and `bottomSheetHeight` properties. 

```swift

final class ViewController: UIViewController, FloatingBottomSheetPresentable {

  

  var bottomSheetScrollable: UIScrollView? { 

    // Return a scrollable view

  }

    

  var bottomSheetHeight: CGFloat { 

    // Set the height of the bottom sheet

  }

}

```

### Present bottom sheet

Simply present the floating bottom sheet using the presentFloatingBottomSheet function like this:

```swift

let viewController = ViewController()

presentFloatingBottomSheet(viewController)

```

### Updates bottom sheet height at runtime

To update the bottom sheet's height dynamically during runtime, use the following code:

```swift

bottomSheetHeight = 400.0

bottomSheetPerformLayout(animated: true)

```

You can change the value of bottomSheetHeight to your desired height 

and then call `bottomSheetPerformLayout` function to update the bottom sheet's height with optional animation. 

If you don't want animation, set `animated` to false. 

## License

FloatingBottomSheet is under MIT license. See the [LICENSE](https://github.com/OhKanghoon/FloatingBottomSheet/blob/main/LICENSE) for more info.