Git Product home page Git Product logo

swiftymenu's Introduction

SwiftyMenu

CI Status Cocoapod Version MIT License
Facebook: @KarimEbrahemAbdelaziz Twitter: @KarimEbrahem512

SwiftyMenu is simple yet powerfull drop down menu component for iOS. It allow you to have drop down menu that doesn't appear over your views, which give you awesome user experience.

Android version

TODO ๐Ÿ’ช๐Ÿป

  • Automate release new version to Cocoapods from Travis CI.
  • Add CHANGELOG file for the project.
  • Allow custom header and options cells.
  • Allow different interactions to dismiss SwiftyMenu.
  • Allow to customize the default seperator.
  • Support Generic DataSource.
  • Support Swift 5 (tag 0.5.8).
  • Support Swift 4.2 (tag 0.5.7).
  • Support multi selection in SwiftMenu ๐Ÿ”ฅ.
  • Support multi SwiftyMenu in one screen.
  • Support stack view and add example.
  • Support call backs and delegation.
  • Support different types of Animations.
  • Add different customization to colors for default cells.

And much more ideas to make it solid drop down menu for iOS projects ๐Ÿ˜Ž๐Ÿ’ช๐Ÿป

Screenshots ๐Ÿ‘€

Requirements โš™๏ธ

  • Xcode 10.2+
  • Swift 5
  • iOS 10+

Example ๐Ÿ› 

Do pod try SwiftyMenu in your console and run the project to try a demo. To install CocoaPods, run sudo gem install cocoapods in your console.

Installation ๐Ÿ“ฑ

SwiftyMenu supports Swift 5.0 since version 0.1.0.

CocoaPods

Use CocoaPods.

Swift 5

  1. Add pod 'SwiftyMenu', '~> 0.5.8' to your Podfile.
  2. Install the pod(s) by running pod install.
  3. Add import SwiftyMenu in the .swift files where you want to use it

Swift 4.2

  1. Add pod 'SwiftyMenu', '~> 0.5.7' to your Podfile.
  2. Install the pod(s) by running pod install.
  3. Add import SwiftyMenu in the .swift files where you want to use it

Basic Usage ๐Ÿ’Ž

Storyboard

// Connect view in storyboard with you outlet
@IBOutlet private weak var dropDownMenu: SwiftyMenu!

// Define your options array (for now SwiftyMenu only accept String array, soon it'll be generic ๐Ÿ˜‰)
private let optionsData = ["Option 1", "Option 2", "Option 3", "Option 4"]

// Assign the component that implement SwiftyMenuDelegate to SwiftyMenu component
dropDownMenu.delegate = self

// Give array of options to SwiftyMenu
dropDownMenu.options = optionsData

Then implement SwiftyMenuDelegate:

extension ViewController: SwiftyMenuDelegate {
    // Get selected option from SwiftyMenu
    func didSelectOption(_ swiftyMenu: SwiftyMenu, _ selectedOption: String, _ index: Int) {
        print("Selected option: \(selectedOption), at index: \(index)")
    }
    
    // SwiftyMenu drop down menu will appear
    func swiftyMenuWillAppear(_ swiftyMenu: SwiftyMenu) {
        print("SwiftyMenu will appear.")
    }

    // SwiftyMenu drop down menu did appear
    func swiftyMenuDidAppear(_ swiftyMenu: SwiftyMenu) {
        print("SwiftyMenu did appear.")
    }

    // SwiftyMenu drop down menu will disappear
    func swiftyMenuWillDisappear(_ swiftyMenu: SwiftyMenu) {
        print("SwiftyMenu will disappear.")
        }

    // SwiftyMenu drop down menu did disappear
    func swiftyMenuDidDisappear(_ swiftyMenu: SwiftyMenu) {
        print("SwiftyMenu did disappear.")
    }
}

Also you can use callbacks to know what happen:

// Support different callbacks for different events
dropDownMenu.didExpand = {
    print("SwiftyMenu Expanded!")
}

dropDownMenu.didCollapse = {
    print("SwiftyMeny Collapsed")
}

dropDownMenu.didSelectOption = { (selection: Selection) in
    print("\(selection.value) at index: \(selection.index)")
}

Customize UI ๐Ÿ˜Ž

You can configure SwiftyMenu from Storyboard or Code as following:

// Change option's row height (default 35)
dropDownMenu.rowHeight = 35

// Change option's drop down menu height 
// default is 0, which make drop down height = number of options * rowHeight
dropDownMenu.listHeight = 150

// Change drop down menu border width
dropDownMenu.borderWidth = 1.0

// Change drop down menu scroll behavior 
dropDownMenu.scrollingEnabled = false

// Change drop down menu default colors
dropDownMenu.borderColor = .black
dropDownMenu.optionColor = .red
dropDownMenu.placeHolderColor = .blue
dropDownMenu.menuHeaderBackgroundColor = .lightGray
dropDownMenu.rowBackgroundColor = .orange

// Change drop down menu default expand and collapse animation
dropDownMenu.expandingAnimationStyle = .spring(level: .high)
dropDownMenu.expandingDuration = 0.5
dropDownMenu.collapsingAnimationStyle = .linear
dropDownMenu.collapsingDuration = 0.5

Author

Karim Ebrahem, [email protected]

License

SwiftyMenu is available under the MIT license. See the LICENSE file for more info.

Credits

You can find me on Twitter @KarimEbrahem512.

It will be updated when necessary and fixes will be done as soon as discovered to keep it up to date.

Enjoy!

swiftymenu's People

Contributors

karimebrahemabdelaziz avatar amrangry avatar aramy23 avatar

Watchers

James Cloos 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.