YYKit README

The project's README from github.com/ibireme/YYKit. As one markdown file: README.md.

YYKit

License MIT  Carthage compatible  CocoaPods  CocoaPods  Support  Build Status

YYKit is a collection of iOS components.

It's so huge that I split it into several independent components:

Demo Project

See Demo/YYKitDemo.xcodeproj


Installation

CocoaPods

  1. Add pod 'YYKit' to your Podfile.
  2. Run pod install or pod update.
  3. Import <YYKit/YYKit.h>.

Carthage

  1. Add github "ibireme/YYKit" to your Cartfile.
  2. Run carthage update --platform ios and add the framework to your project.
  3. Import <YYKit/YYKit.h>.
  4. Notice: carthage framework doesn't include webp component, if you want to support webp, use CocoaPods or install manually.

Manually

  1. Download all the files in the YYKit subdirectory.
  2. Add the source files to your Xcode project.
  3. Add -fno-objc-arc compiler flag to NSObject+YYAddForARC.m and NSThread+YYAdd.m.
  4. Link with required frameworks:
    • UIKit
    • CoreFoundation
    • CoreText
    • CoreGraphics
    • CoreImage
    • QuartzCore
    • ImageIO
    • AssetsLibrary
    • Accelerate
    • MobileCoreServices
    • SystemConfiguration
    • sqlite3
    • libz
  5. Add Vendor/WebP.framework(static library) to your Xcode project if you want to support WebP.
  6. Import YYKit.h.

Documentation

Full API documentation is available on CocoaDocs.
You can also install documentation locally using appledoc.

Requirements

This library requires iOS 6.0+ and Xcode 8.0+.

Notice

I want to use the APIs as if it was provided by system, and I don't add prefix in these categories. I do not recommend using the YYKit directly, you should try the separated components first.

License

YYKit is provided under the MIT license. See LICENSE file for details.



中文介绍

YYKit 是一组功能丰富的 iOS 组件。

为了尽量复用代码，这个项目中的某些组件之间有比较强的依赖关系。为了方便其他开发者使用，我从中拆分出以下独立组件：

演示项目

查看并运行 Demo/YYKitDemo.xcodeproj


安装

CocoaPods

  1. 在 Podfile 中添加 pod 'YYKit'。
  2. 执行 pod install 或 pod update。
  3. 导入 <YYKit/YYKit.h>。

Carthage

  1. 在 Cartfile 中添加 github "ibireme/YYKit"。
  2. 执行 carthage update --platform ios 并将生成的 framework 添加到你的工程。
  3. 导入 <YYKit/YYKit.h>。
  4. 注意: carthage framework 并没有包含 webp 组件。如果你需要支持 webp，可以用 CocoaPods 安装，或者手动安装。

手动安装

  1. 下载 YYKit 文件夹内的所有内容。
  2. 将 YYKit 内的源文件添加(拖放)到你的工程。
  3. 为 NSObject+YYAddForARC.m 和 NSThread+YYAdd.m 添加编译参数 -fno-objc-arc。
  4. 链接以下 frameworks:
    • UIKit
    • CoreFoundation
    • CoreText
    • CoreGraphics
    • CoreImage
    • QuartzCore
    • ImageIO
    • AssetsLibrary
    • Accelerate
    • MobileCoreServices
    • SystemConfiguration
    • sqlite3
    • libz
  5. 如果你需要支持 WebP，可以将 Vendor/WebP.framework(静态库) 加入你的工程。
  6. 导入 YYKit.h。

文档

你可以在 CocoaDocs 查看在线 API 文档，也可以用 appledoc 本地生成文档。

系统要求

该项目最低支持 iOS 6.0 和 Xcode 8.0。

注意

我希望调用 API 时，有着和调用系统自带 API 一样的体验，所以我并没有为 Category 方法添加前缀。我已经用工具扫描过这个项目中的 API，确保没有对系统 API 产生影响，但即使这样没有前缀的 Category 也可能会带来其他麻烦。因此我不太推荐直接使用 YYKit 这个库，你应该先尝试一下上面那些拆分出来的独立组件。

许可证

YYKit 使用 MIT 许可证，详情见 LICENSE 文件。

相关文章

iOS 保持界面流畅的技巧

YYKit (ibireme/YYKit)

Searching Database…

14K ·GitHub
YYKit
Что это такое?YYKit — это большой набор компонентов для iOS, который объединяет несколько независимых библиотек для высокопроизводительного преобразования моделей, кэширования, загрузки и декодирования изображений, отображения форматированного текста, отслеживания клавиатуры и асинхронной отрисовки.
Это один цельный фреймворк или набор отдельных библиотек?Это набор независимых компонентов (YYModel, YYCache, YYImage, YYWebImage, YYText, YYKeyboardManager, YYDispatchQueuePool, YYAsyncLayer, YYCategories), собранных вместе, однако автор рекомендует использовать отдельные компоненты по одному, а не весь комплект целиком.
Как добавить его в проект Xcode?Добавьте 'pod YYKit' в свой Podfile и выполните pod install, либо добавьте 'github ibireme/YYKit' в свой Cartfile и выполните carthage update --platform ios; также можно вручную скачать исходные файлы и перетащить их в проект.
Какие системные фреймворки нужно подключить?Нужно подключить UIKit, CoreFoundation, CoreText, CoreGraphics, CoreImage, QuartzCore, ImageIO, AssetsLibrary, Accelerate, MobileCoreServices, SystemConfiguration, sqlite3 и libz, а также специальный флаг компилятора для работы без ARC для двух файлов при ручной установке.
Есть ли подводные камни при установке?Сборки через Carthage по умолчанию не включают компонент WebP, поэтому для поддержки WebP нужно использовать CocoaPods или ручную установку; при ручной установке также нужно добавить флаг -fno-objc-arc для двух конкретных исходных файлов.
Какие версии iOS и Xcode поддерживаются?Требуется iOS 6.0 или новее и Xcode 8.0 или новее.
Почему автор не рекомендует использовать YYKit напрямую?Автор предупреждает, что методы категорий не имеют префикса, поэтому они могут конфликтовать с другим кодом, хотя проверка на конфликты проводилась; он советует попробовать отдельные самостоятельные компоненты (например, YYImage или YYCache) вместо всего комплекта.
Что делает YYWebImage?Это фреймворк для асинхронной загрузки изображений; он отделён от YYImage, который занимается отображением, кодированием и декодированием анимированных форматов WebP, APNG и GIF.
Для чего нужен YYText?YYText — это мощный компонент для работы с форматированным текстом в iOS, который используется для отображения и редактирования текста со стилями.
Есть ли демо, которое можно попробовать?Да, в репозитории есть Demo/YYKitDemo.xcodeproj, который можно открыть и запустить, чтобы посмотреть компоненты в действии.
What are similar projects?SDWebImage, Kingfisher, GPUImage, glide, fresco, IGListKit, JSQMessagesViewController, Android-Universal-Image-Loader
Which topics is it in?cache, ui-library, objective-c, image, caching, document-processing, image-processing, mobile, ios, chinese, library, mit
Creator
ibireme
Size
55.6 MB
Stars
14K
Updated
CommitAug 06
Age
13y
Commits · 90 Days