GJRedDot 1.1.1

GJRedDot 1.1.1

TestsTested
LangLanguage Obj-CObjective C
License MIT
ReleasedLast Release May 2017

Maintained by wangyutao.



GJRedDot 1.1.1

  • By
  • wangyutao

#GJRedDot 这是一个小红点的解决方案,你可以方便的使用它去管理你的小红点提示。如有bug或者建议,请提issue或PR,感谢支持。

##使用场景 我们的项目中,有很多小红点联动的需求,例如上一级页面的小红点受下一级页面小红点的影响,比如微信的“发现——朋友圈”,当朋友圈有新消息时,发现tab页面朋友圈cell中的icon上会有一个小红点,这时发现tab的icon上也有一个小红点,但是当我们点击“发现tab“的时候,小红点并不消失,而是点击朋友圈cell后,cell上和“发现tab”上的小红点同时消失,类似的需求很多APP中都可以发现。

最开始我们使用消息中心来实现,后来发现,当小红点级别变多后,代码量几何增长且分散各处,十分混乱,为了解决这个问题,我们将它进行封装。首先用key将小红点的进行关联并注册,然后只需在显示小红点的页面设置刷新block,并在任何需要刷新他的地方调用改变显示状态的方法,只需这三步即可完成。

##开始 支持Pod,或手动导入文件夹GJRedDot

    pod 'GJRedDot'
    #import "GJRedDot.h"

##注册 首先,需要在app launch中,以小红点对应的key,通过NSArray及NSDictionary关联起来,并进行注册(见Demo)

@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [GJRedDot registWithProfile:[GJRedDotRegister registProfiles] defaultShow:YES];//defaultShow为默认状态是展示还是隐藏
    return YES;
}

这个例子在Demo中:GJTabBar2是第二个tabbar的小红点Key,它与这个tab的rootVC中的icon(GJGroupKey)进行关联,GJGroupKey又与下一级页面的3个按钮(GJSunnyxxKey,GJUncleBirdKey,GJSardKey)进行关联。最后所实现的功能就是,GJSunnyxxKey,GJUncleBirdKey,GJSardKey三个按钮中有一个按钮有小红点,则GJGroupKey,GJTabBar2上也会显示小红点,如果三个按钮中小红点都消失,则GJGroupKey,GJTabBar2上的小红点才会消失。

看着不太明白是吧?下面用伪代码解释一下:

- (BOOL)isShowGJTabBar2 {
    if (GJGroupKey.isShow) return YES;
    return NO
}

- (BOOL)isShowGJGroupKey {
    if(!GJSunnyxxKey.isShow && !GJUncleBirdKey.isShow && !GJSardKey.isShow) return NO;
    return YES;
}

是不是清晰点了?

注意:默认注册方法下,是使用GJRedDotModelUserDefault,将使用Key缓存到NSUserDefault中,所以请保证小红点的Key与程序中其他地方的Key区分开,以防出现问题。

Demo注册代码:

NSString *const GJTabBar2 = @"GJTabBar2";
NSString *const GJGroupKey = @"GJAllGays";
NSString *const GJSunnyxxKey = @"GJSunnyxxIsGay";
NSString *const GJUncleBirdKey = @"GJUncleBird";
NSString *const GJSardKey = @"GJSarkIsGay";

@implementation GJRedDotRegister
+ (NSArray *)registProfiles {
    return @[
             @{GJTabBar2:@{GJGroupKey:@[
                                   GJSunnyxxKey,
                                   GJUncleBirdKey,
                                   //GJSardKey 这里注释掉是为了后面的单独注册的方法,与在这里注册等效
                                   ]
                           }
               }
             ];
}

你也可以在需要的时候单独动态注册Key,在demo中也有示例

    [GJRedDot registNodeWithKey:GJSarkKey parentKey:GJGroupKey];

##使用 在需要使用小红点的地方调用如下方法

    //将小红点刷新的callback block绑定到持有小红点的对象上(handler),当它release的时候,也自动release小红点的刷新block
    //block是小红点刷新的动作,当有其他与当前key相关联的小红点状态发生变化或自身发生变化时,并影响到当前小红点状态,则进行刷新动作
    //这里要使用weakSelf避免循环引用
    __weak typeof(self) weakSelf = self;
    [self setRedDotKey:GJGroupKey refreshBlock:^(BOOL show) {
        weakSelf.gjGroupButton.showRedDot = show;
    } handler:self];

在需要改变小红点状态的地方调用此方法:

    //改变小红点状态,他会自动在上一个方法中刷新小红点,以及刷新想关联的小红点状态
    [self resetRedDotState:NO forKey:GJGroupKey];

你可以通过2个方法把小红点全部置为隐藏或显示状态:

     [GJRedDot resetAllNodesBecomeShown];
     [GJRedDot resetAllNodesBecomeHidden];

你可以在程序开始时统一设置默认的小红点大小和颜色:

     [GJRedDot setDefaultRadius:4];
     [GJRedDot setDefaultColor:[UIColor orangeColor]];

##通过系统原生UITabBarItem添加小红点功能

//VC中的方法
- (void)methodVC {
//self就是VC
    self.tabBarItem.showRedDot = YES;
}

//通过tabBar的items获取item来设置
- (void)methodTabBar {
    self.tabBarController.tabBar.items[1].isShowRedDot = YES;
}

//设置偏移量
- (void)setOffset {
    self.taBarItem.redDotOffset = CGPointMake(5, 10);
}

//设置小红点半径
- (void)setRadius {
    self.taBarItem.redDotRadius = 10;
}

//设置小红点颜色
- (void)setColor {
    self.taBarItem.redDotColor = [UIColor redColor];
}

//使用自定义view显示在小红点位置
- (void)setCustomView {
    self.taBarItem.customView = ....;
}

##给以UIView为基类的View添加小红点及badge 当设置badgeValue后,优先显示badgeValue,当badgeValue为nil后,才会根据showRedDot来显示小红点

- (void)setRedDotWithView:(UIView *)view{
    view.showRedDot = YES;
    
    view.redDotRadius = 4.0;
    
    view.redDotOffset = CGPointMake(10, 5);
    
    view.redDotColor = [UIColor BlueColor];
    
    view.redDotBorderWitdh = 1.0;
    
    view.redDotBorderColor = [UIColor yellowColor];
    
    view.badgeValue = @"12345";
    
    view.badgeOffset = CGPointMake(10, 5);
}