iOS导航栏开发框架:NXNavigationExtension

🔥 NXNavigationExtension 是为 iOS 应用设计的一个轻量级的导航栏处理框架。框架对现有代码入侵非常小,只需要简单的几个方法调用就可以满足大部分的应用场景。NXNavigationExtension 和 示例程序代码 都已经适配暗黑模式(Dark Mode)。

🎉 预览

Preview

🌟 开始使用

下载 NXNavigationExtension 示例代码。

使用 CocoaPods 安装

使用 CocoaPods 将 NXNavigationExtension 集成到 Xcode 项目中,需要在 Podfile 中指定:

pod 'NXNavigationExtension'

使用 Carthage 安装

Carthage 是一个去中心化的包管理器,它构建依赖项并为您提供二进制框架。 要集成 NXNavigationExtension,请将以下内容添加到您的 Cartfile 文件中:

github "l1Dan/NXNavigationExtension"

🌈 要求

最新版本最低支持 iOS 9.0

NXNavigationExtension Version Minimum iOS Target Minimum macOS Target Notes
3.x iOS 9.0 macOS 10.15 macOS: macCatalyst
2.x iOS 11 macOS 10.15 macOS: macCatalyst

优点

  • API 设计通俗易懂,容易上手。
  • 没有继承关系,所有操作基于分类实现,低耦合。
  • 白名单模式,按需注册所使用的导航控制器,这样才不会影响所有的导航控制器外观。
  • 没有对原生导航栏视图层级进行修改,无需担心系统升级的兼容性问题。
  • 适配 iOS、iPadOS、macOS、Swift、横竖屏切换、暗黑模式。
  • 支持 CocoaPods、Carthage、Project 方式集成。

👏 功能

特别实用的功能,总有一款适合你的项目

基本功能

  • 设置导航栏透明
  • 实现系统导航栏模糊效果
  • 自定义返回按钮图片
  • 自定义返回按钮
  • 自定义导航栏模糊背景
  • 修改返回按钮箭头颜色
  • 修改系统返回按钮文字
  • 修改导航栏标题颜色
  • 修改导航栏背景颜色
  • 修改导航栏背景图片
  • 修改导航栏底部线条颜色
  • 修改导航栏底部线条图片

高级功能

  • 禁用滑动返回手势
  • 启用全屏滑动返回手势
  • 导航栏返回事件拦截
  • 重定向任一控制器跳转
  • 导航栏点击事件穿透到底部
  • 动态修改导航栏样式
  • 更新导航栏样式
  • 渐变导航变样式
  • 长按返回按钮显示菜单功能
  • 更多功能请查看示例代码...

🍽 使用

所有对导航栏外观的修改都是基于视图控制器 UIViewController 修改的,而不是基于导航控制器 UINavigationController 修改,这种设计逻辑更加符合实际应用场景。也就是说视图控制器管理自己的导航栏,而不是使用导航控制器来全局管理。

  1. 💉 导入头文件 #import <NXNavigationExtension/NXNavigationExtension.h>
  2. 💉 使用之前需要先注册需要修改的导航控制器。

✅ 推荐

NXNavigationConfiguration *configuration = [NXNavigationConfiguration defaultConfiguration];
configuration.navigationBarAppearance.tintColor = [UIColor customTitleColor];
[configuration registerNavigationControllerClasses:@[[FeatureNavigationController class]] prepareConfigureViewControllerCallback:^NXNavigationConfiguration * _Nullable(__kindof UIViewController * _Nonnull viewController, NXNavigationConfiguration * _Nonnull configuration) {
    configuration.navigationBarAppearance.backgroundColor = [UIColor brownColor];
    return configuration;
}];

// OR
NXNavigationConfiguration *otherConfiguration = [[NXNavigationConfiguration alloc] init];
otherConfiguration.navigationBarAppearance.tintColor = [UIColor customTitleColor];
[otherConfiguration registerNavigationControllerClasses:@[[OtherNavigationController class]]];

❌ 不推荐

NXNavigationConfiguration *configuration = [[NXNavigationConfiguration alloc] init];
configuration.navigationBarAppearance.tintColor = [UIColor customTitleColor];
// UINavigationController 会影响所有的导航控制器,所以不推荐使用这种方式注册
[configuration registerNavigationControllerClasses:@[[UINavigationController class]]];

注意

  • 👉 使用 NXNavigationExtension 之前需要先注册导航控制器,注册之后对导航栏的修改才会生效,也仅限于修改已经注册的导航控制器以及子类所管理的视图控制器,对于子类导航控制器所管理的视图控制器是不会生效的3.4.9及以后的版本已经可以。
  • 👉 为了有效避免框架污染到其他的导航控制器,请保持“谁使用,谁注册”的原则。
  • 🚫 不要直接注册 UINavigationController,会影响全局导航栏的外观,建议创建一个 UINavigationController 的子类,对这个子类进行外观的设置。
  • 🚫 不要使用 setNavigationBarHidden:setNavigationBarHidden:animatedsetHidden: 等方法显示或隐藏系统导航栏。
  • 🚫 不要使用系统导航栏修改透明度。
  • 🚫 不要使用系统导航栏或导航控制器 appearance 相关属性修改。
  • 🚫 不要使用全局 edgesForExtendedLayout 修改3.4.2及以后的版本已经支持。
  • 🚫 不要使用 <UIGestureRecognizerDelegate> 相关方法禁用手势返回。
  • 💉 一句话“不要直接操作导航栏或者导航控制器,把这些都交给 NXNavigationExtension 处理吧“。

建议:除非你非常明白修改全局性东西的后果,否则不要修改,这么做的原因就是为了减少走一些弯路!

🍻 基本功能

修改返回按钮箭头颜色

📝 示例代码

导航栏返回按钮颜色默认使用系统蓝色 [UIColor systemBlueColor],要改变返回按钮颜色可以使用以下方式配合:

// 全局统一修改,不会覆盖基于视图控制器修改
NXNavigationConfiguration *configuration = [[NXNavigationConfiguration alloc] init];
configuration.navigationBarAppearance.tintColor = [UIColor redColor];

// 基于视图控制器修改
- (UIColor *)nx_barTintColor {
    return self.isDarkMode ? [UIColor whiteColor] : [UIColor blackColor];
}

修改系统返回按钮文字

📝 示例代码

// 需要设置使用系统返回按钮,这样才会有效果
- (BOOL)nx_useSystemBackButton {
    return YES;
}

- (NSString *)nx_systemBackButtonTitle {
    return self.backButtonTitle;
}

修改导航栏标题颜色

📝 示例代码

- (NSDictionary<NSAttributedStringKey,id> *)nx_titleTextAttributes {
    return @{NSForegroundColorAttributeName: [self nx_barTintColor]};
}

修改导航栏背景颜色

📝 示例代码

- (UIColor *)nx_navigationBarBackgroundColor {
    return [UIColor customDarkGrayColor];
}

修改导航栏背景图片

📝 示例代码

- (UIImage *)nx_navigationBarBackgroundImage {
    return UIImage.navigationBarbackgroundImage;
}

设置导航栏透明

📝 示例代码

- (UIColor *)nx_navigationBarBackgroundColor {
    return [UIColor clearColor];
}

实现系统导航栏模糊效果

📝 示例代码

- (UIColor *)nx_navigationBarBackgroundColor {
    return [UIColor clearColor];
}

- (BOOL)nx_useBlurNavigationBar {
    return YES;
}

修改导航栏底部线条颜色

📝 示例代码

- (UIColor *)nx_shadowImageTintColor {
    return [UIColor redColor];
}

修改导航栏底部线条颜色图片

📝 示例代码

- (UIColor *)nx_shadowImageTintColor {
    return [UIColor redColor];
}

修改导航栏底部线条颜色图片

📝 示例代码

- (UIImage *)nx_shadowImage {
    return [UIImage imageNamed:@"NavigationBarShadowImage"];
}

自定义返回按钮图片

📝 示例代码

- (UIImage *)nx_backImage {
    return [UIImage imageNamed:@"NavigationBarBack"];
}

自定义返回按钮

📝 示例代码

- (UIView *)nx_backButtonCustomView {
    UIButton *backButton = [UIButton buttonWithType:UIButtonTypeCustom];
    [backButton setTitle:@"😋" forState:UIControlStateNormal];
    [backButton setImage:[UIImage imageNamed:@"NavigationBarBack"] forState:UIControlStateNormal];
    [backButton setTitleColor:UIColor.customDarkGrayColor forState:UIControlStateNormal];
    return backButton;
}

🍺 高级功能

禁用滑动返回手势

📝 示例代码

- (BOOL)nx_disableInteractivePopGesture {
    return YES;
}

启用全屏滑动返回手势

📝 示例代码

  • 局部有效(在所处页面设置)
- (BOOL)nx_enableFullscreenInteractivePopGesture {
    return YES;
}
  • 全局有效
NXNavigationConfiguration *configuration = [[NXNavigationConfiguration alloc] init];
configuration.navigationControllerPreferences.fullscreenInteractivePopGestureEnabled = YES;

导航栏返回事件拦截

📝 示例代码

需要遵守协议 <NXNavigationInteractable>,实现代理方法:

- (BOOL)nx_navigationController:(__kindof UINavigationController *)navigationController willPopViewController:(__kindof UIViewController *)viewController interactiveType:(NXNavigationInteractiveType)interactiveType {
    // TODO...
    return YES;
}
  1. NXNavigationInteractiveTypeCallNXPopMethod: 调用 nx_pop 系列方法返回事件拦截。
  2. NXNavigationInteractiveTypeBackButtonAction: 点击返回按钮返回事件拦截。
  3. NXNavigationInteractiveTypeBackButtonMenuAction: 长按返回按钮选择菜单返回事件拦截。
  4. NXNavigationInteractiveTypePopGestureRecognizer: 使用手势交互返回事件拦截。
- (BOOL)nx_navigationController:(__kindof UINavigationController *)navigationController willPopViewController:(__kindof UIViewController *)viewController interactiveType:(NXNavigationInteractiveType)interactiveType {
    NSLog(@"interactiveType: %zd %@", interactiveType, viewController);

    if (self.currentItemType == EventInterceptItemTypeBackButtonAction && interactiveType == NXNavigationInteractiveTypeBackButtonAction) {
        [self showAlertControllerWithViewController:viewController];
        return NO;
    }

    if (self.currentItemType == EventInterceptItemTypeBackButtonMenuAction && interactiveType == NXNavigationInteractiveTypeBackButtonMenuAction) {
        [self showAlertControllerWithViewController:viewController];
        return NO;
    }

    if (self.currentItemType == EventInterceptItemTypePopGestureRecognizer && interactiveType == NXNavigationInteractiveTypePopGestureRecognizer) {
        [self showAlertControllerWithViewController:viewController];
        return NO;
    }

    if (self.currentItemType == EventInterceptItemTypeCallNXPopMethod && interactiveType == NXNavigationInteractiveTypeCallNXPopMethod) {
        [self showAlertControllerWithViewController:viewController];
        return NO;
    }

    if (self.currentItemType == EventInterceptItemTypeAll) {
        [self showAlertControllerWithViewController:viewController];
        return NO;
    }

    return YES;
}
QR Code
微信扫一扫,欢迎咨询~

联系我们
武汉格发信息技术有限公司
湖北省武汉市经开区科技园西路6号103孵化器
电话:155-2731-8020 座机:027-59821821
邮件:tanzw@gofarlic.com
Copyright © 2023 Gofarsoft Co.,Ltd. 保留所有权利
遇到许可问题?该如何解决!?
评估许可证实际采购量? 
不清楚软件许可证使用数据? 
收到软件厂商律师函!?  
想要少购买点许可证,节省费用? 
收到软件厂商侵权通告!?  
有正版license,但许可证不够用,需要新购? 
联系方式 155-2731-8020
预留信息,一起解决您的问题
* 姓名:
* 手机:

* 公司名称:

姓名不为空

手机不正确

公司不为空