https://github.com/mirego/ember-cli-pod-translations

An addon to compile your locale files inside pods.
https://github.com/mirego/ember-cli-pod-translations

ember ember-addon ember-cli emberjs i18n pods

Last synced: 6 days ago
JSON representation

An addon to compile your locale files inside pods.

• Host: GitHub
• URL: https://github.com/mirego/ember-cli-pod-translations
• Owner: mirego
• License: bsd-3-clause
• Created: 2017-05-24T16:00:07.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-08-14T13:37:31.000Z (over 7 years ago)
• Last Synced: 2024-10-31T17:45:06.517Z (16 days ago)
• Topics: ember, ember-addon, ember-cli, emberjs, i18n, pods
• Language: JavaScript
• Size: 75.2 KB
• Stars: 2
• Watchers: 44
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ember-cli-pod-translations

[![Build Status](https://travis-ci.org/mirego/ember-cli-pod-translations.svg?branch=master)](https://travis-ci.org/mirego/ember-cli-pod-translations)

An addon to compile your locale files inside pods.

## Installation

```shell

$ ember install ember-cli-pod-translations

```

## Usage

1. __Create translation files for your components, controllers or routes__

	For example, we could create an english file `app/pods/components/x-foo/translations.en.json`

	```json

	{

	  "hello_world": "Hello World"

	}

	```

	Then a french file `app/pods/components/x-foo/translations.fr.json`:

	```json

	{

	  "hello_world": "Bonjour le monde"

	}

	```

2. __Extend your component, controller or route with the `Localizable` mixin__

	*NOTE: This is required for both the JS and template usage*

	```js

	// app/pods/components/x-foo/component.js

	import Ember from 'ember';

	import Localizable from 'ember-cli-pod-translations/mixins/localizable';

	import translations from './translations';

	export default Ember.Component.extend(Localizable(translations));

	```

3. __Use your translations in your Ember object__

	```js

	// app/pods/components/x-foo/component.js

	import Ember from 'ember';

	import Localizable from 'ember-cli-pod-translations/mixins/localizable';

	import translations from './translations';

	export default Ember.Component.extend(Localizable(translations), {

	  helloString: computed(function() {

	    return this.localTranslation('hello_world');

	  })

	});

	```

4. __Use your translations in your template__

	```hbs

	{{!-- app/pods/components/x-foo/template.hbs --}}

	{{local-t localizablePrefix 'hello_world'}}

	You can also use a "raw" translation which is not wrapped in a SafeString for ember-moment for example:

	{{moment-format date (local-t-raw localizablePrefix 'date_format')}}

	```

## Contributing

```shell

$ git clone https://github.com/mirego/ember-cli-pod-translations

$ cd ember-cli-pod-translations

$ yarn install

```

## Running the dummy app

```shell

$ ember serve

```

Visit your app at [http://localhost:4200](http://localhost:4200).

## Running tests

```shell

$ npm test # Runs `ember try:each` to test the addon against multiple Ember versions

$ ember test

$ ember test --server

```

## Building

```shell

$ ember build

```

For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).

## License

`ember-cli-pod-translations` is © 2017 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).

See the [`LICENSE.md`](https://github.com/mirego/ember-cli-pod-translations/blob/master/LICENSE.md) file.

## About Mirego

[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).

We also [love open-source software](http://open.mirego.com) and we try to give back to the community as much as we can.