Skip to content

Commit

Permalink
docs(mod): add docs for mod option as object
Browse files Browse the repository at this point in the history
  • Loading branch information
blond committed Mar 24, 2016
1 parent e73af16 commit 0257ed9
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 9 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,16 @@ Function `bemNaming` gets the object from the following options:

* **String** `elem` — separates element's name from block. Default as `__`.
* **String** `mod` — separates modifiers from blocks and elements. Default as `_`.

This option can get object:

```js
{ name: String, val: String }
```

* **String** `name` — separates name of modifier from blocks and elements. Default as `_`.
* **String** `val` — separates value of modifier from name of modifier. Default as the value of the `name`.

* **String** `modVal` — separates value of modifier from name of modifier. Default as the value of the `mod` option.
* **String** `wordPattern` — defines which symbols can be used for block, element and modifier's names. Default as `[a-z0-9]+(?:-[a-z0-9]+)*`.

Expand All @@ -342,8 +352,7 @@ Example:
```js
var myNaming = bemNaming({
elem: '-',
mod: '--',
modVal: '_',
mod: { name: '--', val: '_' }
wordPattern: '[a-zA-Z0-9]+' // because element and modifier's separators include
}); // hyphen in it, we need to exclude it from block,
// element and modifier's name
Expand All @@ -370,8 +379,7 @@ Example:
```js
var csswizardry = bemNaming({
elem: '__',
mod: '--',
modVal: '_'
mod: { name: '--', val: '_' }
});

csswizardry.parse('block__elem'); // { block: 'block', elem: 'elem' }
Expand Down
18 changes: 13 additions & 5 deletions README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,17 @@ bemNaming.isElemMod({ block: 'block',
Функция принимает объект из следующих опций:

* **String** `elem` — отделяет имя элемента от блока. По умолчанию — `__`.
* **String** `mod` — отделяет модификаторы от блоков и элементов. По умолчанию — `_`.
* **String|Object** `mod` — отделяет модификаторы от блоков и элементов. По умолчанию — `_`.

Опция может принимать объект вида:

```js
{ name: String, val: String }
```

* **String** `name` — отделяет название модификатора от блоков и элементов. По умолчанию — `_`.
* **String** `val` — отделяет значение модификатора от имени модификатора. По умолчанию принимает значение опции `name`.

* **String** `modVal` — отделяет значение модификатора от имени модификатора. По умолчанию принимает значение опции `mod`.
* **String** `wordPattern` — определяет, какие символы могут быть использованы в именах блоков, элементов и модификаторов. По умолчанию — `[a-z0-9]+(?:-[a-z0-9]+)*`.

Expand All @@ -342,8 +352,7 @@ bemNaming.isElemMod({ block: 'block',
```js
var myNaming = bemNaming({
elem: '-',
mod: '--',
modVal: '_',
mod: { name: '--', val: '_' },
wordPattern: '[a-zA-Z0-9]+' // т.к. сепараторы элемента и модификатора включают
}); // в себя дефис, исключим его из имён блоков,
// элементов и модификаторов
Expand All @@ -370,8 +379,7 @@ myNaming.stringify({ // 'blockName-elemName--boolElemMod'
```js
var csswizardry = bemNaming({
elem: '__',
mod: '--',
modVal: '_'
mod: { name: '--', val: '_' }
});

csswizardry.parse('block__elem'); // { block: 'block', elem: 'elem' }
Expand Down

0 comments on commit 0257ed9

Please sign in to comment.