Close Menu

swift-prompts

Introduction

Welcome to the documentation for the Swift-Prompts library. This library provides a convenient way to display various types of prompts and alerts in your Swift iOS applications. Whether you need simple informational messages or complex multi-step alerts, Swift-Prompts has got you covered.

Features

Easy Integration

Integrating Swift-Prompts into your project is a breeze. Simply add the library to your project’s dependencies and you’re good to go. The Swift-Prompts library is compatible with both Swift 4 and Swift 5.

Versatile Prompt Types

With Swift-Prompts, you can choose from various prompt types to suit your needs. From simple alerts and confirmation dialogs to action sheets and interactive prompts, you can present the information and options you want to your users in a clear and intuitive manner.

Customizable Appearance

Swift-Prompts allows you to customize the appearance of your prompts to match your app’s design language. Change colors, fonts, backgrounds, and animations to create a consistent and visually appealing user experience. The library also provides a range of built-in themes to choose from.

Callbacks and Actions

Responding to user interactions is seamless with Swift-Prompts. You can easily attach callbacks and actions to buttons and inputs, allowing you to perform custom logic based on user choices or responses.

Installation

Cocoapods

To install Swift-Prompts using Cocoapods, add the following line to your Podfile:

pod 'Swift-Prompts'

Manual Installation

If you prefer manual installation, you can:

  • Download the Swift-Prompts source code

  • Add the source code to your Xcode project

  • Ensure the necessary dependencies are also included

Usage

Basic Usage

To display a basic prompt, follow these steps:

  1. Import the Swift-Prompts module into your file

  2. Create an instance of Prompt

  3. Set the appropriate properties such as title, message, and button text

  4. Call the show() method on the instance to present the prompt to the user

import SwiftPrompts

let prompt = Prompt()
prompt.title = "Hello World"
prompt.message = "This is a basic prompt"
prompt.addButton("OK")

prompt.show()

Advanced Usage

For more complex prompts and customization options, you can:

  1. Use different prompt types like ActionSheet or FormPrompt

  2. Specify configurations for animations, icons, and presentation styles

  3. Add callbacks to respond to user interactions

// Example of using ActionSheetPrompt

let actionSheet = ActionSheetPrompt()
actionSheet.title = "Options"
actionSheet.addButton("Option 1") {
    // Handle option 1 selection
}
actionSheet.addButton("Option 2") {
    // Handle option 2 selection
}
actionSheet.show()

Documentation

For detailed documentation and a complete list of available features and configuration options, please refer to the official Swift-Prompts documentation.

License

Swift-Prompts is released under the MIT License. See the official GitHub repository for more information.