Git Product home page Git Product logo

sidetown's Introduction

SideTown

SideTown is the simplest way to create a side menu for iOS devices.

side town

side town

Table of Contents

  1. Installation
  2. Usage
  3. Configuration

Installation

File > Add Packages.. > paste to search area this https://github.com/sametkoyuncu/SideTown.git > click Add Package button

Usage

  • Create a new UIViewController class named BaseViewController
class BaseViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
    }
}  
  • Create menu design like you want
let menuView = UIView(frame: CGRect(x: 0,
                                    y: 0,
                                    width: 280,
                                    height: UIScreen.main.bounds.height))
menuView.backgroundColor = .red
  • Implement SideTown to BaseViewController
import UIKit
import SideTown

class BaseViewController: UIViewController {
    private var sideMenu: SideMenu!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        // MARK: - Your Menu View
        // custom menu view inside side menu
        let menuView = UIView(frame: CGRect(x: 0,
                                              y: 0,
                                              width: 280,
                                              height: UIScreen.main.bounds.height))
        menuView.backgroundColor = .red
                        
        // side menu
        let config: MenuConfig = .init(vc: self, customView: menuView)
        sideMenu = SideMenu(config)
    }
    
    func openMenu() {
        sideMenu.openMenu()
    }
    
    func closeMenu() {
        sideMenu.closeMenu()
    }
    
    func toggleMenu() {
        sideMenu.toggleMenu()
    }
 }
  • Create another ViewController subclass of BaseViewController. And add a new button for open menu.
import UIKit
class ViewController: BaseViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
    }
    
    @IBAction func menuButtonTapped(_ sender: Any) {
        super.openMenu()
    }
}
  • Run project
  • For more information checkout sample project ๐Ÿ‘‰ Go

Configuration

Property Type Description isRequired
vc UIViewController It's necessary for swipe gesture and navigation bar actions. โœ…
customView UIView Your design, showing inside the side menu. โœ…
position MenuPosition Side menu position. .left or .right. The default value is .left. โŒ
backgroundColor UIColor Side menu background color. The default value is .darkGray.withAlphaComponent(0.7). โŒ

sidetown's People

Contributors

sametkoyuncu avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.