XRay

KO | EN

gitlite — search

#javascript #react #ai #golang #machine-learning #deep-learning #linux #docker #macos #java #awesome #awesome-list #vue #security

(★ 10)

Visual debugging tool for Apple platforms — inspect view hierarchies at runtime with color-coded overlays

XRay Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Swift](https://img.shields.io/badge/Swift-5.6+-orange) ![Platforms](https://img.shields.io/badge/Platforms-iOS%20|%20tvOS%20|%20watchOS%20|%20macOS-blue) ![SPM](https://img.shields.io/badge/SPM-compatible-brightgreen) ![License](https://img.shields.io/badge/License-MIT-lightgrey)

# XRay

Visual debugging tool for Apple platforms — inspect view hierarchies at runtime with color-coded overlays.

XRay shows all view hierarchies in UIKit without using Xcode's Debug View Hierarchy. Take a screenshot to trigger the overlay.

> **Status**: Stable — feature complete. No active development needed.

## Demo

https://user-images.githubusercontent.com/12643700/170850041-0c024526-5d14-49c7-9ab5-7e09fe5e2397.mp4

## Features

- Recursively traverses entire view hierarchy
- Color-coded labels by view type:
  - **Red** (center): ViewController
  - **Blue** (trailing bottom): Custom View
  - **Black** (leading top): Standard View
- Complementary color borders for maximum contrast
- Two filter modes: `.all` (full hierarchy) and `.customClass` (custom views only)
- Debug-only — safely wrapped in `#if DEBUG`

## Requirements

- Swift 5.6+
- iOS 11+

## Installation

### Swift Package Manager

Add to your `Package.swift`:

```swift
dependencies: [
    .package(url: "https://github.com/ShawnBaek/XRay.git", from: "1.0.2")
]
```

Or in Xcode: **File > Add Package Dependencies** and enter:

```
https://github.com/ShawnBaek/XRay.git
```

## Usage

### 1. Add Screenshot Notification Listener

In your `AppDelegate.swift`:

```swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    #if DEBUG
    NotificationCenter.default.addObserver(
        self, selector: #selector(screenshotTaken),
        name: UIApplication.userDidTakeScreenshotNotification, object: nil
    )
    #endif
    return true
}
```

### 2. Handle the Screenshot Event

```swift
#if DEBUG
@objc func screenshotTaken() {
    guard let scene = UIApplication.shared.connectedScenes.first as? UIWindowScene,
          let keyWindow = scene.keyWindow,
          let topViewController = keyWindow.topViewController() else {
        return
    }
    let xray = XRay(rootViewController: topViewController)
    xray.captureXray(classNameOption: .all)
    DispatchQueue.main.asyncAfter(deadline: .now() + .seconds(5)) {
        xray.removeXray()
    }
}
#endif
```

### ClassNameOption

#### `.all` — Shows all view hierarchies

#### `.customClass` — Shows custom views only

## License

MIT License. See [LICENSE](LICENSE) for details.

## Author

Shawn Baek — [GitHub](https://github.com/ShawnBaek) · shawn@shawnbaek.com

XRay

XRay Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

XRay

XRay Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README