DYBadge

DYBadge (written in Swift) is a UILabel subclass that can be added as subview to any UIView and its subclasses (except for UIImageView). If the string value of the badge changes from nil (or "nullish") to a valid string value at runtime the badge will appear with a pop up effect. If it switches back to a "nullish" value, it will shrink and disappear. The class also includes a UIButton class function (extension) to create a button with an image and a title, which is positioned underneath the image. since version 2.0, the xOffset and yOffset values have been removed, as well as badgeFont, badgeColor and badgeTextColor. Simply use the UILabel properties to set these values, e.g. textColor, backgroundColor etc. (don't use myBadge.text directly, use badgeString instead).

Example

To checkout the example project, simply clone the repo or download the zip file.

Features

• Create in code or get a UILabel in Interface Builder and change its class to DYBadge
• Create a UIButton with image and a button title placed underneath the image and add a DYBadge (see the extension in the DYBadge.swift file).

Installation

Installation through Cocoapods or Carthage is recommended.

Carthage: Simply add the following line to your Cartfile.

github "DominikButz/DYBadge" ~> 2.0

Check out the version history below for the current version.

Afterwards, run "carthage update DYBadge --platform iOS" in the root directory of your project. Follow the steps described in the carthage project on github (click on the carthage compatible shield above).

Alternatively, install through Cocoapods:

target '[project name]' do pod 'DYBadge', '~> 2.0 end

Make sure to import DYBadge into your View Controller subclass:

import DYBadge

Usage

Check out the following examples.

Code example: Creating a button with a DYBadge

 @IBOutlet weak var firstButton: UIButton! 
 

 override func viewDidLoad() {
   super.viewDidLoad()
   

     let frame = CGRect(x: self.firstButton.frame.size.width - 3.0, y: -5.0, width: 8.0, height: 5.0)
        let firstBadge = DYBadge(frame: frame)
        
   let font = UIFont(name: "HelveticaNeue-Bold", size: 10.0)!   
   firstBadge.font = font
   firstBadge.backgroundColor = UIColor.red
   firstBadge.textColor = UIColor.white
   
 // set a start value if required
   firstBadge.badgeString = "7"
   
   self.firstButton.addSubview(firstBadge)

  
   
 }

Code example: Creating a button with image and title

 @IBOutlet weak var secondButtonItem: UIBarButtonItem!

 override func viewDidLoad() {
	    super.viewDidLoad()
	    
	     let buttonFrame =  CGRect(x: 0, y: 0, width: 25.0, height: 26.0)
    
        let filterButton  = UIButton.createImageTitleButton(image:  imageLiteral(resourceName: "filterButton"), title: "Filter", font: font, frame: buttonFrame, tintColor: self.view.tintColor)      // see extension
	        
		 let secondBadge = DYBadge(frame: secondBadgeFrame)
       secondBadge.backgroundColor = self.view.tintColor
       secondBadge.textColor = UIColor.white
       secondBadge.font = font
       filterButton.addSubview(secondBadge)

       self.secondButtonItem.customView = filterButton
	}

Cocoapods 1.5 error workaround.

An error message might be displayed (failed to load designables.... no suitable image found) and some storyboard elements might not be drawn correctly. This won't stop xcode from building your code. To remove this annoying error, add the code below to the end of your podfile:

// Workaround for Cocoapods v.1.5 issue #7606

post_install do |installer| installer.pods_project.build_configurations.each do |config| config.build_settings.delete('CODE_SIGNING_ALLOWED') config.build_settings.delete('CODE_SIGNING_REQUIRED') end end

Change log

Version 2.0.4

minor corrections, settings update to swift 5.0

Version 2.0.4

Changed spring damping value in animateBadgeTransform function. The former setting could make a device or the simulator freeze (Xcode 10 / iOS 12) when the badge value was set to a null-type value.

Version 2.0.3

re-added designable and inspectable key words. see the error workaround above.

Version 2.0.2

removed designable and inspectable key words due to error messages in Interface builder.

Version 2.0.1

source file path correction in podspec file.

Version 2.0

xOffset and yOffset values have been removed, as well as badgeFont, badgeColor and badgeTextColor. Simply use the UILabel properties (font, color, backgroundColor) to set these values.

Version 1.1.1

Minor build fix.

Version 1.1

The badge is now placed by default at the origin of the superview. Adjust your offsetX and offsetY values accordingly - see the example above.

Version 1.0.3

public header fix for carthage

Version 1.0.2

adding podfile, readme update

Version 1.0.1

missing source files in example - fix

Version 1.0

see deprecated project DYBadgeButton for previous versions.

Author

[email protected]

License

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