Skip to content

Latest commit

 

History

History
141 lines (92 loc) · 5.55 KB

README.md

File metadata and controls

141 lines (92 loc) · 5.55 KB
Raw

UIStyleKit - Enhanced UIKit for managing fonts and colours

iOS Storyboard (or Interface Builder) is an effective way of developing UI for the apps. Storyboard provides ways to change colour and fonts of UIComponents. Wow, thats really wonderful.

But since the font and colour of each component is hardcoded in storyboard, its really time consuming and a tedious job to change the font or colour schema through out the app.

Say about 50 screens of the app were build using the following

Font - Roboto

Color Schema - #387ef5#ffc900#444444

And now the font and colour schema changes as follows:

Font - Palatino

Color Schema - #ef473a#33cd5f#444444

Now you have to go revisit all the 50 screens on the Storyboard and change the font and colour of each component. This sounds really a shit job to be done. And also this isn't done. What if they want to revert back at a later point (Versioning helps but you are dealing with Storyboard, so forget about it).

You could make use of UIAppearance. For example you could change the font and color of a button using UIAppearance, but this will change all the buttons unless overridden (But for overridden button this again seems like the above problem).

Wouldn't it be great if we could still set these properties in storyboard but changing the font or theme doesnt need to change in storyboard. Sound's real needy right. Yeah, so thats what this library does.

Example

  • Clone the repo
  • run pod install from the Example directory
  • Open UIStyleKit.xcworkspace and run the app on Simulator or device

Installation

UIStyleKit is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "UIStyleKit"

Usage

Configure the colours and fonts you would be using in the app in the appdelegate as shown in below example

SKUITheme.appearance().fonts = ["Regular": "Roboto-Light",
                                "Italic": "Palatino-Italic",
                                "Bold": "Palatino-Bold",
                                "BoldItalic": "Roboto-BoldItalic"]
        
SKUITheme.appearance().colors = ["positive" : UIColor(rgb: 0x387ef5),
                                 "balanced" : UIColor(rgb: 0x33cd5f),
                                 "energized" : UIColor(rgb: 0xffc900),
                                 "assertive" : UIColor(rgb: 0xef473a),
                                 "white" : UIColor.white]

If you are adding custom fonts to the app, make sure you mention them in your apps info.plist as shown below

Moving forward, go to the desired Storyboard, select the component (label for example) and in the Identity inspector set the custom class to SKUILabel and module to UIStyleKit

Now in the Attribute Inspector you should find new attributes to be configured. Configure them with the keys you mentioned in the SKUITheme appearance defined in app delegate. (Find example in below image).

You will find that the changes are not reflecting in the StoryBoard, this is because Theme appearance is set in the app delegate and would be available only while the app is running.

Figuring out a way to make this Theme appearance available for story board. Will update the library once a better way is available.

Documentation

SKUIView

  • bgColorType: String?
    nil value will set the one picked from color picker in Storyboard

SKUILabel

  • fontType: String?
    nil value will set the one picked from font picker in Storyboard

  • fontSize: CGFloat default = 16
    will not effect if fontType is nil

  • colorType: String?
    nil value will set the one picked from color picker in Storyboard

SKUIButton

  • fontType: String?
    nil value will set the one picked from font picker in Storyboard

  • fontSize: CGFloat default = 16
    will not effect if fontType is nil

  • colorType: String?
    nil value will set the one picked from color picker in Storyboard

  • bgColorType: String?
    nil value will set UIColor.clear for backgroundColor

  • borderColorType: String?
    nil value will set UIColor.clear for borderColor

  • borderWidth: CGFloat default = 0

  • cornerRadius: CGFloat default = 0

SKUITextField

  • fontType: String?
    nil value will set the one picked from font picker in Storyboard

  • fontSize: CGFloat default = 16
    will not effect if fontType is nil

  • colorType: String?
    nil value will set the one picked from color picker in Storyboard

  • borderColorType: String?
    nil value will set UIColor.clear for borderColor

  • borderWidth: CGFloat default = 0

  • cornerRadius: CGFloat default = 0

SKUISegmentedControl

  • fontSize: CGFloat default = 16
    will not effect if fontType is nil

  • normalFontType: String?
    nil value will set system font with size fontSize

  • highlightedFontType: String?
    nil value will take normalFontType

  • selectedFontType: String?
    nil value will take normalFontType

  • disabledFontType: String?
    nil value will take normalFontType

Author

srinivasan.munna@gmail.com

License

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