Preferences

public struct Preferences

The preferences of side menu controller.

  • The animation that will apply to the status bar when the menu is revealed/hidden.

    • none: Nothing will happen to the status bar.
    • slide: The status bar will slide up when revealed and slide down when hidden.
    • fade: The status bar will fade out when revealed and show up when hidden.
    • hideOnMenu: The status bar on the side menu will be hidden (without animation), while the one the on content view will still show.
    See more

    Declaration

    Swift

    @available(iOS, deprecated: 13.0, message: "Status bar animation not longer work after iOS 13")
    public enum StatusBarBehavior
  • The direction where menu will show up from.

    • left: Side menu will reveal from the left side.
    • right: Side menu will reveal from the right side.
    See more

    Declaration

    Swift

    public enum MenuDirection
  • The menu view position compared to the content view.

    • above: Menu view is placed above the content view.
    • under: Menu view is placed below the content view.
    • sideBySide: Menu view is placed in the same layer with the content view.
    See more

    Declaration

    Swift

    public enum MenuPosition
  • Undocumented

    See more

    Declaration

    Swift

    public struct Animation
  • Undocumented

    See more

    Declaration

    Swift

    public struct Configuration
  • The basic configuration of side menu

    Declaration

    Swift

    public var basic: SideMenuController.Preferences.Configuration
  • The animation configuration of side menu

    Declaration

    Swift

    public var animation: SideMenuController.Preferences.Animation