elenionl/easydarkmode

This is a tool for developers to easily adapt dark mode in iOS 13.

EasyDarkMode

Introduction

iOS 13 introduces user interface feature. This feature contains two kinds of user interface types, light and dark.

This project is a tool for developers to easily adapt user interface feature in iOS 13.

Star if you like it.

Samples

Integrate with Cocoapods

Use this firm to find podfile script for your project.

Firstly, choose according to the language used in your project (Swift/Objective-C).

Secondly, choose according to whether you are using network image (Local image/Others).

Then, if you are using network image, choose the download method you preferred (SDWebImage/Kingfisher/Custom download method).

Podfile script	Objective-C	Swift	Local image	SDWebImage	Kingfisher	Custom download
pod 'EasyDarkMode' or pod 'EasyDarkMode/Core'	●	○	●	○	○	○
pod 'EasyDarkMode/Core-Swift'	○	●	●	○	○	○
pod 'EasyDarkMode/SDWebImage'	●	○	●	●	○	○
pod 'EasyDarkMode/SDWebImage+Swift'	○	●	●	●	○	○
pod 'EasyDarkMode/Kingfisher'	○	●	●	○	●	○
pod 'EasyDarkMode/Remote'	●	○	●	○	○	●
pod 'EasyDarkMode/Remote-Swift'	○	●	●	○	○	●

How to use

Create color with different user interface

• Swift

Included in pod 'EasyDarkMode/Core-Swift'

import EasyDarkMode

view.backgroundColor = UIColor.dm.color(white:UIColor.black , dark: UIColor.white)

• Objective-C

Included in pod 'EasyDarkMode/Core'

#import <EasyDarkMode/EasyDarkMode.h>

view.backgroundColor = [UIColor dm_colorWithColorLight:UIColor.grayColor dark:UIColor.whiteColor];

Create image from local with different user interface

• Swift

Included in pod 'EasyDarkMode/Core-Swift'

import EasyDarkMode

imageView.image = UIImage.dm.image(name: "check_light", dark: "check_dark")

• Objective-C

Included in pod 'EasyDarkMode/Core'

#import <EasyDarkMode/EasyDarkMode.h>

imageView.image = [UIImage dm_imageWithNameLight:@"check_light" dark:@""check_dark""];

Create image from SDWebImage with different user interface

• Swift

Included in pod 'EasyDarkMode/SDWebImage+Swift'

import EasyDarkMode
// You should config downloder once before start to download images.
DMDownloadManager.shared.connectWithSdWebImage()
// ...
item.dm.setImage(pathString: "http://img.mp.itc.cn/upload/20160525/73e975795bf94f82baf43315f89a30b1_th.jpg", dark: "http://img.mp.itc.cn/upload/20160525/5d6588b3c928495a9ee0eb2b0b672936_th.jpg", for: UIControl.State.normal)

• Objective-C

Included in pod 'EasyDarkMode/SDWebImage'

#import <EasyDarkMode/EasyDrakMode.h>
// You should config downloder once before start to download images.
[DMDownloadManager.shared connectWithSdWebImage];
// ...
[button dm_setImagePathStringLight:@"http://img.mp.itc.cn/upload/20160525/73e975795bf94f82baf43315f89a30b1_th.jpg" dark:@"http://img.mp.itc.cn/upload/20160525/5d6588b3c928495a9ee0eb2b0b672936_th.jpg" forState:UIControlStateNnormal];

Create image from Kingfisher with different user interface

• Swift

Included in pod 'EasyDarkMode/Kingfisher'

import EasyDarkMode
// You should config downloder once before start to download images.
DMDownloadManager.shared.connectWithKingfisher()
// ...
item.dm.setImage(pathString: "http://img.mp.itc.cn/upload/20160525/73e975795bf94f82baf43315f89a30b1_th.jpg", dark: "http://img.mp.itc.cn/upload/20160525/5d6588b3c928495a9ee0eb2b0b672936_th.jpg", for: UIControl.State.normal)

Create image from custom download method with different user interface

• Swift

Included in pod 'EasyDarkMode/Remote-Swift'

import EasyDarkMode
// You should config downloder once before start to download images.
DMDownloadManager.shared.downloader = { (url, completion) in
    // ...
}
// ...
item.dm.setImage(pathString: "http://img.mp.itc.cn/upload/20160525/73e975795bf94f82baf43315f89a30b1_th.jpg", dark: "http://img.mp.itc.cn/upload/20160525/5d6588b3c928495a9ee0eb2b0b672936_th.jpg", for: UIControl.State.normal)

• Objective-C

Included in pod 'EasyDarkMode/Remote'

#import <EasyDarkMode/EasyDrakMode.h>
// You should config downloder once before start to download images.
DMDownloadManager.shared.downloader = ^(NSURL * _Nonnull data, DMDownloadHandler  _Nonnull completion) {
    // ...
}
// ...
[button dm_setImagePathStringLight:@"http://img.mp.itc.cn/upload/20160525/73e975795bf94f82baf43315f89a30b1_th.jpg" dark:@"http://img.mp.itc.cn/upload/20160525/5d6588b3c928495a9ee0eb2b0b672936_th.jpg" forState:UIControlStateNnormal];

Features

• Shortcut method to create UIColor with different user interface type.

• Shortcut method to create UIImage with different user interface type.

• Written in Objective-C. All functions available in Swift with modern APIs.

• Shortcut method to download remoate image with SDWebImage and Kingfisher and create UIImage with different user interface type.

• This code can work on from Xcode 9 to Xcode 11.

• It has an various deployment target version from iOS 8 to iOS 13.

• We found that enable appearence image set in xcassets leads to dramatic lagging in application startup. Some walkaround like combine images into one UIImage object manually is necessory, if you are working with a giant application.

TODO

[●] Support UIImage/UIColor

[●] Support SDWebImage

[●] Support KingFisher.

[○] Find a way to support NSTextAttachment in NSAttributedString.

[○] Find a way to support web image for NSTextAttachment.

easydarkmode's Issues

Kingfisher deployment target

Hi, would be nice to update to the latest Kingfisher, if possible

EasyDarkMode has
s.platform = :ios, "8.0"
but latests Kingfisher
s.ios.deployment_target = "10.0"

and connectWithKingfisher method will be needed to update.
Thanks :)

如果用户主动在APP内选择暗黑模式，但是系统却是亮色，支持吗？

如果用户主动在APP内选择暗黑模式，但是系统却是亮色，支持吗？

丢失UIImage对象的scale属性

UITraitCollection *lightCollection = [UITraitCollection traitCollectionWithUserInterfaceStyle:UIUserInterfaceStyleLight];
UITraitCollection *darkCollection = [UITraitCollection traitCollectionWithUserInterfaceStyle:UIUserInterfaceStyleDark];
UITraitCollection *unspecified = [UITraitCollection traitCollectionWithUserInterfaceStyle:UIUserInterfaceStyleUnspecified];
UIImage *image = UIImage.new;
[image.imageAsset registerImage:light withTraitCollection:lightCollection];
[image.imageAsset registerImage:dark withTraitCollection:darkCollection];
UIImage *newImage = [[image.imageAsset imageWithTraitCollection:unspecified] copy];
[newImage.imageAsset registerImage:[image.imageAsset imageWithTraitCollection:lightCollection] withTraitCollection:lightCollection];
[newImage.imageAsset registerImage:[image.imageAsset imageWithTraitCollection:darkCollection] withTraitCollection:darkCollection];

这种方式会丢失UIImage对象的scale属性使获取图片的size出现问题，使用UITraitCollection对象前应该先与当前的[UITraitCollection currentTraitCollection]进行一次合并。

UITraitCollection *const scaleTraitCollection = [UITraitCollection currentTraitCollection];

UITraitCollection *const lightUnscaledTraitCollection = [UITraitCollection traitCollectionWithUserInterfaceStyle:UIUserInterfaceStyleLight];
UITraitCollection *const darkUnscaledTraitCollection = [UITraitCollection traitCollectionWithUserInterfaceStyle:UIUserInterfaceStyleDark];
    
UITraitCollection *const lightScaledTraitCollection = [UITraitCollection traitCollectionWithTraitsFromCollections:@[scaleTraitCollection, lightUnscaledTraitCollection]];
UITraitCollection *const darkScaledTraitCollection = [UITraitCollection traitCollectionWithTraitsFromCollections:@[scaleTraitCollection, darkUnscaledTraitCollection]];

reference：
programmatic-dynamic-images

在系统深色浅色模式切换后，UIColor可以根据colorWithDynamicProvider回调重新执行，已经加载过的图片如何刷新啊？

请问如何在ios13以下去监听黑暗模式的状态发生了变化

我在ios9测试机上设置了一个切换模式的按钮，但是发现并没有改变模式的颜色，所以是不是有监听的方法我自定义去改变

图片的暗黑处理还是出不来, 依然是light模式下的图片填充