Configuration

public struct Configuration

Undocumented

  • The width of the side menu. The default is 300. Note that you should only modify this property before the side menu controller is initialized.

    Declaration

    Swift

    public var menuWidth: CGFloat
  • The position of the side menu. Default is .above. Note that you should only modify this property before the side menu controller is initialized.

    Declaration

    Swift

    public var position: MenuPosition
  • Undocumented

    Declaration

    Swift

    public var shouldRespectLanguageDirection: Bool
  • The direction of side menu. Default is .left. Note that you should only modify this property before the side menu controller is initialized.

    Declaration

    Swift

    public var direction: MenuDirection
  • The status bar behavior when menu revealed / hidden. Default is .none.

    Declaration

    Swift

    @available(iOS, deprecated: 13.0, message: "Status bar animation not longer work after iOS 13")
    public var statusBarBehavior: StatusBarBehavior
  • Whether the pan gesture should be enabled. The default is true.

    Declaration

    Swift

    public var enablePanGesture: Bool
  • If enabled, the menu view will act like a rubber band when reaching the border. The default is true.

    Declaration

    Swift

    public var enableRubberEffectWhenPanning: Bool
  • If enabled, the menu view will be hidden when the app entering background. The default is false.

    Declaration

    Swift

    public var hideMenuWhenEnteringBackground: Bool
  • The cache key for the first content view controller.

    Declaration

    Swift

    public var defaultCacheKey: String?
  • The side menu should use content’s supported orientations. Default is false.

    Declaration

    Swift

    public var shouldUseContentSupportedOrientations: Bool
  • The supported orientations of side menu controller. Default is .portrait.

    Declaration

    Swift

    public var supportedOrientations: UIInterfaceOrientationMask
  • The side menu shouldAutorotate. Default is true.

    Declaration

    Swift

    public var shouldAutorotate: Bool