Close Menu

hudmakerkit

Welcome to the documentation for the HUDMakerKit framework! This framework is a powerful tool for adding customizable HUDs (Heads-Up Displays) to your iOS app. With HUDMakerKit, you can easily create and display various types of HUDs, including progress indicators, activity spinners, success/failure messages, and more.

Installation

To install HUDMakerKit in your iOS project, follow these steps:

  • Open your project in Xcode.
  • Go to the “File” menu and select “Swift Packages” > “Add Package Dependency”.
  • In the “Choose Package Repository” dialog, enter the following URL:
https://github.com/your-username/hudmakerkit
  • Click “Next” and Xcode will resolve the package and prompt you to choose the branch, version, or commit you want to use.
  • After selecting the desired version, click “Finish” to complete the installation.

Usage

Once you have installed HUDMakerKit, you can start using it in your project. Refer to the code examples below to learn how to create and display different types of HUDs:

Loading HUD

To show a loading HUD with an activity spinner, you can use the following code:

// Import the HUDMakerKit module
import HUDMakerKit
// Create a new loading HUD
let loadingHUD = HUDMaker.makeLoadingHUD()
// Display the HUD on the current view controller
presentHUD(loadingHUD)

Progress HUD

If you need to display a progress HUD with a progress bar, you can use the code snippet below:

// Import the HUDMakerKit module
import HUDMakerKit
// Create a new progress HUD with a specific progress value
let progressHUD = HUDMaker.makeProgressHUD(progress: 0.5)
// Display the HUD on the current view controller
presentHUD(progressHUD)

Customization

HUDMakerKit provides various customization options to tailor the appearance and behavior of your HUDs. Here are some important customization features:

Colors

You can change the colors of different HUD components by modifying the respective properties. For example:

// Import the HUDMakerKit module
import HUDMakerKit
// Change the background color of the loading HUD
HUDMaker.Config.loadingBackgroundColor = UIColor.yellow

Duration

The duration of HUD display can be adjusted as per your requirements:

// Import the HUDMakerKit module
import HUDMakerKit
// Change the duration for progress HUD
HUDMaker.Config.progressHUDDisplayDuration = 2.5

By modifying these configuration options, you can achieve the desired look and behavior for your HUDs.

API Reference

For detailed information about the classes, structs, and methods provided by HUDMakerKit, refer to the official API documentation:

[API documentation](https://cocoadocs.org/docsets/hudmakerkit/)

Make sure to explore the documentation to make the most out of the framework’s capabilities.

Support

If you encounter any issues or have any questions, please reach out to us at support@hudmakerkit.com. We’ll be glad to assist you!