niggeulimann/swiftforall

A Zeplin extension generating Swift code on all projects.

Swift for all

A Zeplin's extension

Zeplin's built-in Swift extension is very useful, but is only available on Swift projects.

You are an Swift developer and you are working on an app which is only available in Zeplin as an Android project. Or maybe you just want to export the color palette of this beautiful web project to use in your code?

Swift for all gives you access to Swift code on all Zeplin projects! Whether it is a web, iOS, Android or macOS project, Swift for all won't let you down.

Getting Stated

1. Go to https://extensions.zeplin.io/5c23c811a493040a8ba65679
2. Click on "Add to Zeplin"

Usage

Swift for all currently only generates Swift code for your project's styleguide. Snippets are not available when selecting layers in a screen.

Preliminary note: All following examples use UIKit. Please be aware that despite this, Swift for all supports macOS projects, hence AppKit. With the UI framework used in snippets option, you can choose which framework is used in snippets. Its default behavior is to use AppKit on macOS projects, and UIKit on all others. However, in exported files the import statement checks the compilation platform to automatically use one or the other.

Colors

All colors are defined in a struct in UIColor. By default the struct is named from the project but you can override it with the Override color structure name option.

extension UIColor {
  struct MyProject {
    static let blue1 = UIColor(red: 68/255.0, green: 104/255.0, blue: 234/255.0, alpha: 1)
    static let blue2 = UIColor(red: 0/255.0, green: 36/255.0, blue: 166/255.0, alpha: 1)
    static let pink = UIColor(red: 255/255.0, green: 48/255.0, blue: 97/255.0, alpha: 1)
    static let black = UIColor(red: 0/255.0, green: 0/255.0, blue: 0/255.0, alpha: 1)
    static let grey = UIColor(red: 102/255.0, green: 102/255.0, blue: 102/255.0, alpha: 1)
    static let red = UIColor(red: 227/255.0, green: 0/255.0, blue: 36/255.0, alpha: 1)
  }
}

view.backgroundColor = UIColor.MyProject.pink

With the option Color format declaration you can use different color formatting:

//RGB (iOS & macOS default)
static let blue1 = UIColor(red: 68/255.0, green: 104/255.0, blue: 234/255.0, alpha: 1)

//Hex RGBA (like web)
static let blue1 = UIColor(rgbaValue:0x4468eaff)

//Hex ARGB (like Android)
static let blue1 = UIColor(argbValue:0xff4468ea)

Please note that the convenience UIColor hex init code doesn't appear in the snippet to keep it clean, but is actually included in the file if you export colors.

Text styles

Unlike the original Swift extension which only generate code for fonts, Swift for all generates the actuel text style by using all available parameters: font, font size, line height, text color, letter spacing, etc.

Text styles are listed in a TextStyle enum, and all attributes are handled with NSAttributedString attributes:

enum TextStyle {
  case title
  case subtitle
  case body
}

extension TextStyle {
  var attributes: [NSAttributedString.Key: Any] {
    switch self {
    case .title:
      let paragraphStyle = NSMutableParagraphStyle()
      paragraphStyle.alignment = .center
      paragraphStyle.minimumLineHeight = 28.2
      return [.font: UIFont.systemFont(ofSize: 22, weight: .bold),
              .paragraphStyle: paragraphStyle,
              .foregroundColor: UIColor.MyProject.blue1]

    case .subtitle:
      let paragraphStyle = NSMutableParagraphStyle()
      paragraphStyle.alignment = .center
      paragraphStyle.minimumLineHeight = 24
      return [.font: UIFont(name: "Canaro-Bold", size: 18),
              .paragraphStyle: paragraphStyle,
              .foregroundColor: UIColor(red: 48/255.0, green: 45/255.0, blue: 112/255.0, alpha: 1)]

    case .body:
      return [.font: UIFont(name: "Roboto-Medium", size: 13)]
    }
  }
}


label.attributedText = NSAttributedString(string: "Hello world", attributes: TextStyle.title.attributes)

When exporting the textStyles in a file, Swift for all also includes an utility function to shorten textStyle usages. The above code can then become:

label.attributedText = "hello world".styled(as: .title)

Did you notice ? title and subtitle styles both declare a text color, but it is not equally formatted. That is because the color used by the title style is actually in the project's color palette so we can directly get it from there. In the other hand, the subtitle text color is not in the palette and is hence declared here.

You can also choose the way font are used in attributes from the extension's parameters. By default the classic built-in UIKit initialiser is used:

case .body:
  return [.font: UIFont(name: "Roboto-Medium", size: 13)]

But you may already use a tool like SwiftGen to avoid relying on String in your project. If do you, select the SwiftGen option and you will get this:

case .body:
  return [.font: FontFamily.Roboto.medium.font(size: 13)]

Layers

When selecting a text layer, Swift for All provides you the NSAttributedString using the layer's text and the layer's text style.

let paragraphStyle = NSMutableParagraphStyle()
paragraphStyle.alignment = .center
paragraphStyle.minimumLineHeight = 24.91753016590529
let attributes = [.font: UIFont(name: "Roboto-Bold", size: 18) as Any,
                  .paragraphStyle: paragraphStyle,
                  .foregroundColor: UIColor(argbValue:0xffffffff)]
let attrString = NSAttributedString(string:"Hello world!", attributes: attributes)

Note: At the moment, Swift for all does not support multiple text styles on a layer. If your layer does use multiple text styles, only the first one will be used to generate the snippet.

What's next ?

Here is a non-exhaustive list of future features to come:

• Add the possibility to use NSAttributedString.Key.lineSpacing instead of NSAttributedString.Key.minimumLineHeight
• Select the Swift version as with the original Swift extension

License

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