开始使用

如何安装

QMUI iOS 有 3 种使用方式:

1. 直接下载项目代码

GitHub 上下载 QMUI iOS,或者以 git subtree 的方式将 QMUI iOS 的代码拉取到项目目录内,然后将 qmui.xcodeproj 拖到你的项目内(也即把 QMUI 作为你的项目的子项目)。

1.1 如果使用动态库 QMUIKit.framework(推荐,针对 iOS 8+)

打开你的项目的 project,在 General -> Embedded Binaries 中点击加号添加 QMUIKit.framework,此时 Embedded Binaries 和 Linked Frameworks and Libraries 里应该都会出现 QMUIKit.framework

使用动态库

*注意:如果使用 command-line 编译错误,提示 #import <QMUIKit/QMUIKit.h> 找不到文件,请在项目的 Build Settings -> Header Search Paths 中添加 QMUI iOS 所在的目录。

1.2 如果使用静态库 libQMUI.a(针对 iOS 8 以下版本)

打开你的项目的 project,在 Build Phases -> Target Dependencies 中点击加号添加 QMUI,然后在 Link Binary With Libraries 中点击加号添加 libQMUI.a

Link Binary With Libraries 设置

接着在 Build Settings -> Header Search Paths 中添加 QMUI iOS 的路径,并选择 recursive,具体路径取决于你存放 QMUI iOS 的位置。

Header Search Paths 设置

然后在 Build Settings -> Other Linker Flags 里添加 -ObjC

最后,展开 Project navigator 里的 qmui.xcodeproj,找到 UIResources 文件夹,右键点击 Show in Finder,在文件管理器里把里面的两个 bundle 文件拖到你的项目里,注意不要勾选 Copy items if needed

bundle 文件处理

2. 使用 CocoaPods

在你的项目的 Podfile 里添加如下内容:

platform: ios, '7.0'
pod 'QMUIKit'
# 如果你的项目支持 iOS 8+,建议用动态库
# use_frameworks!

然后运行 pod install 即可。

3. 使用 Carthage

请在项目的 Cartfile 里添加:

github "QMUI/QMUI_iOS"

在按照 Carthage 的标准方式将 QMUIKit.framework 添加到项目里即可。

如何使用

至此 QMUI iOS 已完全接入到项目中,需要使用的地方请直接 #import <QMUIKit/QMUIKit.h>,不建议只 import 用到的控件的头文件,否则内部一些逻辑可能无法正确依赖。

QMUI iOS 主要由 4 大部分组成:

  1. UIMainFrame: 几个常用的 UIViewController 的基类,建议将这几个基类作为你项目里的对应 class 的父类,QMUI iOS 有大量功能也是基于这几个基类实现。
  2. UIKitExtensions: 对系统的 UIKit 的拓展,所有拓展的方法、属性均会带 qmui_ 前缀,以避免冲突。
  3. UIComponents: 提供大量常用的控件,具体的控件列表及效果展示请查看 QMUI Demo
  4. UICommon: 提供全局配置表、常用的宏、工具方法等。

若想快速了解完整的功能,请查看功能列表;若想了解某个 class 的具体使用方式,建议下载 QMUI Demo 的源码。

如何使用
配置表

QMUI 提供一份配置表 QMUIConfigurationTemplate 用于快速配置整个项目的样式,但这份配置表默认不参与编译,需要的时候请自行复制到项目 project 里并修改里面的值。下面根据 3 种不同的安装方式分别列出详细步骤。

1. 添加配置表文件

1.1 直接下载项目代码

展开 Project navigator 里的 qmui.xcodeproj,找到 QMUIConfigurationTemplate 文件夹,右键点击 Show in Finder,在文件管理器里把 QMUIConfigurationTemplate 文件夹拖到你的项目里,注意选择 Copy items if needed

添加配置表

添加配置表

1.2 使用 CocoaPods

请在项目左侧的 Project navigator 里找到 QMUIKit,右键点击选择 Show in Finder,然后在打开的窗口里找到目录 QMUIConfigurationTemplate,将其中的两个文件拖到你项目 Xcode 的 Project navigator 里,注意选择 Copy items if needed

1.3 使用 Carthage

请在 Finder 里打开 Carthage/Checkouts/QMUI_iOS/,将其中的 QMUIConfigurationTemplate 文件夹拖到项目的 Xcode Project navigator 中,注意选择 Copy items if needed

2. 调用配置表

请打开你的项目的 AppDelegate.m,添加以下代码:

#import <QMUIKit/QMUIKit.h>
#import "QMUIConfigurationTemplate.h"

  - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // 建议放在方法的开头,以保证在其他 UI 操作之前执行

    // 启动 QMUI 的样式配置模板
    [QMUIConfigurationTemplate setupConfigurationTemplate];

    ...
  }

到此配置表已能正常工作,请按需修改配置表里各项的值。借助配置表,每个应用可方便地实现多套皮肤,具体也可参考 QMUI Demo