Popups presentation made simple
Create beautiful and fully customisable popups in no time. Keep your code clean
PopupView is a free and open-source library dedicated for SwiftUI that makes the process of presenting popups easier and much cleaner. * **Improves code quality.** Show your popup using the `showAndStack()` or `showAndReplace()` method.
Hide the selected one with `dismiss()`. Simple as never. * **Create any popup.** We know how important customisation is; that's why we give you the opportunity to design your popup in any way you like. * **Designed for SwiftUI.** While developing the library, we have used the power of SwiftUI to give you powerful tool to speed up your implementation process.
# Getting Started ### ✋ Requirements | **Platforms** | **Minimum Swift Version** | |:----------|:----------| | iOS 14+ | 5.0 | | iPadOS 14+ | 5.0 | | macOS 12+ | 5.0 | | tvOS 15+ | 5.0 | | watchOS 4+ | 5.0 | | visionOS 1+ | 5.0 | ### ⏳ Installation #### [Swift Package Manager][spm] Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the Swift compiler. Once you have your Swift package set up, adding PopupView as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`. ```Swift dependencies: [ .package(url: "https://github.com/Mijick/PopupView.git", branch(“main”)) ] ``` #### [Cocoapods][cocoapods] Cocoapods is a dependency manager for Swift and Objective-C Cocoa projects that helps to scale them elegantly. Installation steps: - Install CocoaPods 1.10.0 (or later) - [Generate CocoaPods][generate_cocoapods] for your project ```Swift pod init ``` - Add CocoaPods dependency into your `Podfile` ```Swift pod 'MijickPopupView' ``` - Install dependency and generate `.xcworkspace` file ```Swift pod install ``` - Use new XCode project file `.xcworkspace`
# Usage ### 1. Setup library Inside your `@main` structure call the `implementPopupView` method. It takes the optional argument - *config*, that can be used to configure some modifiers for all popups in the application. ```Swift var body: some Scene { WindowGroup(content: ContentView().implementPopupView) } ``` ### 2. Declare a structure of your popup The library provides an ability to present your custom view in three predefinied places - **Top**, **Centre** and **Bottom**.
In order to present it, it is necessary to confirm to one of the protocols during your view declaration: - `TopPopup` - presents popup view from the top - `CentrePopup` - presents popup view from the center - `BottomPopup` - presents popup view from the bottom So that an example view you want to present will have the following declaration: ```Swift struct BottomCustomPopup: BottomPopup { ... } ``` ### 3. Implement `createContent()` method The function above is used instead of the body property, and declares the design of the popup view. ```Swift struct BottomCustomPopup: BottomPopup { func createContent() -> some View { HStack(spacing: 0) { Text("Witaj okrutny świecie") Spacer() Button(action: dismiss) { Text("Dismiss") } } .padding(.vertical, 20) .padding(.leading, 24) .padding(.trailing, 16) } ... } ``` ### 4. Implement `configurePopup(popup: Config) -> Config` method *Declaring this step is optional - if you wish, you can skip this step and leave the UI configuration to us.*
Each protocol has its own set of methods that can be used to create a unique appearance for every popup. ```Swift struct BottomCustomPopup: BottomPopup { func createContent() -> some View { HStack(spacing: 0) { Text("Witaj okrutny świecie") Spacer() Button(action: dismiss) { Text("Dismiss") } } .padding(.vertical, 20) .padding(.leading, 24) .padding(.trailing, 16) } func configurePopup(popup: BottomPopupConfig) -> BottomPopupConfig { popup .horizontalPadding(20) .bottomPadding(42) .cornerRadius(16) } ... } ``` ### 5. Present your popup from any place you want! Just call `BottomCustomPopup().showAndStack()` from the selected place. Popup can be closed automatically by adding the dismissAfter modifier. ```Swift struct SettingsViewModel { ... func saveSettings() { ... BottomCustomPopup() .showAndStack() .dismissAfter(5) ... } ... } ``` ### 6. Closing popups There are two methods to do so: - By calling one of the methods `dismiss`, `dismiss(_ popup: Popup.Type)`, `dismissAll(upTo: Popup.Type)`, `dismissAll` inside the popup you created ```Swift struct BottomCustomPopup: BottomPopup { ... func createButton() -> some View { Button(action: dismiss) { Text("Tap to close") } } ... } ``` - By calling one of three static methods of PopupManager: - `PopupManager.dismiss()` - `PopupManager.dismiss(_ popup: Popup.Type)` where popup is the popup you want to close - `PopupManager.dismissAll(upTo popup: Popup.Type)` where popup is the popup up to which you want to close the popups on the stack - `PopupManager.dismissAll()`
# Try our demo See for yourself how does it work by cloning [project][Demo] we created # License PopupView is released under the MIT license. See [LICENSE][License] for details.
# Our other open source SwiftUI libraries [NavigationView] - Easier and cleaner way of navigating through your app
[CalendarView] - Create your own calendar object in no time
[GridView] - Lay out your data with no effort
[CameraView] - The most powerful CameraController. Designed for SwiftUI
[Timer] - Modern API for Timer [MIT]: https://en.wikipedia.org/wiki/MIT_License [SPM]: https://www.swift.org/package-manager [Demo]: https://github.com/Mijick/PopupView-Demo [License]: https://github.com/Mijick/PopupView/blob/main/LICENSE [spm]: https://www.swift.org/package-manager/ [cocoapods]: https://cocoapods.org/ [generate_cocoapods]: https://github.com/square/cocoapods-generate [NavigationView]: https://github.com/Mijick/NavigationView [CalendarView]: https://github.com/Mijick/CalendarView [CameraView]: https://github.com/Mijick/CameraView [GridView]: https://github.com/Mijick/GridView [Timer]: https://github.com/Mijick/Timer