Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/draveness/DKNightVersion

Manage Colors, Integrate Night/Multiple Themes. (Unmaintained)
https://github.com/draveness/DKNightVersion

cocoapods colors dknightversion mode night-mode objective-c theme

Last synced: about 1 month ago
JSON representation

Manage Colors, Integrate Night/Multiple Themes. (Unmaintained)

Awesome Lists containing this project

README 

        

![](./images/Banner.png)




















- [x] Easily integrate and high performance

- [x] Providing UIKit and CoreAnimation category

- [x] Read colour customisation from file

- [x] Support different themes

- [x] Generate picker for other libs with one line macro



# Demo





  




----



+ [Installation with CocoaPods](#Installation-with-CocoaPods)

    + [Podfile](#podfile)

    + [Import](#import)

+ [Usage](#usage)

+ [Advanced Usage](#advanced-usage)

    + [DKNightVersionManger](#dknightversionmanager)

        + [Change Theme](#change-theme)

        + [Post Notification](#post-notification)

    + [DKColorPicker](#dkColorpicker)

    + [DKColorTable](#dkcolortable)

    + [pickerify](#pickerify)

    + [Create temporary DKColorPicker](#create-temporary-dkcolorpicker)

    + [DKImagePicker](#dkimagepicker)



> If you want to implement night mode in Swift project without import Objective-C code. [NightNight](https://github.com/Draveness/NightNight)

 is the Swift version which does the same work.



# How To Get Started



DKNightVersion supports multiple methods for installing the library in a project.



## Installation with CocoaPods



[CocoaPods](https://cocoapods.org/) is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries like DKNightVersion in your projects. See the [Get Started section](https://cocoapods.org/#get_started) for more details.



### Podfile



To integrate DKNightVersion into your Xcode project using CocoaPods, specify it in your `Podfile`:



```shell

pod "DKNightVersion"

```



Then, run the following command:



```shell

$ pod install

```



### Import



Import DKNightVersion header file



```objectivec

#import 

```



## Usage



Checkout `DKColorTable.txt` file in your project, which locates in `Pods/DKNightVersion/Resources/DKNightVersion.txt`.

```

NORMAL   NIGHT

#ffffff  #343434 BG

#aaaaaa  #313131 SEP

```



> You can also create another colour table file, and specify it with [DKColorTable](#dkcolortable).



A, set color picker like this with `DKColorPickerWithKey`, which generates a DKColorPicker block



```objectivec

self.view.dk_backgroundColorPicker = DKColorPickerWithKey(BG);

```



After the current theme version change to `DKThemeVersionNight`, the view background colour would switch to `#343434`.



```objectivec

[DKNightVersionManager nightFalling];

``` 



Alternatively, you could change the theme version by manager's property `themeVersion` which is a string



```objectivec

DKNightVersionManager *manager = [DKNightVersionManager sharedInstance];

manager.themeVersion = DKThemeVersionNormal;

```



## Advanced Usage



There are two approaches you can use to integrate night mode to your iOS App.



### DKNightVersionManager



The latest version for DKNightVersion add a readonly `dk_manager` property for `NSObject` returns the `DKNightVersionManager` singleton.



#### Change Theme



You can call `nightFalling` or `dawnComing` to switch the current theme version to `DKThemeVersionNight` or `DKThemeVersionNormal`.



```objectivec

[self.dk_manager dawnComing];

[self.dk_manager nightFalling];

```



Modify `themeVersion` property to switch the theme version directly.



```objectivec

self.dk_manager.themeVersion = DKThemeVersionNormal;

self.dk_manager.themeVersion = DKThemeVersionNight;

// if there is a RED column in DKColorTable.txt (default) or in 

// other `file` if you customize `file` property for `DKColorTable`

self.dk_manager.themeVersion = @"RED"; 

```



#### Post Notification



Every time the current theme version changes, `DKNightVersionManager` would post a `DKNightVersionThemeChangingNotification`. If you want to do some customisation, you can observe this notification and react with proper actions.



### DKColorPicker



`DKColorPicker` is the core of DKNightVersion. And this lib adds dk_colorPicker to every UIKit and Core Animation components. Ex:



```objectivec

@property (nonatomic, copy, setter = dk_setBackgroundColorPicker:) DKColorPicker dk_backgroundColorPicker;

@property (nonatomic, copy, setter = dk_setTintColorPicker:) DKColorPicker dk_tintColorPicker;

```



DKColorPicker is defined in `DKColor.h` file receives a `DKThemeVersion` as the parameter and returns a `UIColor`.



```objectivec

typedef UIColor *(^DKColorPicker)(DKThemeVersion *themeVersion);

```



+ Use `DKColorPickerWithKey(key)` to obtain `DKColorPicker` from `DKColorTable`



    ```objectivec

    view.dk_backgroundColorPicker = DKColorPickerWithKey(BG);

    ```



+ Use `DKColorPickerWithRGB` to generate a `DKColorPicker`



    ```objectivec

    view.dk_backgroundColorPicker =  DKColorPickerWithRGB(0xffffff, 0x343434);

    ```



### DKColorTable



`DKColorTable` is a new feature in DKNightVersion which providing us with an elegant way to manage colour setting in a project. Use as follows:



There is a file called `DKColorTable.txt`



```

NORMAL   NIGHT

#ffffff  #343434 BG

#aaaaaa  #313131 SEP

```



The first line of this file indicated different themes. **NORMAL is required column**, and others are optional. So if you don't need to integrate different themes in your app, leave the first column in this file, like this:



```

NORMAL

#ffffff BG

#aaaaaa SEP

```



`NORMAL` and `NIGHT` are two different themes, `NORMAL` is the default and for normal mode. `NIGHT` is optional and for night mode.



You can add multiple columns in this `DKColorTable.txt` file as many as you want.



```

NORMAL   NIGHT    RED

#ffffff  #343434  #ff0000 BG

#aaaaaa  #313131  #ff0000 SEP

```



The last column is the key for a colour entry, DKNightVersion uses the current `themeVersion` (ex: `NORMAL` `NIGHT` and `RED`) and key (ex: `BG`, `SEP`) to find the corresponding colour in DKColorTable.



`DKColorTable` has a property `file`, it will loads the color setting in this `file` when `+ [DKColorTable sharedColorTable` is called. Default value of `file` is `DKColorTable.txt`.



```objectivec

@property (nonatomic, strong) NSString *file;

```



You can also add another file into your project and fill your colour setting in that file.



```

// color.txt

NORMAL   NIGHT

#ffffff  #343434 BG

```



Also, do not forget to change the `file` property of the colour table.



```objectivec

[DKColorTable sharedColorTable].file = @"color.txt"

```



The code above would reload colour setting from `color.txt` file.



### Create temporary DKColorPicker



If you'd want to create some temporary DKColorPicker, you can use these methods.



```objectivec

view.dk_backgroundColorPicker =  DKColorPickerWithRGB(0xffffff, 0x343434);

```



`DKColorPickerWithRGB` will return a DKColorPicker which set background color to `#ffffff` when current theme version is `DKThemeVersionNormal` and `#343434` when it is `DKThemeVersionNight`.



There are also some similar functions like `DKColorPickerWithColors`



```objectivec

DKColorPicker DKColorPickerWithRGB(NSUInteger normal, ...);

DKColorPicker DKColorPickerWithColors(UIColor *normalColor, ...);

```



`DKColor` also provides a cluster of convenient `API` which returns `DKColorPicker` block, these blocks **return the same colour in different themes**.



```objectivec

+ (DKColorPicker)colorPickerWithUIColor:(UIColor *)color;



+ (DKColorPicker)colorPickerWithWhite:(CGFloat)white alpha:(CGFloat)alpha;

+ (DKColorPicker)colorPickerWithHue:(CGFloat)hue saturation:(CGFloat)saturation brightness:(CGFloat)brightness alpha:(CGFloat)alpha;

+ (DKColorPicker)colorPickerWithRed:(CGFloat)red green:(CGFloat)green blue:(CGFloat)blue alpha:(CGFloat)alpha;

+ (DKColorPicker)colorPickerWithCGColor:(CGColorRef)cgColor;

+ (DKColorPicker)colorPickerWithPatternImage:(UIImage *)image;

#if __has_include()

+ (DKColorPicker)colorPickerWithCIColor:(CIColor *)ciColor NS_AVAILABLE_IOS(5_0);

#endif



+ (DKColorPicker)blackColor;

+ (DKColorPicker)darkGrayColor;

+ (DKColorPicker)lightGrayColor;

+ (DKColorPicker)whiteColor;

+ (DKColorPicker)grayColor;

+ (DKColorPicker)redColor;

+ (DKColorPicker)greenColor;

+ (DKColorPicker)blueColor;

+ (DKColorPicker)cyanColor;

+ (DKColorPicker)yellowColor;

+ (DKColorPicker)magentaColor;

+ (DKColorPicker)orangeColor;

+ (DKColorPicker)purpleColor;

+ (DKColorPicker)brownColor;

+ (DKColorPicker)clearColor;

```



### pickerify



DKNightVersion provides a powerful feature which can generate dk_xxxColorPicker with a macro called `pickerify`.



```objectivec

@pickerify(TableViewCell, cellTintColor)

```



It automatically generates `dk_cellTintColorPicker` for you.



### DKImagePicker



Use `DKImagePicker` to change images when `manager.themeVersion` changes.



```objectivec

imageView.dk_imagePicker = DKImagePickerWithNames(@"normal", @"night");

```



The first argument passed into the function is used for `NORMAL` theme, and the second is used for `NIGHT` theme, the themes order is determined by the configuration in 

DKColorTable.txt file which is NORMAL and NIGHT.



If your file like this:



```

NORMAL   NIGHT    RED

#ffffff  #343434  #fafafa BG

#aaaaaa  #313131  #aaaaaa SEP

#0000ff  #ffffff  #fa0000 TINT

#000000  #ffffff  #000000 TEXT

#ffffff  #444444  #ffffff BAR

```



Set your image picker in this order:



```objectivec

imageView.dk_imagePicker = DKImagePickerWithNames(@"normal", @"night", @"red");

```



The order of images or names is the same in DKColorTable.txt file.



```objectivec

DKImagePicker DKImagePickerWithImages(UIImage *normalImage, ...);

DKImagePicker DKImagePickerWithNames(NSString *normalName, ...);

```



# Contribute



Feel free to open an issue or pull request, if you need help or there is a bug.



# Contact



- Powered by [Draveness](http://github.com/draveness)

- Personal website [Draveness](http://draveness.me)



# Todo



- Documentation



# License



DKNightVersion is available under the MIT license. See the LICENSE file for more info.



The MIT License (MIT)



Copyright (c) 2015 Draveness



Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.