Skip to content

Commit

Permalink
icon description fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
Inna Belaya committed Nov 26, 2014
1 parent ccc748d commit f601dda
Showing 1 changed file with 74 additions and 17 deletions.
91 changes: 74 additions & 17 deletions common.blocks/icon/icon.ru.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,109 @@
# icon

Блок `icon` используется в качестве графического элемента в других блоках. В HTML представлен тегом `<i>`. Иконка задается через свойство `background` и, соответственно, не имеет возможности оставить резервный вариант отображения в случае проблем с применением стилей.
Используется в качестве графического элемента в других блоках.

Иконку можно передать как через модификатор, так и через поле `url`:
## Краткая информация

### Модификаторы блока

| Модификатор | Допустимые значения | Способы использования | Описание |
| ----------- | ------------------- | -------------------- | -------- |
| <a href=#social>social</a> | <code>'twitter'</code>, <code>'facebook'</code>, <code>'vk'</code> | <code>BEMJSON</code> | Социальные иконки. |
| <a href=#action>action</a> | <code>'download'</code>, <code>'arrow'</code> | <code>BEMJSON</code> | Иконки действия. |

### Специализированные поля блока

| Поле | Тип | Описание |
| ---- | --- | -------- |
| <a href=#url>url</a> | <code>String</code> | Адрес, по которому подгружается картинка.. |

## Обзор блока

Блок `icon` задается через свойство `background` и, соответственно, не имеет возможности оставить резервный вариант отображения в случае проблем с применением стилей.

Иконка может быть добавлена через поле `content`:

```bemjson
{
block : 'icon',
mods : { social : 'twitter' }
content : '<svg class="image" xmlns="http://www.w3.org/2000/svg" width="16" height="16"><path d="M1 13v2h14v-2h-14zm13-7h-3v-5h-6v5.031l-3-.031 6 6 6-6z"/></svg>'
}
```

### Модификаторы блока

<a name="social"></a>

#### Модификатор `social`

Допустимые значения: `'twitter'`, `'facebook'`, `'vk'`.

Способ использования: `BEMJSON`.

Модификатор `social` используется для добавления иконок социальных сетей.

```bemjson
{
block : 'icon',
url : '../../test.blocks/icon/_action/download.svg'
mods : { social : 'twitter' }
}
```

```bemjson
{
block : 'button',
text : 'Facebook',
mods : { theme : 'normal', size : 'm' },
icon :
{
block : 'icon',
mods : { social : 'facebook' }
}
}
```

Иконку можно так же вставить через поле `content`:

<a name="action"></a>

#### Модификатор `action`

Допустимые значения: `'download'`, `'arrow'`.

Способ использования: `BEMJSON`.

Модификатор `action` используется для добавления иконок действия.

```bemjson
{
block : 'icon',
content : '<svg class="image" xmlns="http://www.w3.org/2000/svg" width="16" height="16"><path d="M1 13v2h14v-2h-14zm13-7h-3v-5h-6v5.031l-3-.031 6 6 6-6z"/></svg>'
mods : { action : 'download' }
}
```

```bemjson
{
block : 'button',
text : 'Кнопка с иконкой',
mods : { theme : 'islands', size : 'm' },
icon : {
text : 'Download',
mods : { theme : 'normal', size : 'm' },
icon :
{
block : 'icon',
mods : { social : 'twitter' }
mods : { social : 'download' }
}
}
```

### Специализированные поля блока

<a name="url"></a>

#### Поле `url`

Определяет адрес иконки.

```bemjson
{
block : 'button',
text : 'with icon',
mods : { theme : 'islands', size : 'm' },
icon : {
block : 'icon',
url : '../../test.blocks/icon/_action/download.svg'
}
block : 'icon',
url : '../../test.blocks/icon/_action/download.svg'
}
```

0 comments on commit f601dda

Please sign in to comment.