Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/marmelroy/Localize-Swift

Swift friendly localization and i18n with in-app language switching
https://github.com/marmelroy/Localize-Swift

Last synced: about 1 month ago
JSON representation

Swift friendly localization and i18n with in-app language switching

Awesome Lists containing this project

README 

        
[![Platform](https://img.shields.io/cocoapods/p/Localize-Swift.svg?maxAge=2592000)](http://cocoapods.org/?q=Localize-Swift)

[![Version](http://img.shields.io/cocoapods/v/Localize-Swift.svg)](http://cocoapods.org/?q=Localize-Swift)

[![Build Status](https://travis-ci.org/marmelroy/Localize-Swift.svg?branch=master)](https://travis-ci.org/marmelroy/Localize-Swift)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)



# Localize-Swift

Localize-Swift is a simple framework that improves i18n and localization in Swift iOS apps - providing cleaner syntax and in-app language switching.






## Features



- Keep the Localizable.strings file your app already uses.

- Allow your users to change the app's language without changing their device language.

- Use .localized() instead of NSLocalizedString(key,comment) - a more Swifty syntax.

- Generate your strings with a new genstrings swift/python script that recognises .localized().



## Usage



Import Localize at the top of each Swift file that will contain localized text.



If CocoaPods -

```swift

import Localize_Swift

```



Add `.localized()` following any `String` object you want translated:

```swift

textLabel.text = "Hello World".localized()

```



To get an array of available localizations:

```swift

Localize.availableLanguages()

```



To change the current language:

```swift

Localize.setCurrentLanguage("fr")

```



To update the UI in the view controller where a language change can take place, observe LCLLanguageChangeNotification:

```swift

NotificationCenter.default.addObserver(self, selector: #selector(setText), name: NSNotification.Name(LCLLanguageChangeNotification), object: nil)

```



To reset back to the default app language:

```swift

Localize.resetCurrentLanguageToDefault()

```



## genstrings



To support this new i18n syntax, Localize-Swift includes custom genstrings swift script.



Copy the genstrings.swift file into your project's root folder and run with



```bash

./genstrings.swift

```



This will print the collected strings in the terminal. Select and copy to your default Localizable.strings.



The script includes the ability to specify excluded directories and files (by editing the script).



### [Preferrred] Setting up with [Swift Package Manager](https://swiftpm.co/?query=Localize-Swift)



The [Swift Package Manager](https://swift.org/package-manager/) is now the preferred tool for distributing Localize-Swift. 



From Xcode 11+ :



1. Select File > Swift Packages > Add Package Dependency. Enter `https://github.com/marmelroy/Localize-Swift.git` in the "Choose Package Repository" dialog.

2. In the next page, specify the version resolving rule as "Up to Next Major" with "3.2.0".

3. After Xcode checked out the source and resolving the version, you can choose the "Localize-Swift" library and add it to your app target.



For more info, read [Adding Package Dependencies to Your App](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app) from Apple.



Alternatively, you can also add Localize-Swift to your `Package.swift` file:



```swift

dependencies: [

    .package(url: "https://github.com/marmelroy/Localize-Swift.git", .upToNextMajor(from: "3.2.0"))

]

```



### Setting up with Carthage



[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.



You can install Carthage with [Homebrew](http://brew.sh/) using the following command:



```bash

$ brew update

$ brew install carthage

```



To integrate Localize-Swift into your Xcode project using Carthage, specify it in your `Cartfile`:



```ogdl

github "marmelroy/Localize-Swift"

```



### Setting up with [CocoaPods](http://cocoapods.org/?q=Localize-Swift)

```ruby

source 'https://github.com/CocoaPods/Specs.git'

pod 'Localize-Swift', '~> 3.2'

```