Close Menu

statekit


StateKit is a powerful framework for managing state in your iOS application. It provides a simple yet flexible architecture for handling various states in your app, such as loading, error, success, or empty states.


Key Features

  • State management: Efficiently handle loading, error, success, and empty states in your app.
  • Easy integration: Seamlessly integrate StateKit into your existing iOS projects.
  • Flexible architecture: Build upon StateKit’s flexible architecture to suit your app’s unique state requirements.
  • Simple yet powerful: Enjoy the benefits of a lightweight and intuitive framework.


Getting Started

Installation

To install StateKit, you can use CocoaPods or manually add the framework to your project.




# Use CocoaPods
target 'YourProjectName' do
pod 'StateKit'
end



# Manually Adding the Framework
1. Download the StateKit framework from the official GitHub repository.
2. Drag and drop the framework into your Xcode project.
3. Ensure it is added to your project's target.

Basic Usage

Follow these simple steps to start using StateKit in your application:

  1. Import the StateKit framework into your view controller.
  2. Create an instance of `StateKit` and set it as the delegate.
  3. Implement the required delegate methods.
  4. Update the state using the provided methods, such as `showLoadingState()`, `showErrorState()`, or `showSuccessState()`.




import StateKit



let stateKit = StateKit()
stateKit.delegate = self



extension YourViewController: StateKitDelegate {
func stateKit(_ stateKit: StateKit, didChangeStateTo state: State) {
// Handle state change here
}

func stateKit(_ stateKit: StateKit, didTapButtonWithTag tag: Int) {
// Handle button tap event here
}
}


Updating State

You can easily update the state within your view controller by calling the corresponding StateKit methods:




stateKit.showLoadingState()
stateKit.showErrorState(withMessage: "An error occurred.")
stateKit.showSuccessState()


Conclusion

StateKit provides a convenient and flexible solution for managing state in your iOS application. By integrating StateKit into your project, you can easily handle loading, error, success, and empty states with minimal effort.


Note

This documentation is for version 2.0 of StateKit. Please refer to the official StateKit GitHub repository for the latest updates and documentation.