Skip to content

Commit

Permalink
Updated README files
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewblond committed Oct 31, 2014
1 parent 022f888 commit 63bc332
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 0 deletions.
45 changes: 45 additions & 0 deletions README.md
Expand Up @@ -52,6 +52,51 @@ BEM-entities can be defined with a help of js-object with the following fields:
* `modName` — modifier's name.
* `modVal` — modifier's value.

The modifier consists of a pair of fields `modName` and `modVal`. This means that the field `modVal` without `modName` has no meaning.

Example:

```js
// Modifier of block
{
block: 'block',
modName: 'mod',
modVal: 'val'
}

// Not valid BEM-notation
{
block: 'block',
modVal: 'val'
}
```

To describe the boolean modifier (only the name, without a value) field `modVal` must be specified as `true`.

Example:

```js
// Boolean modifier of block
{
block: 'block',
modName: 'mod',
modVal: true
}

// Shorthand for the boolean modifier of block
{
block: 'block',
modName: 'mod'
}

// Not valid BEM-notation
{
block: 'block',
modName: 'mod',
modVal: false
}
```

API
---

Expand Down
45 changes: 45 additions & 0 deletions README.ru.md
Expand Up @@ -52,6 +52,51 @@ bem-naming
* `modName` — название модификатора.
* `modVal` — значение модификатора.

Модификатор состоит из пары `modName` и `modVal`. Это означает, что поле `modVal` без `modName` не имеет никакого смысла.

Пример:

```js
// Модификатор блока
{
block: 'block',
modName: 'mod',
modVal: 'val'
}

// Невалидная БЭМ-нотация
{
block: 'block',
modVal: 'val'
}
```

Чтобы задать булевый модификатор (только название, без значения) поле `modVal` должно быть указано со значением `true`.

Пример:

```js
// Булевый модификатор блока
{
block: 'block',
modName: 'mod',
modVal: true
}

// Сокращённая запись булевого модификатор блока
{
block: 'block',
modName: 'mod'
}

// Невалидная БЭМ-нотация
{
block: 'block',
modName: 'mod',
modVal: false
}
```

API
---

Expand Down

0 comments on commit 63bc332

Please sign in to comment.