Skip to content

Commit

Permalink
docs(basei18n): remove description for BaseI18N
Browse files Browse the repository at this point in the history
the original inheritance approach promoted with the BaseI18N class clearly doesn't fit in a modern development approach, as such we're removing related docs so that it isn't promoted any longer. The functionality is still kept in place for backward-compatibility and will be removed with the next major change.
  • Loading branch information
rluba authored and zewa666 committed Jun 29, 2018
1 parent 336b8c3 commit 493768b
Showing 1 changed file with 1 addition and 42 deletions.
43 changes: 1 addition & 42 deletions doc/article/en-US/i18n-with-aurelia.md
Original file line number Diff line number Diff line change
Expand Up @@ -485,48 +485,7 @@ Notice in the above example that the key was set to `home.title`. This will make
</source-code>
</code-listing>

Use `updateTranslation()` to update all translations within the children of the element that is passed to it.
The following example shows how a view model can be configured to update it's contents when the view is attached and every time a locale is changed.

<code-listing heading="Updating translations manually">
<source-code lang="ES 2015">
import {I18N} from 'aurelia-i18n';
import {EventAggregator} from 'aurelia-event-aggregator';

export class MyDemoVM {
static inject = [I18N,Element,EventAggregator];
constructor(i18n,element,ea) {
this.i18n = i18n;
this.element = element;

ea.subscribe('i18n:locale:changed', payload => {
this.i18n.updateTranslations(this.element);
});
}

attached(){
this.i18n.updateTranslations(this.element);
}
}
</source-code>
</code-listing>

Alternatively you may extend your VM with the provided Base-I18N-VM, which will set that up for you automatically.

<code-listing heading="Automatic locale changed subscription using the Base-I18N-VM">
<source-code lang="ES 2015">
import {BaseI18N} from 'aurelia-i18n';

export class MyDemoVM extends BaseI18N {

}
</source-code>
</code-listing>

> Info
> Just remember in case you define your own `constructor`, to call `this.super` and pass it the instances of its
dependencies as described in the previous example. Same applies to `attached`, although nothing needs to be passed
in here
Use `i18n.updateTranslations()` to update all translations within the children of the element that is passed to it.

#### Specifying attributes

Expand Down

0 comments on commit 493768b

Please sign in to comment.