Latest 1.1
Homepage https://github.com/Kekiiwaa/JsonLocalizable
License MIT
Platforms ios 8.0
Authors

Localize

Carthage compatible
CocoaPods
Build Status

Localize is a framework writed in swift to localize your projects easier, including storyboards and strings.

Localize Storyboard


Features

  • [x] Localize your strings
  • [x] Localize your Storyboards without extra files
  • [x] Localize your UIView components without xcode UIView ids
  • [x] Localize your UIView components only with keys
  • [x] Localize your UIView components with classes
  • [x] Update your current language and update all view components
  • [x] Update your current language and receive notification

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 Localize 1.0+.

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

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

target '<Your Target Name>' do
    pod 'Localize' , '~> 1.2.0'
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 Localize into your Xcode project using Carthage, specify it in your Cartfile:

github "Kekiiwaa/Localize"

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

Swift Pacakge Manager

The Swift Pacakage Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding Localize as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .Package(url: "https://github.com/Kekiiwaa/Localize.git")
]

Usage

Config

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

// AppDelegate.swift

import Localize

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

    let localize = Localize.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())
    // List of aviable languajes
    print(localize.availableLanguages())

    // Or you can use static methods for all.

    Localize.update(fileName: "lang")
    Localize.update(defaultLanguage: .french)
    Localize.update(language: .english)

    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

Localize use % identifier to replace the text


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

// Hello everyone!

Localize strings, replacing many texts

Localize 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

Localize use :yourid to search your id in JSON File


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

// My username is Localize

Localize your storyboard with extensions

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

  • lang-en.json
{
    "navigation" : {
        "title" : "Localize"
    },
    "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."
    }
}

Localize Storyboard

This is the result in your simulator

Localize Simulator

You can use extensions for

  • UIBarButtonItem
  • UIButton
  • UILabel
  • UINavigationItem
  • UISearchBar
  • UISegmentedControl
  • UITabBarItem
  • UITextField
  • UITextView

Localize your storyboard with classes

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

  • lang-en.json
{
    "navigation" : {
        "title" : "Localize"
    },
    "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."
    }
}

Localize Storyboard

This is the result in your simulator

Localize Simulator

You can use this classes

  • LocalizeBarButtonItem
  • LocalizeButton
  • LocalizeLabel
  • LocalizeNavigationBarItem
  • LocalizeSearchBar
  • LocalizeSegmentedControler
  • LocalizeBarItem
  • LocalizeTextField
  • LocalizeTextView

Updating language

When you change a language, automatically all views update your content to new language


Localize.update(language: .french)

But with strings not is posible, for that your need implement a notification


override func viewDidLoad() {
    super.viewDidLoad()
    NotificationCenter.default.addObserver(self, selector: #selector(localize), name: NSNotification.Name(LanguageChangeNotification), object: nil)   
}

public func localize() {
    yourLabel.text = "app.names".localize(values: "mark", "henrry", "peater")
    otherLabel.text = "app.username".localize(value: "Your username")
}

Implementing internal acction to change a language


@IBAction func updateLanguage(_ sender: Any) {
    let actionSheet = UIAlertController(title: nil, message: "app.update.language".localize(), preferredStyle: UIAlertControllerStyle.actionSheet)
    for language in Localize.availableLanguages() {
        let displayName = Localize.displayNameForLanguage(language)
        let languageAction = UIAlertAction(title: displayName, style: .default, handler: {
            (alert: UIAlertAction!) -> Void in
            Localize.update(language: language)
            })
        actionSheet.addAction(languageAction)
    }
    let cancelAction = UIAlertAction(title: "Cancel", style: UIAlertActionStyle.cancel, handler: {
        (alert: UIAlertAction) -> Void in
        })
    actionSheet.addAction(cancelAction)
    self.present(actionSheet, animated: true, completion: nil)
}

Credits

Kekiiwaa,
Andres Silva Gomez,
Andres Felipe Montoya

License

Localize is released under the MIT license. See LICENSE for details.

Latest podspec

{
    "name": "JsonLocalizable",
    "version": "1.1",
    "license": "MIT",
    "summary": "Localize strings and UI elements in different languages based in JSON file.",
    "homepage": "https://github.com/Kekiiwaa/JsonLocalizable",
    "authors": {
        "Kekiiwaa": "[email protected]"
    },
    "source": {
        "git": "https://github.com/Kekiiwaa/JsonLocalizable.git",
        "tag": "1.1"
    },
    "platforms": {
        "ios": "8.0"
    },
    "source_files": "Source/*.swift",
    "pushed_with_swift_version": "3.0"
}

Pin It on Pinterest

Share This