Custom UIBarButtonItem Example

An example of custom UIBarButtonItem

• Swift 3
• Xcode 8

Extension of UIBarButtonItem

extension UIBarButtonItem {
   
   static func custom(with image: UIImage, frame: CGRect = CGRect(x: 0, y: 0, width: 36, height: 36), isRounded: Bool = true, borderWidth: CGFloat = 0, borderColor: UIColor = .white, target: AnyObject?, action: Selector, controlEvents: UIControlEvents = .touchUpInside, showsTouchWhenHighlighted: Bool = true) -> UIBarButtonItem {
       
       let button = UIButton(frame: frame)
       button.setBackgroundImage(image, for: .normal)
       button.showsTouchWhenHighlighted = showsTouchWhenHighlighted
       button.addTarget(target, action: action, for: controlEvents)
       
       if isRounded {
           button.layer.cornerRadius = frame.size.height / 2
       }
       
       button.layer.borderWidth = borderWidth
       button.layer.borderColor = borderColor.cgColor
       button.layer.masksToBounds = button.layer.cornerRadius > 0
       
       let buttonItem = UIBarButtonItem(customView: button)
       
       return buttonItem
   }
}

How to use with UINavigationItem

fileprivate var r2Button = UIBarButtonItem()

override func viewDidLoad() {
    super.viewDidLoad()

    r2Button = UIBarButtonItem.custom(
       with: UIImage(named: "R2-D2"),
       target: self,
       action: #selector(showDetails(sender:))
   )

   navigationItem.rightBarButtonItem = r2Button
}

How to use with UIToolbar

@IBOutlet fileprivate weak var toolBar: UIToolbar!

 override func viewDidLoad() {
     super.viewDidLoad()

     logoButton = UIBarButtonItem.custom(
        with: UIImage(named: "StarWars"),
        frame: CGRect(x: 0, y: 0, width: 54, height: 54),
        target: self,
        action: #selector(showDetails(sender:))
    )

    let flexibleSpace = UIBarButtonItem(barButtonSystemItem: .flexibleSpace, target: nil, action: nil)
    toolBar.setItems([flexibleSpace, logoButton, flexibleSpace], animated: true)
 }

Demo