Skip to content
This repository was archived by the owner on Feb 13, 2019. It is now read-only.

Commit a74c68e

Browse files
committed
Added PanelManager documentation
1 parent 67a8c9d commit a74c68e

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

PanelKit/PanelManager/PanelManager.swift

+16-2
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,35 @@ import UIKit
1111

1212
public protocol PanelManager: PanelViewControllerDelegate, PanelsFullscreenTransitionDelegate, PanelContentViewControllerDelegate {
1313

14+
/// The panels to be managed.
1415
var panels: [PanelViewController] { get }
1516

17+
/// Allow floating panels
1618
var allowFloatingPanels: Bool { get }
1719

20+
/// Allow panels to pin to either the left or right side,
21+
/// resizing ```panelContentView``` when a panel is pinned.
1822
var allowPanelPinning: Bool { get }
19-
23+
24+
/// The view in which the panels may be dragged around.
2025
var panelContentWrapperView: UIView { get }
2126

27+
/// The content view, which will be moved/resized when panels pin.
2228
var panelContentView: UIView { get }
2329

24-
/// Default implementation is ```LogLevel.none```
30+
/// Default implementation is ```LogLevel.none```.
2531
var panelManagerLogLevel: LogLevel { get }
2632

33+
/// This will be called when a panel is pinned or unpinned.
2734
func didUpdatePinnedPanels()
2835

36+
/// Drag insets for panel.
37+
///
38+
/// E.g. a positive top inset will change the minimum y value
39+
/// a panel can be dragged to inside ```panelContentWrapperView```.
40+
///
41+
/// - Parameter panel: The panel for which to provide insets.
42+
/// - Returns: Edge insets.
2943
func dragInsets(for panel: PanelViewController) -> UIEdgeInsets
3044

3145
}

0 commit comments

Comments
 (0)