Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikeMTOL/UIBarButtonItem-Badge
UIBarButtonItem+Badge
https://github.com/mikeMTOL/UIBarButtonItem-Badge
Last synced: about 2 months ago
JSON representation
UIBarButtonItem+Badge
- Host: GitHub
- URL: https://github.com/mikeMTOL/UIBarButtonItem-Badge
- Owner: mikeMTOL
- Created: 2014-05-06T14:31:51.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-02T04:57:25.000Z (over 6 years ago)
- Last Synced: 2024-06-24T02:36:00.326Z (3 months ago)
- Language: Objective-C
- Size: 133 KB
- Stars: 946
- Watchers: 23
- Forks: 167
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
UIBarButtonItem-Badge
=====================
##UIBarButtonItem+Badge
This is categorization of [this github Class](https://github.com/TanguyAladenise/BBBadgeBarButtonItem). Its expanded for UIButton use too.
UIBarButtonItem+Badge
==============
Create a BarButtonItem with a badge on top. Easily customizable.
Your BarButtonItem can be any custom view you wish for. The badge on top can display any number or string of any size or length.
UIButton+Badge
==============
Create a UIButton with a badge on top. Easily customizable.
Your UIButton can be any button you wish to use. The badge on top can display any number or string of any size or length.
How To Get Started
------------------
#### Installation
It's quite easy, just download and add "UIBarButtonItem+Badge.h" and "UIBarButtonItem+Badge.m" into your xcodeproject.
Don't forget to import the header file wherever you need it :
``` objective-c
#import "UIBarButtonItem+Badge.h"
```
Usage
------------------
Then, to add a badge call setBadgeValue on the UIBarButton item and the trick is done! Make sure you're using
UIBarButtonItem with custom view
``` objective-c
// Build your regular UIBarButtonItem with Custom View
UIImage *image = [UIImage imageNamed:@"someImage"];
UIButton *button = [UIButton buttonWithType:UIButtonTypeCustom];
button.frame = CGRectMake(0,0,image.size.width, image.size.height);
[button addTarget:self action:@selector(buttonPress:) forControlEvents:UIControlEventTouchDown];
[button setBackgroundImage:image forState:UIControlStateNormal];
// Make BarButton Item
UIBarButtonItem *navLeftButton = [[UIBarButtonItem alloc] initWithCustomView:button];
self.navigationItem.leftBarButtonItem = navLeftButton;
self.navigationItem.leftBarButtonItem.badgeValue = @"1";
```
A new merge now enables adding badge without a custom view
``` objective-c
UIImage *image = [UIImage imageNamed:@"someImage"];
UIBarButtonItem *navLeftButton = [[UIBarButtonItem alloc] initWithImage:image
style:UIBarButtonItemStylePlain
target:self
action:@selector(buttonPress:)];
self.navigationItem.leftBarButtonItem = navLeftButton;
self.navigationItem.leftBarButtonItem.badgeValue = @"1";
```
Useful properties
---------------
Take a look at UIBarButtonItem+Badge.h to see how you can customize the badge.
Remember that each time you change one of these value, the badge will directly be refresh to handle your styling preferences.
``` objective-c
// Each time you change one of properties, the badge will refresh with your changes
// Badge value to be display
@property (nonatomic) NSString *badgeValue;
// Badge background color
@property (nonatomic) UIColor *badgeBGColor;
// Badge text color
@property (nonatomic) UIColor *badgeTextColor;
// Badge font
@property (nonatomic) UIFont *badgeFont;
// Padding value for the badge
@property (nonatomic) CGFloat badgePadding;
// Minimum size badge to small
@property (nonatomic) CGFloat badgeMinSize;
// Values for offseting the badge over the BarButtonItem you picked
@property (nonatomic) CGFloat badgeOriginX;
@property (nonatomic) CGFloat badgeOriginY;
// In case of numbers, remove the badge when reaching zero
@property BOOL shouldHideBadgeAtZero;
// Badge has a bounce animation when value changes
@property BOOL shouldAnimateBadge;
```
You can also choose to turn off the little bounce animation triggered when changing the badge value or decide if 0 should be display or not.
Requirements
---------------
The class is compatible with iOS >= 6.0.
More
----
Any suggestions are welcome ! as I am looking to learn good practices, to understand better behaviors and Objective-C in general !
Thank you.
LICENSE
-------
The MIT License (MIT)
Copyright (c)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.