Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dagronf/dsfinspectorpanes
Easily customisable, scrollable, collapsible inspector panels using nested NSView(s)
https://github.com/dagronf/dsfinspectorpanes
apple-pages-inspectors inspector macos nsview objective-c pane properties swift
Last synced: 4 months ago
JSON representation
Easily customisable, scrollable, collapsible inspector panels using nested NSView(s)
- Host: GitHub
- URL: https://github.com/dagronf/dsfinspectorpanes
- Owner: dagronf
- License: mit
- Created: 2019-05-11T07:39:30.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-22T22:02:50.000Z (7 months ago)
- Last Synced: 2024-09-23T08:46:21.628Z (5 months ago)
- Topics: apple-pages-inspectors, inspector, macos, nsview, objective-c, pane, properties, swift
- Language: Swift
- Homepage:
- Size: 252 KB
- Stars: 21
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Inspector Panes for macOS
[](https://cocoapods.org)
[](https://swift.org/package-manager)
A Cocoa, auto-layout managed view to build and manage inspector panes equivalent to the inspectors in Apple's Pages and Numbers applications.
## Why?
I've implemented and fought with this on a number of different projects and decided to make a drop-in class that would do everything that I wanted. This class is fully autolayout managed.
I really like Apple 'Pages' implementation which allows having a header view which can be used to configure items even when the pane itself is hidden. A good example of this is the 'Spacing' inspector pane, where when the pane is hidden the user can still change the line spacing at a lower granularity.
| Expanded | Contracted |
|-----|-----|
|  |  |
## Features
* Show and hide panes
* Configurable from interface builder as inspectables
* Optional supply a view as a header view, and set its visibility (always show, show when collapsed)
* Optional automatic scroll view support
* Optional animation
* Optional separators or bounding boxes
* Optional drag/drop reordering of panes
* Show or hide individual panes without removing them
* Expand or contract individual panes
# Installation
## Direct
Copy the swift files from the `DSFInspectorPanes` subfolder to your project
## CocoaPods
Add the following to your `Podfiles` file
```ruby
pod 'DSFInspectorPanes', :git => 'https://github.com/dagronf/DSFInspectorPanes'
```
# API
## Create
1. Create an instance of `DSFInspectorPanesView` and add it to a view, or
2. Use Interface Builder to add a custom view, and change the class to `DSFInspectorPanesView`
## Properties
* `animated` : Animate the expanding/hiding of the panes
* `embeddedInScrollView` : Embed the panes view in a scroll view
* `showSeparators` : Insert a separator between each pane (optional)
* `showBoxes` : Show a box around each inspector pane (optional)
* `titleFont` : Specify a custom font to use for the title for the panes
* `spacing` : Set the vertical spacing between each pane
* `canDragRearrange` : Allow the user to change the ordering of the panes via drag/drop or touchbar
## Methods
### Add an inspector pane
Add a new inspector pane to the container
```swift
var propertyPanes = DSFInspectorPanesView(
frame: .zero,
animated: true,
embeddedInScrollView: false,
titleFont: NSFont.systemFont(ofSize: 13)
)
var inspectorView = NSView() // <--- your inspector pane view
var inspectorHeaderView = NSView() // <--- your inspector pane header view
propertyPanes.addPane(
title: "My inspector Pane",
view: inspectorView,
headerAccessoryView: inspectorHeaderView,
expansionType: .expanded)
}
```
## Expand an existing pane
```swift
var propertyPanes = DSFInspectorPanesView()
…
propertyPanes.panes[0].expanded = true
propertyPanes.panes[1].expanded = false
```
## Show or hide a pane
```swift
var propertyPanes = DSFInspectorPanesView()
…
propertyPanes.panes[0].isHidden = true
propertyPanes.panes[1].isHidden = false
```
## Reordering and moving
Move the property pane at index 0 to index 4
```swift
propertyPanes.move(index: 0, to: 4)
```
Swap property panes at index 0 and index 4
```swift
propertyPanes.swap(index: 0, with: 4)
```
## Removing
Remove the pane at index 1
```swift
propertyPanes.remove(at: 1)
```
Remove all panes
```swift
propertyPanes.removeAll()
```
# Thanks
### RSVerticallyCenteredTextFieldCell - Red Sweater Software
* Red Sweater Software, LLC for [RSVerticallyCenteredTextFieldCell](http://www.red-sweater.com/blog/148/what-a-difference-a-cell-makes) component — [License](http://opensource.org/licenses/mit-license.php)
### DraggableStackView - Mark Onyschuk
* Mark Onyschuk on [GitHub](https://github.com/monyschuk) -- [Draggable Stack View](https://gist.github.com/monyschuk/cbca3582b6b996ab54c32e2d7eceaf25)
# Screenshots
[(Movie) Drag Drop Reordering](https://dagronf.github.io/art/projects/DSFPropertyPanes/drag_drop_reorder.mp4)
## Interface Builder integration
## Pane modes
Showing the ability to display a secondary UI element for when the pane is contracted
# License
```
MIT License
Copyright (c) 2024 Darren Ford
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```