Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zhipingyang/verticaltree
🥶Provides a vertical drawing of the tree structure which can view information about the tree‘s nodes and supports console debug views & layers and so on
https://github.com/zhipingyang/verticaltree
collapse indexpath subtree tree-structure treenode treeview vertical
Last synced: about 1 month ago
JSON representation
🥶Provides a vertical drawing of the tree structure which can view information about the tree‘s nodes and supports console debug views & layers and so on
- Host: GitHub
- URL: https://github.com/zhipingyang/verticaltree
- Owner: ZhipingYang
- License: mit
- Created: 2019-01-22T02:41:59.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-08T11:09:51.000Z (over 3 years ago)
- Last Synced: 2024-10-31T15:54:02.029Z (2 months ago)
- Topics: collapse, indexpath, subtree, tree-structure, treenode, treeview, vertical
- Language: Swift
- Homepage:
- Size: 165 KB
- Stars: 66
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Provides a vertical drawing of the tree structure which can view information about the tree‘s nodes and supports console debug views & layers and so on
### Install
required `iOS >= 9.0` `Swift5.0` with [Cocoapods](https://cocoapods.org/)
```ruby
pod 'VerticalTree'
```
only install core functions
```ruby
pod 'VerticalTree/Core'
```
install prettyPrint extension for view、layer、viewController
```ruby
pod 'VerticalTree/PrettyExtension'
```
#### file structures
```
─┬─ "VerticalTree"
├─┬─ "Core": basic functions
│ ├─── VerticalTreeProtocol
│ ├─── VerticalTreeProtocolExtension
│ └─── VerticalTreeNodeWrapper
├─┬─ "UI": draw a graph of VerticalTree which is foldable
│ ├─── VerticalTreeCell
│ ├─── VerticalTreeIndexView
│ └─── VerticalTreeListController
└─┬─ "PrettyExtension": pretty print in xcode console
└─── VerticalTreePrettyPrint
```
#### core protocols
```swift
/// base node
public protocol BaseNode {
associatedtype T: BaseNode
var parent: T? { get }
var childs: [T] { get }
}
/// base treeNode structure and position
public protocol IndexPathNode: BaseNode {
var indexPath: IndexPath { get }
}
/// Node protocol
public protocol VerticalTreeNode: IndexPathNode where Self.T == Self {
/// indexViewLegnth
var length: TreeNodeLength { get }
/// info description
var info: Infomation { get }
var isFold: Bool { set get }
}
```
### Example for UIView
> `UIView` is a tree structure
>
> - VerticalTree in tableview
> - VerticalTree in console log
## Using
### 1. draw the VerticalTree in tableview
> for example a UITableViewCell structure:
```swift
// in ViewController
let treeVC = VerticalTreeListController(source: NodeWrapper(obj: view))
// then show the treeVC
```
#### Config Node's info
in NodeWrapper's method
```swift
/// config current node’s property value and recurrence apply the same rule in childNodes if you want
///
/// - Parameters:
/// - inChild: recurrence config in child or just config current
/// - config: rules
/// - Returns: self
@discardableResult
public func changeProperties(inChild: Bool = true, config: (NodeWrapper) -> Void) -> Self {}
```
follow picture: modify UIViewController's Wrapper
```swift
// default to change all subnode in the same rules unless inChild set false
let wrapper = NodeWrapper(obj: keyWindow.rootController).changeProperties {
$0.isFold = false // all node set unfold in default
$0.nodeDescription = "more infomation that you see now"
}
```
### 2. Text VerticalTree - in Console log
> UIView as the example to follow the IndexPathNode protocol
> see more others extension like CALayer，UIViewController in the demo
```swift
extension UIView: BaseNode {
public var parent: UIView? {
return superview
}
public var childs: [UIView] {
return subviews
}
}
```
get a wrapper of the view as a root node
```swift
// in ViewController
let rootNode = NodeWrapper(obj: view)
// print node structure in text
print(rootNode.subTreePrettyText())
```
Using UIView's Extension as an easier way, check here [VerticalTree/PrettyText](https://github.com/ZhipingYang/VerticalTree/blob/master/class/pretty/VerticalTreePrettyPrint.swift#L19)
```swift
extension BaseNode where Self: NSObject, Self == Self.T {
/// print
public func treePrettyPrint(inDebug: Bool = false) {...}
/// baseTree‘s structure
public func treePrettyText(inDebug: Bool = false) -> String {...}
/// get ofTop‘s structure & highlight position of self
public func treePrettyText(ofTop: Self, inDebug: Bool = false) { ... }
// get the baseTree of rootNode
public var getTreeRoot: Self { ... }
}
```
- print current view as root node
> `view.treePrettyPrint()`
- print view's Window structure
> `view.rootNode.treePrettyPrint()`
- show more infomation
> `view.treePrettyPrint(inDebug: true)`
### BTW
- LLDB debug view & layer & controller's hierarchy
- view & layer
- method-1: `po yourObj.value(forKey: "recursiveDescription")!`
- method-2: `expression -l objc -O -- [`yourObj` recursiveDescription]`
- controller
- method-1: `po yourController.value(forKey: "_printHierarchy")!`
- method-2: `expression -l objc -O -- [`yourController` _printHierarchy]`
## Author
XcodeYang, [email protected]
## License
VerticalTree is available under the MIT license. See the LICENSE file for more info.