Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shaps80/peek
All new design. Inspect your iOS application at runtime.
https://github.com/shaps80/peek
carthage inspect inspectors ios peek slack swift vimeo
Last synced: 3 days ago
JSON representation
All new design. Inspect your iOS application at runtime.
- Host: GitHub
- URL: https://github.com/shaps80/peek
- Owner: shaps80
- License: mit
- Created: 2014-06-19T01:06:50.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-10-15T12:02:55.000Z (about 4 years ago)
- Last Synced: 2024-05-01T14:05:03.785Z (8 months ago)
- Topics: carthage, inspect, inspectors, ios, peek, slack, swift, vimeo
- Language: Swift
- Homepage: http://shaps.me/peek
- Size: 15.9 MB
- Stars: 2,606
- Watchers: 52
- Forks: 101
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![Peek Site][gif]][peek]
[![Carthage][carthage-0]][0]
[![Version][pods-1]][1]
[![License][pods-2]][2]
[![Language][pods-3]][3]
[![Platform][pods-4]][4]
# Peek: All new design
Peek 5 with an all new design and all new features. Whether you're a developer, designer or QA/tester, Peek can help you at all stages of your development process.
[Watch the Promo][vimeo] to see it in action.
## Unified Inspectors
All inspectors and attributes have now been unified into a single window, making inspection simpler and faster than ever before.
## Collapsible Groups
Feeling overwhelmed with all the information Peek has to offer? Simply tap the header to expand/collapse any section. Peek will even remember your choice across launches!
## Nested Inspectors
Peek now supports nested Inspectors. This powerful feature allows Peek to surface even more detail about your application. In fact Peek 5.0 more than doubles the number of attributes it can inspect.
## Previews
Views, images, colours and more can now provide snapshot previews to help you better identify what you’re inspecting.
## Reporting
An all new reporting system allows you to export screenshots, metadata and even suggested values using the iOS native share sheet.
## Accessibility
Peek itself is now more accessible with Dynamic Type, but Peek can also surface accessibility details from your application.
## Search
You can now search within Peek, making it easier than ever to inspect your apps.
## Less Code & Dependencies
Thanks to an all new architecture Peek is also now smaller. Providing more features with much less code, leaving a very small footprint on your application.
# Ready to get started?
## Designers & Testers
- Simply press one of your volume key(s) to show & hide Peek
- Now tap or drag your finger across the screen
- Tap the inspectors button (or double tap anywhere on the screen) to show the Inspectors for the selected view
You can't get simpler than that!
## Developers
### Device
The simplest way to integrate Peek into your project is to use `Cocoapods` or `Carthage`:
```ruby
# Cocoapods
pod 'Peek', :configurations => ['Debug']
# Carthage
github "shaps80/Peek" ~> 5.1.0
```
You only need 1 line of code to enable Peek in your application:
`window?.peek.enabled = true`
### Simulator
When running in the Simulator you'll need a couple of extra lines:
```swift
// Your AppDelegate
override func motionBegan(_ motion: UIEventSubtype, with event: UIEvent?) {
// iOS 8/9 requires device motion handlers to be on the AppDelegate
window?.peek.handleShake(motion)
}
```
or
```swift
// Your ViewController
override var canBecomeFirstResponder: Bool {
return true
}
override func motionBegan(_ motion: UIEventSubtype, with event: UIEvent?) {
// iOS 10 now requires device motion handlers to be on a UIViewController
UIApplication.shared.keyWindow?.peek.handleShake(motion)
}
```
Now you can press `CMD+CTRL+Z` (or use the Menu option) to show/hide Peek in your Simulator.
### Contributing
Contributions to Peek are welcomed and encouraged!
It is easy to get involved. Please see the [Contributing guide][contrib-guide] for more details.
[A list of contributors is available through GitHub.][contrib-list]
To give clarity of what is expected of our community, Peek has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities, and I think it articulates my values well. For more, see the [Code of Conduct][code-of-conduct].
# What is Peek?
[![Peek on Vimeo][preview]][vimeo]
Peek is an open source framework that provides runtime inspection of your application while its running on your device (or Simulator).
- Developers can use Peek to inspect their user interfaces at runtime.
- Designers can verify that the applications meets their design specifications.
- Testers and QA can check accessibility identifiers, validate behaviour and report issues.
Peek is a tool to aide you at all stages of your development process.
# How does Peek work?
Peek scans your entire user interface on the screen then provides overlays with layout information and attribute inspectors.
Peek includes an intelligent filtering system to best determine which views you care about while ignoring those you are not likely to be interested in.
For example, by default Peek will not show you many of Apple's system components unless they are subclassed.
Peek presents itself in its own window that sits directly on top of your own app's user interface to ensure that it doesn't interfere with normal functionality.
Peek also allows you to test all supported orientations on both iPhone and iPad.
Most importantly Peek doesn’t interfere with your applications logic or user interface in anyway. It provides read-only inspection to guarantee you’re seeing live-values only!
# Demo
If you're not ready to integrate Peek into your own project, You can simply download this repo and run the sample project included :)
Its a small app that perfectly demonstrates the power of Peek!
# Configuring Peek
Peek allows many options to be configured, allowing you more control over how Peek is configured as well as reporting options:
```swift
window?.peek.enableWithOptions { options in
options.theme = .black
options.activationMode = .auto
options.shouldIgnoreContainers = true
/*
Sometimes it can also be useful to include additional metadata with each report.
*/
options.metaData = [ "Environment": "UAT" ]
}
```
# Safety First
Peek is designed to be as safe as possible. Peek will never retain objects from your application. It will never use a background thread. Peek won't even run unless you explicitly enable it!
Go ahead, take a Peek at your app now :)
# Supported Platforms and Versions
Peek is officially supported (and tested) with the following configurations:
- iOS 9.0+ (Swift and Objective-C)
> Note: if you're having issues with Swift versions when using Cocoapods, try adding the following to your `Podfile`:
```ruby
post_install do |installer|
installer.pods_project.targets.each do |target|
if target.name == "Peek" then
target.build_configurations.each do |config|
config.build_settings['SWIFT_VERSION'] = '4.0'
end
end
end
end
```
# Swift Versions
**Swift 4.x**
Currently supported by version Peek v4.0 – v5.0
**Swift 3.x**
Not officially supported. Its recommended you update to Swift 4 and Peek 5.0
**Swift 2.3**
If you need Swift 2.3 support, update your Podfile as such:
`pod 'Peek', '2.3'`
**Swift 2.2**
If you need Swift 2.2 support, update your Podfile as such:
`pod 'Peek', '2.0'`
---
# Attribution
Original concept, code and app design by [@shaps][5]
Icons in the demo app found on [The Noun Project][6].
Artwork by [Vitaliy Gorbachev][7]
[0]: https://github.com/Carthage/Carthage
[1]: http://cocoapods.org/pods/Peek
[2]: http://cocoapods.org/pods/Peek
[3]: http://cocoadocs.org/docsets/Peek
[4]: http://cocoapods.org/pods/Peek
[5]: https://twitter.com/shaps "Shaps on Twitter"
[6]: https://thenounproject.com
[7]: https://thenounproject.com/vitalikexpert
[pods-1]: https://img.shields.io/cocoapods/v/Peek.svg?style=flat
[pods-2]: https://img.shields.io/cocoapods/l/Peek.svg?style=flat
[pods-3]: https://img.shields.io/badge/language-swift-ff69b4.svg
[pods-4]: https://img.shields.io/cocoapods/p/Peek.svg?style=flat
[carthage-0]: https://img.shields.io/badge/Carthage-✓-4BC51D.svg?style=flat
[peek]: https://shaps.me/peek
[preview]: https://github.com/shaps80/Peek/raw/master/preview.jpg
[vimeo]: https://player.vimeo.com/video/261323610
[gif]: https://github.com/shaps80/Peek/raw/master/preview.gif
[contrib-guide]: https://github.com/shaps80/Peek/blob/master/CONTRIBUTING.md
[contrib-list]: https://github.com/shaps80/Peek/graphs/contributors
[code-of-conduct]: https://github.com/shaps80/Peek/blob/master/CODE_OF_CONDUCT.md