Skip to content

Commit

Permalink
docs(Informer): add size description in documentation (#1287)
Browse files Browse the repository at this point in the history
  • Loading branch information
arhayka committed Jun 23, 2021
1 parent 6bb5a93 commit b508853
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 11 deletions.
34 changes: 23 additions & 11 deletions src/components/Informer/__stories__/Informer.docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { InformerExampleType } from './examples/InformerExampleType/InformerExam
import { InformerExampleIcon } from './examples/InformerExampleIcon/InformerExampleIcon';
import { InformerExampleSuccess } from './examples/InformerExampleText/InformerExampleText';
import { InformerExampleAlert } from './examples/InformerExampleText/InformerExampleText';
import { InformerExampleSize } from './examples/InformerExampleSize/InformerExampleSize';

# Informer

Expand All @@ -11,7 +12,12 @@ import { InformerExampleAlert } from './examples/InformerExampleText/InformerExa

- [Тип сообщения](#тип-сообщения)
- [Текст сообщения](#текст-сообщения)
- [Как писать сообщения](#как-писать-сообщения)
- [Когда нужен заголовок](#когда-нужен-заголовок)
- [Внешний вид](#внешний-вид)
- [Тип информера](#тип-информера)
- [Иконка](#иконка)
- [Размер](#размер)
- [Список свойств](#свойства)
- [Пример использования](#пример)

Expand Down Expand Up @@ -96,19 +102,25 @@ import { InformerExampleAlert } from './examples/InformerExampleText/InformerExa
<Informer label="Сообщение отправлено" view="filled" status="success" icon={IconThumbUp} />
```

### Размер

За размер сообщения отвечает свойство `size`. Варианты: `m`, `s`, по умолчанию — `m`.

<InformerExampleSize />

## Свойства

| Свойство | Тип или варианты значения | По умолчанию | Описание |
| ---------------------------- | ----------------------------------------- | ------------ | ---------------------------------- |
| [`status?`](#тип-сообщения) | `'system', 'alert', 'warning', 'success'` | `'success'` | Тип сообщения |
| [`title?`](#текст-сообщения) | `string` || Заголовок сообщения |
| [`lable?`](#текст-сообщения) | `string` || Текст сообщения |
| `children?` | `React.ReactNode` || Текст сообщения |
| [`view?`](#внешний-вид) | `'filled', 'bordered'` | `'filled'` | Тип информера (с заливкой или без) |
| [`icon?`](#внешний-вид) | `React.FC<IconProps>` || Иконка |
| `size?` | `'m', 's'` | m | Размер |
| `ref?` | `React.Ref<HTMLDivElement>` | - | Ссылка на DOM-элемент компонента |
| `className` | `string` || Дополнительный CSS-класс |
| Свойство | Тип или варианты значения | По умолчанию | Описание |
| ---------------------------- | ----------------------------------------------- | ------------ | ---------------------------------- |
| [`status?`](#тип-сообщения) | `'system'`, `'alert'`, `'warning'`, '`success'` | `'success'` | Тип сообщения |
| [`title?`](#текст-сообщения) | `string` || Заголовок сообщения |
| [`lable?`](#текст-сообщения) | `string` || Текст сообщения |
| `children?` | `React.ReactNode` || Текст сообщения |
| [`view?`](#внешний-вид) | `'filled'`, `'bordered'` | `'filled'` | Тип информера (с заливкой или без) |
| [`icon?`](#внешний-вид) | `React.FC<IconProps>` || Иконка |
| `size?` | `'m'`, `'s'` | `'m'` | Размер |
| `ref?` | `React.Ref<HTMLDivElement>` | | Ссылка на DOM-элемент компонента |
| `className` | `string` || Дополнительный CSS-класс |

## Пример

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import React from 'react';

import { cnDocsDecorator } from '../../../../../uiKit/components/DocsDecorator/DocsDecorator';
import { StoryBookExample } from '../../../../../uiKit/components/StoryBookExample/StoryBookExample';
import { Informer } from '../../../Informer';

export const InformerExampleSize = () => (
<div>
<StoryBookExample className={cnDocsDecorator('Section')}>
<Informer
status="system"
view="filled"
title="Размер m"
label="Это обычное сообщение, и размер обычный"
size="m"
/>
<Informer
status="system"
view="filled"
title="Размер s"
label="Это сообщение поменьше"
size="s"
/>
</StoryBookExample>
</div>
);

0 comments on commit b508853

Please sign in to comment.