开始使用

如何安装

QMUI iOS 有 3 种使用方式:

1. 使用 CocoaPods

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

pod 'QMUIKit'

然后运行 pod install 即可。

如果只需要引入某几个特定的子模块,则可参照以下写法,具体的子模块列表请直接查看项目源码里的 QMUIKit.podspec 文件:

pod 'QMUIKit/QMUIComponents/QMUIModalPresentationViewController'

2. 使用 Carthage

请在项目的 Cartfile 里添加:

github "QMUI/QMUI_iOS"

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

3. 直接下载项目代码

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

image1

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

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

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

image2

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

image3

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

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

image4

如何使用

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

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

  1. QMUICore:配置表、全局的宏、工具方法等,是所有 QMUI 类的基础代码。
  2. QMUIMainFrame:几个常用的 UIViewController 的基类,建议将这几个基类作为你项目里的对应 class 的父类,QMUI iOS 有大量功能也是基于这几个基类实现。
  3. UIKitExtensions:对系统 UIKit 的拓展,所有 Category 的方法、属性均会带 qmui_ 前缀,以避免冲突。
  4. QMUIComponents:提供大量常用的控件,具体的控件列表请查看功能列表,至于效果展示、使用代码示例请查看 QMUI Demo
  5. QMUIResources:存储 QMUI 控件里可能用到的一些图,例如表情面板的删除按钮、选图控件的 checkbox、QMUITips 那些成功、失败的 icon 等。

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

如何使用配置表

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

1. 添加配置表文件

1.1 使用 CocoaPods

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

1.2 使用 Carthage

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

1.3 直接下载项目代码

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

image5

image6

2. 调用配置表

从 2.3.0 版本开始,QMUI 配置表无需手动运行,只要你添加了配置表文件到项目里,则在启动的时候 QMUI 会根据一些规则(如文件名、是否实现指定协议等,具体请查看 issue#264)找到配置表文件并运行它。因此你只要保证配置表文件按照上文步骤正确添加即可。

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