Skip to content

Repository files navigation

BottomSheet

An iOS library for SwiftUI to create draggable sheet experiences similar to iOS applications like Maps and Stocks.

Feature overview

The library currently supports;

  • Unlimited snap positions
  • Realtime position callback
  • Absolute and relative positioning
  • Customizable animation parameters
  • An optional sticky header
  • Views with and without a scrollview

How to install

Currently BottomSheet is only available through the Swift Package Manager or manual install.

  1. Installation through Swift Package Manager can be done by going to File > Add Packages. Then enter the following URL in the searchbar; https://github.com/Wouter125/BottomSheet.

  2. Manual installation can be done by cloning this repository and dragging all assets into your Xcode Project.

How to use

  1. Import BottomSheet

  2. Create a state property that contains the presentation state of the bottom sheet and one for the current selection;

@Published var isPresented = false
@Published var selectedDetent: BottomSheet.PresentationDetent = .medium
  1. Add the BottomSheetView to your SwiftUI view hierachy by using a view modifier;
.sheetPlus(
isPresented: $isPresented,
header: { },
main: { EmptyView()
.presentationDetentsPlus(
[.height(244), .fraction(0.4), .medium, .large],
selection: $selectedDetent
)
}
)
  1. Optionally receive the current panel position with a callback, change the background color, show a drag indicator or limit the background interaction based on the height;
.sheetPlus(
isPresented: $isPresented,
background: (
Color(UIColor.secondarySystemBackground)
),
onDrag: { translation in
print(translation)
},
header: { EmptyView() },
main: {
EmptyView()
.presentationDetentsPlus(
[.height(244), .fraction(0.4), .medium, .large],
selection: $selectedDetent
)
.presentationDragIndicatorPlus(.visible)
.presentationBackgroundInteractionPlus(.enabled(upThrough: .height(380)))
}
)

Interface

ModifierTypeDefaultDescription
animationCurve.massDouble1.2The mass of the object attached to the spring.
animationCurve.stiffnessDouble200The stiffness of the spring.
animationCurve.dampingDouble25The spring damping value.

Example

To give you an idea of how to use this library you can use the example that is attached to this repo. Simply clone it and open the BottomSheetExample folder in Xcode.

Roadmap

  1. Add landscape support
  2. Add iPad support

About

An iOS library for SwiftUI to create draggable sheet experiences similar to iOS applications like Maps and Stocks.

Topics

Resources

Stars

226 stars

Watchers

6 watching

Forks

Releases

Used by

Contributors

Languages