Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elenionl/easydarkmode

This is a tool for developers to easily adapt dark mode in iOS 13.
https://github.com/elenionl/easydarkmode

dark-mode dark-theme darkmode darkmode-ios13 ios13 objective-c uitraitcollection

Last synced: 3 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/elenionl/easydarkmode
Owner: Elenionl
License: mit
Created: 2019-08-13T18:44:27.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2021-06-28T10:08:59.000Z (over 3 years ago)
Last Synced: 2024-10-19T19:32:12.021Z (4 months ago)
Topics: dark-mode, dark-theme, darkmode, darkmode-ios13, ios13, objective-c, uitraitcollection
Language: Objective-C
Homepage:
Size: 1.67 MB
Stars: 153
Watchers: 4
Forks: 16
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # EasyDarkMode

![version](https://img.shields.io/cocoapods/v/EasyDarkMode)

![license](https://img.shields.io/github/license/Elenionl/EasyDarkMode)

![platform](https://img.shields.io/cocoapods/p/EasyDarkMode)

![Swfit](https://img.shields.io/badge/Swfit-●-orange)

![Objective-C](https://img.shields.io/badge/Objective--C-●-blue)

## 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

![video](https://raw.githubusercontent.com/Elenionl/EasyDarkMode/master/Sample/demo.mov?token=AD5OKW6SDH6NR7ZNXDIYRDK5MKS7U)

![light](https://github.com/Elenionl/EasyDarkMode/blob/master/Sample/image_light.png?raw=true)

![dark](https://github.com/Elenionl/EasyDarkMode/blob/master/Sample/image_dark.png?raw=true)

## Integrate with [Cocoapods](https://cocoapods.org)

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'`

``` Swift

import EasyDarkMode

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

```

* Objective-C

Included in pod `'EasyDarkMode/Core'`

``` Objective-C

#import 

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'`

``` Swift

import EasyDarkMode

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

```

* Objective-C

Included in pod `'EasyDarkMode/Core'`

``` Objective-C

#import 

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'`

``` 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'`

``` Objective-C

#import 

// 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'`

``` Swift

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'`

``` 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'`

``` Objective-C

#import 

// 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.