Latest4.0.2
Homepagehttps://github.com/rushisangani/RSSelectionMenu
LicenseMIT
Platformsios 9.0, requires ARC
Authors

An elegant selection list or dropdown menu for iOS with single or multiple selections.

Alt text
Alt text
Alt text
Alt text
Alt text
Alt text

Features

  • Show selection menu as List, Popover or FormSheet with single or multiple selection.
  • Use different cell types. (Basic, RightDetail, SubTitle)
  • Works with Swift premitive types as well as custom NSObject classes.
  • Show selection menu with your custom cells.
  • Search from the list with inbuilt SearchBar.

Requirements

  • iOS 9.0+
  • Xcode 8.3+
  • Swift 3.0+

Installation

CocoaPods

pod 'RSSelectionMenu'
or
pod 'RSSelectionMenu', '~> 4.0.2'

















Usage

Simple Selection List

  • Provide dataSource array and selected items (if any) to show selection list.
  • Update your selected items array when user selects any item.
let simpleDataArray = ["Sachin", "Rahul", "Saurav", "Virat", "Suresh", "Ravindra", "Chris"]
var simpleSelectedArray = [String]()

// Show menu with datasource array - Default SelectionType = Single
// Here you'll get cell configuration where you can set any text based on condition
// Cell configuration following parameters.
// 1. UITableViewCell   2. Object of type T   3. IndexPath

let selectionMenu =  RSSelectionMenu(dataSource: simpleDataArray) { (cell, object, indexPath) in
    cell.textLabel?.text = object

    // Change tint color (if needed)
    cell.tintColor = .orange
}

// set default selected items when menu present on screen.
// Here you'll get onDidSelectRow

selectionMenu.setSelectedItems(items: simpleSelectedArray) { (text, isSelected, selectedItems) in

    // update your existing array with updated selected items, so when menu presents second time updated items will be default selected.
    self.simpleSelectedArray = selectedItems
}

// show as PresentationStyle = Push
selectionMenu.show(style: .Push, from: self)

Multiple Selection List

  • Set SelectionType to .Multiple
  • Set Maximum selection limit
let selectionMenu = RSSelectionMenu(selectionType: .Multiple, dataSource: dataArray, cellType: .Basic) { (cell, object, indexPath) in
    cell.textLabel?.text = object
}
selectionMenu.setSelectedItems(items: selectedDataArray, maxSelected: 3) { (text, selected, selectedItems) in
}

On Dismiss Handler

  • Perform any operation when menu is dismissed

    selectionMenu.onDismiss = { selectedItems in
    self.selectedDataArray = selectedItems
    
    // perform any operation once you get selected items
    }

Cell Type Right Detail/SubTitle

  • Set cell type to RightDetail or SubTitle while initialization.
let selectionMenu = RSSelectionMenu(selectionType: .Single, dataSource: dataArray, cellType: .RightDetail) { (cell, object, indexPath) in

    // here you can set any text from object
    // let's set firstname in title and lastname as right detail

    let firstName = object.components(separatedBy: " ").first
    let lastName = object.components(separatedBy: " ").last

    cell.textLabel?.text = firstName
    cell.detailTextLabel?.text = lastName
}

selectionMenu.setSelectedItems(items: selectedDataArray) { (text, selected, selectedItems) in
    self.selectedDataArray = selectedItems
}

// show as default
selectionMenu.show(from: self)

Show first row as Empty, None, All, or Custom

  • Set default selection value to "", None or All while presenting.
// To show first row as Empty, when dropdown as no value selected by default
// Here you'll get Text and isSelected when user selects first row

selectionMenu.addFirstRowAs(rowType: .Empty, showSelected: self.firstRowSelected) { (text, isSelected) in

    // update your flag here to maintain consistency. -  This is required to be update when presenting for the second time.
    self.firstRowSelected = isSelected
}

Show SearchBar

  • Add searchbar as headerView when you want to search from list.
  • You’ll get notified when user starts typing in searchbar.
// show searchbar
selectionMenu.showSearchBar { (searchtext) -> ([String]) in

    // return filtered array based on any condition
    // here let's return array where name starts with specified search text

    return self.dataArray.filter({ $0.lowercased().hasPrefix(searchText.lowercased()) })
}

Customize SearchBar

  • Change seachbar placeholder text, searchbar tint color.
  • Change searchbar cancel button attributes (Title and TintColor)
// show searchbar with placeholder and tint color
selectionMenu.showSearchBar(withPlaceHolder: "Search Player", tintColor: UIColor.withAlphaComponent(0.5)) { (searchtext) -> ([String]) in
    return self.dataArray.filter({ $0.lowercased().hasPrefix(searchtext.lowercased()) })
}

// customize default cancel button of seachbar
// 1. Set cancel button title to "Dismiss"
// 2. Change tint color. - nil value will set the default tint color

selectionMenu.searchBarCancelButtonAttributes = SearchBarCancelButtonAttributes("Dismiss", nil)

Show as Formsheet or Popover

  • Change presentation type to .Formsheet or .Popover while presenting. – Default style is .Present
// show as formsheet
selectionMenu.show(style: .Formsheet, from: self)

// show as popover
selectionMenu.show(style: .Popover(sourceView: sourceView, size: nil), from: self)

Customize NavigationBar

  • Change Navigation Title, NavigationBar color, Title Color and BarButtonItem titles.
// set navigation title and color
selectionMenu.setNavigationBar(title: "Select Player", attributes: nil, barTintColor: UIColor.orange.withAlphaComponent(0.5), tintColor: UIColor.white)

// right barbutton title - Default is 'Done'
selectionMenu.rightBarButtonTitle = "Submit"

// left barbutton title - Default is 'Cancel'
selectionMenu.leftBarButtonTitle = "Close"

Custom Cells

  • Provide custom cell with xib file name and cell identifier.
let selectionMenu =  RSSelectionMenu(selectionType: .Multiple, dataSource: customDataArray, cellType: .Custom(nibName: "CustomTableViewCell", cellIdentifier: "cell")) { (cell, person, indexPath) in

    // cast cell to your custom cell type
    let customCell = cell as! CustomTableViewCell

    // set cell data here
}

Custom Models or Dictionary

  • RSSelectionMenu can also works with Custom Models.
  • Inherit your models from NSObject.
  • Implement UniqueProperty protocol and define your unique property in the model.

Custom Models with Custom Cells

// Implement UniqueProperty protocol and return property name which has unique value.
// You can also specify this later by - selectionMenu.uniquePropertyName = "id"

class Person: NSObject, UniqueProperty {

    let id: Int
    let firstName: String
    let lastName: String

    init(id: Int, firstName: String, lastName: String) {
    self.id = id
    self.firstName = firstName
    self.lastName = lastName
    }

    // Here id has the unique value for each person
    func uniquePropertyName() -> String {
        return "id"
    }
}

var customDataArray = [Person]()
var customselectedDataArray = [Person]()

// prepare data array with models
customDataArray.append(Person(id: 1, firstName: "Sachin", lastName: "Tendulkar"))
customDataArray.append(Person(id: 2, firstName: "Rahul", lastName: "Dravid"))
customDataArray.append(Person(id: 3, firstName: "Virat", lastName: "Kohli"))

// Show menu with datasource array with Models - SelectionType = Multiple, CellType = Custom

let selectionMenu =  RSSelectionMenu(selectionType: .Multiple, dataSource: customDataArray, cellType: .Custom(nibName: "CustomTableViewCell", cellIdentifier: "cell")) { (cell, person, indexPath) in

    // cast cell to your custom cell type
    let customCell = cell as! CustomTableViewCell

    // here you'll get specified model object
    // set data based on your need
    customCell.setData(person)
}

// show with default selected items and update when user selects any row
selectionMenu.setSelectedItems(items: customselectedDataArray) { (text, selected, selectedItems) in
    self.customselectedDataArray = selectedItems
}

// show searchbar
selectionMenu.showSearchBar { (searchtext) -> ([Person]) in
    return self.customDataArray.filter({ $0.firstName.lowercased().hasPrefix(searchtext.lowercased()) })
}

selectionMenu.show(style: .Push, from: self)
  • If you don’t want to implement protocol then set your unique property as below.
    selectionMenu.uniquePropertyName = "id"     // replace your property name or dictionary key here which has unique value.

Example

See Example for more details.

License

RSSelectionMenu is released under the MIT license. See LICENSE for details.

Latest podspec

{
    "name": "RSSelectionMenu",
    "version": "4.0.2",
    "summary": "An elegant selection list or dropdown menu for iOS with single or multiple selections.",
    "description": "RSSelectionMenu provides easy to use features to show drop-down or selection list with the single or multiple selections.nRSSelectionMenu can work with custom cells as well.",
    "homepage": "https://github.com/rushisangani/RSSelectionMenu",
    "screenshots": [
        "https://raw.githubusercontent.com/rushisangani/RSSelectionMenu/master/Images/image1.png",
        "https://raw.githubusercontent.com/rushisangani/RSSelectionMenu/master/Images/image2.png",
        "https://raw.githubusercontent.com/rushisangani/RSSelectionMenu/master/Images/image3.png",
        "https://raw.githubusercontent.com/rushisangani/RSSelectionMenu/master/Images/image4.png",
        "https://raw.githubusercontent.com/rushisangani/RSSelectionMenu/master/Images/image5.png",
        "https://raw.githubusercontent.com/rushisangani/RSSelectionMenu/master/Images/image6.png"
    ],
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "Rushi Sangani": "[email protected]"
    },
    "source": {
        "git": "https://github.com/rushisangani/RSSelectionMenu.git",
        "tag": "4.0.2"
    },
    "platforms": {
        "ios": "9.0"
    },
    "source_files": "RSSelectionMenu/**/*.swift",
    "requires_arc": true,
    "pod_target_xcconfig": {
        "SWIFT_VERSION": "4"
    }
}

Pin It on Pinterest

Share This