Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added docs for exports option #75

Merged
merged 1 commit into from
Sep 12, 2015
Merged

Added docs for exports option #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions api.ru.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,23 +83,23 @@ module.exports = function(config) {

`i18n` — технология сборки, которая транслирует данные из `?.keysets.<lang>.js`-файлов в JavaScript.

Технология `i18n` инициализирует ядро `i18n` данными из объединенных keyset-файлов и возвращает функцию `BEM.i18n`, которую можно использовать из [шаблонов](/README.md#в-шаблонах) или [клиентского JavaScript](README.md#В-javascript).
Технология `i18n` инициализирует ядро `i18n` данными из объединенных keyset-файлов и возвращает функцию `i18n`, которую можно использовать из [шаблонов](/README.md#в-шаблонах) или [клиентского JavaScript](README.md#В-javascript).

>API функции `i18n` описан в разделе [API `i18n`](README.md#api-i18n).

### Опции

* [target](#target-1)
* [lang](#lang-1)
* [keysetsFile](#keysetsаile)
* [keysetsFile](#keysetsfile)
* [exports](#exports)

#### target

Тип: `String`. По умолчанию: `?.lang.<lang>.js`.

Имя файла, куда будет записан результат сборки необходимых данных из `?.keysets.<lang>.js`-файла — скомпилированный файл `?.lang.<lang>.js`.


#### lang

Тип: `String`. Обязательная опция.
Expand All @@ -118,6 +118,16 @@ module.exports = function(config) {

`?.keysets.<lang>.js`-файл — это результат выполнения [keysets](#keysets) — набор данных (`keysets`) для указанного языка, который используется технологией [i18n](#i18n) для формирования `?.lang.<lang>.js`-файлов.

#### exports

Тип: `Object`. По умолчанию — `{ globals: true, commonJS: true, ym: true }`.

Настраивает способ получения функции `i18n`. Возможные опции:

* `globals: true` — функция `i18n` будет доступна из глобальной переменной `BEM.I18N`, если в среде исполнения нет модульных систем. Чтобы глобальная переменная была доступна при наличии модульных систем, нужно указать специальное значение `globals: 'force'`.
* `commonJS: true` — скомпилированный файл можно подключить как CommonJS модуль.
* `ym: true` — функция `i18n` будет доступна из модульной системы [YModules](https://ru.bem.info/tools/bem/modules/).

-------------------------------------
**Пример**

Expand Down