49 lines
1.4 KiB
Markdown
49 lines
1.4 KiB
Markdown
# **LocalConsole**
|
|
|
|
Welcome to LocalConsole! This Swift Package makes on-device debugging easy with a convenient PiP-style console that can display items in the same way ```print()``` will in Xcode. This tool can also dynamically display view frames and restart SpringBoard right from your live app.
|
|
|
|
<div>
|
|
<img src="https://github.com/duraidabdul/Demos/blob/main/Demo_Pan.gif?raw=true" width="320">
|
|
<img src="https://github.com/duraidabdul/Demos/blob/main/Demo_Resize.gif?raw=true" width="320">
|
|
</div>
|
|
|
|
## **Setup**
|
|
|
|
1. In your Xcode project, navigate to File > Swift Packages > Add Package Dependancy...
|
|
|
|
2. Paste the following into the URL field: https://github.com/duraidabdul/LocalConsole/
|
|
|
|
3. Once the package dependancy has been added, import LocalConsole and create an easily accessible global instance of ```Console.shared```.
|
|
```swift
|
|
import LocalConsole
|
|
|
|
let consoleManager = LCManager.shared
|
|
```
|
|
|
|
## **Usage**
|
|
Once prepared, the localConsole can be used throughout your project.
|
|
```swift
|
|
|
|
// Activate the console view.
|
|
consoleManager.isVisible = true
|
|
|
|
// Deactivate the console view.
|
|
consoleManager.isVisible = false
|
|
```
|
|
|
|
```swift
|
|
// Print items to the console view.
|
|
consoleManager.print("Hello, world!")
|
|
|
|
// Clear console text.
|
|
consoleManager.clear()
|
|
|
|
// Copy console text.
|
|
consoleManager.copy()
|
|
```
|
|
|
|
```swift
|
|
// Change the console view font size.
|
|
consoleManager.fontSize = 5
|
|
```
|