https://github.com/jake-prickett/plop-ios
Programmable Live Objects Panel
https://github.com/jake-prickett/plop-ios
debug ios productivity-tool prototyping swift
Last synced: 2 months ago
JSON representation
Programmable Live Objects Panel
- Host: GitHub
- URL: https://github.com/jake-prickett/plop-ios
- Owner: Jake-Prickett
- License: mit
- Created: 2019-12-27T12:58:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-28T14:49:18.000Z (almost 5 years ago)
- Last Synced: 2024-09-15T10:51:21.582Z (9 months ago)
- Topics: debug, ios, productivity-tool, prototyping, swift
- Language: Swift
- Size: 53.5 MB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Programmable Live Objects Panel 📱
Jake Prickett
)
---
## Elevator Pitch
Programmable Live Objects Panel, PLOP for short, is a hidden screen in your app that can be leveraged to make Development and Testing easier both on Xcode Simulator and iOS Devices. This is done by adding various components that interact with code that isn't quite Production ready or Development specific needs that boost productivity. The PLOP Panel is only present during `DEBUG` builds, making it the perfect Developer tool!
## Features 🎁
* Hidden Developer Screen
* Ability to add tools/features to develop faster
* Pre-Built Components to easily allow for common interactions
## Example Use Cases 📱
* Enable/Disable Feature Flags 🚩
* Shortcut to a feature or screen you are working on
* Location simulation (on device or simulator)
* Configuring Test Data
* Clearing settings/preferences
* Switching between environments (Dev, Prod, etc.)
* Debug Logging
And many more! 🤓 The possibilities are limitless.
## Basic Usage
The Debug Panel is a hidden screen in an app that can be accessed via a defined entry point (Button only visible in `DEBUG` builds) or the shake gesture (CMD+CTRL+Z on Simulator).
Within the debug panel you can add functionality and hook up code that is not ready for production.
> Note: The debug panel is only accessible when the DEBUG preprocessor flag is set to 1
---
Much of your setup can be done in your `AppDelegate.swift` you can have your setup code similar to below:
```swift
...
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
#if DEBUG
setupPLOPComponents() // Where you add sections, components, switches, etc.
PLOP.enableShakeToLaunchPanel() // Enables Shake gesture presentation
#endif
return true
}
...
```
Or, if you'd rather have the panel be presented on tap of a button:
```swift
class ViewController: UIViewController {
override func viewDidLoad() {
super.viewDidLoad()
let button = UIButton(type: .system)
button.setTitle("Show Panel", for: .normal)
button.addTarget(self, action: #selector(togglePLOP), for: .touchUpInside)
...
configurePLOP()
}
private func configurePLOP() {
/*
Where you add sections, components, switches, etc.
*/
PLOP.reloadPanel()
}
@objc func togglePLOP() {
PLOP.showPanel()
}
}
```
> Note: Ensure that the button is only visible in `DEBUG` builds, otherwise you could have some issues where this could be visible in your `RELEASE` Scheme!!
### How to add a Component to PLOP
Button Component
```swift
let component = ButtonPLOPComponent(title: "Example Component",
buttonTitle: "Go!",
action: { _ in /* Execute whatever you want here! */})
```
Switch Component
```swift
let component = SwitchPLOPComponent(title: "Switch 2",
action: { component in /* Execute whatever you want here! */ })
```
### How to add a section to PLOP
```swift
let section = SectionPLOPComponent(
title: "Feature Flags",
components: [ /* Insert Components Here */],
sectionType: .featureFlag
)
PLOP.add(section: section)
```
## Installation 📦
Please reference the below instructions for installing PLOP.
## Requirements 📝
* iOS 9.0+
* Xcode 11.1+
* Swift 5.0+
### CocoaPods
PLOP is available through [CocoaPods](). To install it, simply add the following line to your `Podfile`:
pod 'PLOP'
### Carthage
PLOP is available through [Carthage](). To install it, simply add the following line to your Cartfile:
github "Jake-Prickett/plop-ios"
### Swift Package Manager
PLOP is available through [Swift PM](). To install it, simply add the package as a dependency in `Package.swift`:
```swift
dependencies: [
.package(url: "https://github.com/Jake-Prickett/plop-ios.git", from: "1.0.0"),
]
```
### Manual
Download and drop the `PLOP` directory into your project.
---
If you notice issues or have feature requests - please feel free to open an issue leveraging the corresponding template.
**If you'd like to contribute - Please do!**