https://github.com/ipedro/swiftui-property-inspector
https://github.com/ipedro/swiftui-property-inspector
introspection swiftui view-inspection
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ipedro/swiftui-property-inspector
- Owner: ipedro
- License: mit
- Created: 2024-03-19T00:01:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-08T06:48:37.000Z (7 months ago)
- Last Synced: 2026-04-08T08:44:29.934Z (about 2 months ago)
- Topics: introspection, swiftui, view-inspection
- Language: Swift
- Homepage: https://ipedro.github.io/swiftui-property-inspector/
- Size: 2.74 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftUI Property Inspector
[](https://github.com/ipedro/swiftui-property-inspector/actions/workflows/tests.yml)
[](https://github.com/ipedro/swiftui-property-inspector/actions/workflows/generate-documentation.yml)
[PropertyInspector](https://ipedro.github.io/swiftui-property-inspector/documentation/propertyinspector/propertyinspector) is a SwiftUI component that provides a powerful and flexible way to inspect and interact with properties dynamically. It's designed for developers who want to create sophisticated debugging tools, enhance the interactivity of their apps, or simply need a detailed view into their data structures. All that with minimal code and a [straightforward API](https://ipedro.github.io/swiftui-property-inspector/documentation/propertyinspector/swiftui/view).
## Features
- **Dynamic Property Inspection**: Intuitively inspect properties of any type within your SwiftUI views.
- **Customizable UI**: Easily customize icons, labels, and detail views for each property.
- **Sorting Capability**: Sort properties using custom criteria for better organization and accessibility.
- **Search Functionality**: Quickly find properties with a built-in search feature.
- **Environment Customization**: Adjust corner radius for the property highlight view using environment values.
## Requirements
- iOS 15.0+
- Swift 5.7+
- Xcode 15.0+
## Installation
### Swift Package Manager
Add `swiftui-property-inspector` to your project by including it in your `Package.swift` file:
```swift
dependencies: [
.package(url: "https://github.com/ipedro/swiftui-property-inspector", .upToNextMajor(from: "1.0.0"))
]
```
Then, import `swiftui-property-inspector` in your SwiftUI views to start using it.
## Documentation
The full documentation for `swiftui-property-inspector` can be found [here](https://ipedro.github.io/swiftui-property-inspector/documentation/propertyinspector/).
## Usage
Here's a simple example of using `PropertyInspector` in your SwiftUI views:
```swift
import PropertyInspector
import SwiftUI
var body: some View {
PropertyInspector(listStyle: .plain) {
VStack(content: {
InspectableText(content: "Placeholder Text")
InspectableButton(style: .bordered)
})
.propertyInspectorRowLabel(for: Int.self, label: { data in
Text("Tap count: \(data)")
})
.propertyInspectorRowIcon(for: Int.self, icon: { data in
Image(systemName: "\(data).circle.fill")
})
.propertyInspectorRowIcon(for: String.self, icon: { _ in
Image(systemName: "text.quote")
})
.propertyInspectorRowIcon(for: (any PrimitiveButtonStyle).self, icon: { _ in
Image(systemName: "button.vertical.right.press.fill")
})
}
}
```
```swift
struct InspectableText: View {
var content: S
var body: some View {
Text(content).inspectProperty(content)
}
}
```
```swift
struct InspectableButton: View {
var style: S
@State private var tapCount = 0
var body: some View {
Button("Tap Me") {
tapCount += 1
}
// inspecting multiple values with a single function call links their highlight behavior.
.inspectProperty(style, tapCount)
.buttonStyle(style)
}
}
```
### Disabling Inspection
To disable the property inspection:
```swift
var body: some View {
MyView().propertyInspectorHidden()
}
```
## Contributing
We welcome contributions! If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.
## License
The `swiftui-property-inspector` package is released under the MIT License. See [LICENSE](LICENSE) for details.