JsonLocalizable

JsonLocalizable is a framework to localize your projects easier, including storyboards and strings.

Features
Requirements
Installation
Credits
License

Features

Localize your strings
Localize your Storyboards without extra files
Localize your UIView components without ids
Localize your UIView components only with keys
Localize your UIView components with classes

Requirements

iOS 8.0+
Xcode 8.0+
Swift 3.0+

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

CocoaPods 1.1.0+ is required to build JsonLocalizable 0.5+.

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

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'JsonLocalizable'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate JsonLocalizable into your Xcode project using Carthage, specify it in your Cartfile:

github "CityTaxi/JsonLocalizable"

Run carthage update to build the framework and drag the built JsonLocalizable.framework into your Xcode project.

Usage

Config

This not is necesary, only if you need diferent results.

// AppDelegate.swift

import JsonLocalizable

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    let localize = Localizable.shared
    // Set your file name
    localize.fileName = "myFileName"
    // Set your default languaje.
    localize.defaultLanguage = .french
    // If you want change a user language different to default in device, use this method.
    localize.update(language: .english)
    // If you want remove storaged languaje, use
    localize.resetLanguage()
    // The used language that you configured to localize
    print(localize.language())
    
    return true
}

Create your json file

Please create a JSON file in your code with this rule:

{your file name}-{your lang code}.json

For example

lang-en.json
lang-es.json
lang-fr.json

Example JSON File

{
    "hello" : {
        "world" : "Hello world!",
        "name" : "Hello %!"
    },
    "values" : "Hello % we are %, see you soon",
    "username" : "My username is :username",
    "navigation.title" : ""
}

Localize strings

print( "hello.world".localize() )

// Hello world!

Localize strings, replacing text

JsonLocalizable use % identifier to replace the text

print( "hello.name".localize(value: "everyone") )

// Hello everyone!

Localize strings, replacing many texts

JsonLocalizable use % identifier to replace the text

print( "values".localize(values: "everyone", "Software Developer") )

// Hello everyone we are Software Developer, see you soon

Localize strings, replacing dictionary values

JsonLocalizable use :yourid to search your id in JSON File

print( "username".localize(dictionary: ["username": "JsonLocalizable"]) )

// My username is JsonLocalizable

Localize your storyboard with extensions

You don't need import anything in your code, JsonLocalizable use extensions to localize your UIView components

// This is lang-en.json
{
    "navigation" : {
        "title" : "JsonLocalizable"
    },
    "app" : {
        "label" : "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium.",
        "textfield" : "Write some here."
    }
}

This is the result in your simulator

You can use extensions for

UIBarButtonItem
UIButton
UILabel
UINavigationItem
UISearchBar
UISegmentedControl
UITabBarItem
UITextField
UITextView

Localize your storyboard with classes