website/sdds-cs-docs/docs/components/NumberInput.mdx - dev - sdds/plasma

website/sdds-cs-docs/docs/components/NumberInput.mdx
385 строк12 KB
Krivonos Aleksandr
docs: refactor NumberInput docs
13 мар 2026, 12:37
13 мар 2026, 12:371336d51
---
id: numberInput
title: NumberInput
---

import { PropsTable, Description } from '@site/src/components';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# NumberInput
<Description name="NumberInput" />

## Быстрый старт

```tsx live
import React, { useState } from 'react';
import { NumberInput } from '@salutejs/sdds-cs';

export function App() {
    const [value, setValue] = useState(5);

    return (
        <div>
            <NumberInput
                value={value}
                min={0}
                max={10}
                width={188}
                onChange={(_, newValue) => setValue(newValue)}
            />
        </div>
    );
}
```

## Форма компонента

С помощью свойства `shape` можно изменить скругление углов:

```tsx live
import React from 'react';
import { NumberInput } from '@salutejs/sdds-cs';

export function App() {
    return (
        <div style={{ display: 'flex', gap: '1rem', flexDirection: 'column' }}>
            <NumberInput value={5} width={188} shape="cornered" />
            <NumberInput value={5} width={188} shape="pilled" />
        </div>
    );
}
```


## Ограничения значений

С помощью свойств `min`, `max` и `step` можно задать допустимый диапазон и шаг изменения:

```tsx live
import React, { useState } from 'react';
import { NumberInput } from '@salutejs/sdds-cs';

export function App() {
    const [value, setValue] = useState(5);

    return (
        <div style={{ display: 'flex', gap: '1rem', flexDirection: 'column' }}>
            <NumberInput
                value={value}
                min={0}
                max={10}
                step={2}
                width={188}
                onChange={(_, newValue) => setValue(newValue)}
            />
        </div>
    );
}
```

## Точность вычислений

С помощью свойства `precision` можно задать количество знаков после запятой:

```tsx live
import React, { useState } from 'react';
import { NumberInput } from '@salutejs/sdds-cs';

export function App() {
    const [value, setValue] = useState(5);

    return (
        <div>
            <NumberInput
                value={value}
                min={0}
                max={10}
                step={0.1}
                precision={2}
                width={188}
                onChange={(_, newValue) => setValue(newValue)}
            />
        </div>
    );
}
```

## Вспомогательный текст

С помощью свойств `textBefore` и `textAfter` можно добавить текст слева и справа от числа:

```tsx live
import React, { useState } from 'react';
import { NumberInput } from '@salutejs/sdds-cs';

export function App() {
    const [value, setValue] = useState(5);

    return (
        <div style={{ display: 'flex', gap: '1rem', flexDirection: 'column' }}>
            <NumberInput
                value={value}
                width={220}
                textBefore="от"
                onChange={(_, newValue) => setValue(newValue)}
            />
            <NumberInput
                value={value}
                width={220}
                textAfter="шт."
                onChange={(_, newValue) => setValue(newValue)}
            />
            <NumberInput
                value={value}
                width={220}
                textBefore="$"
                textAfter="USD"
                onChange={(_, newValue) => setValue(newValue)}
            />
        </div>
    );
}
```

## Ручной ввод

Свойство `isManualInput` разрешает редактировать значение непосредственно в поле ввода:

```tsx live
import React, { useState } from 'react';
import { NumberInput } from '@salutejs/sdds-cs';

export function App() {
    const [value, setValue] = useState(5);

    return (
        <div>
            <NumberInput
                value={value}
                min={0}
                max={10}
                width={188}
                isManualInput
                onChange={(_, newValue) => setValue(newValue)}
            />
        </div>
    );
}
```

## Отображение без значения

Свойство `displayWithoutValue` управляет тем, что показывается, когда значение не задано:
- `'input'` — отображается весь компонент (по умолчанию);
- `'increment'` — отображается только кнопка увеличения;
- `'decrement'` — отображается только кнопка уменьшения.

```tsx live
import React, { useState } from 'react';
import { NumberInput } from '@salutejs/sdds-cs';

export function App() {
    const [value, setValue] = useState(undefined);

    return (
        <div style={{ display: 'flex', gap: '1rem', flexDirection: 'column' }}>
            <NumberInput
                value={value}
                min={0}
                max={10}
                displayWithoutValue="input"
                onChange={(_, newValue) => setValue(newValue)}
            />
            <NumberInput
                value={value}
                min={0}
                max={10}
                displayWithoutValue="increment"
                onChange={(_, newValue) => setValue(newValue)}
            />
            <NumberInput
                value={value}
                min={0}
                max={10}
                displayWithoutValue="decrement"
                onChange={(_, newValue) => setValue(newValue)}
            />
        </div>
    );
}
```

## Поведение при достижении границ

Свойство `limitBehavior` управляет поведением кнопок при достижении значений `min`/`max`:
- `'disabled'` — кнопка становится неактивной (по умолчанию);
- `'hidden'` — кнопка скрывается, поле ввода растягивается.

<Tabs>
    <TabItem value="disabled" label="Disabled" default>
        ```tsx live
        import React, { useState } from 'react';
        import { NumberInput } from '@salutejs/sdds-cs';

        export function App() {
            const [value, setValue] = useState(0);

            return (
                <div style={{ display: 'flex', gap: '1rem', flexDirection: 'column' }}>
                    <NumberInput
                        value={value}
                        min={0}
                        max={10}
                        width={188}
                        limitBehavior="disabled"
                        onChange={(_, newValue) => setValue(newValue)}
                    />
                </div>
            );
        }
        ```
    </TabItem>
    <TabItem value="hidden" label="Hidden">
        ```tsx live
        import React, { useState } from 'react';
        import { NumberInput } from '@salutejs/sdds-cs';

        export function App() {
            const [value, setValue] = useState(0);

            return (
                <div style={{ display: 'flex', gap: '1rem', flexDirection: 'column' }}>
                    <NumberInput
                        value={value}
                        min={0}
                        max={10}
                        width={188}
                        limitBehavior="hidden"
                        onChange={(_, newValue) => setValue(newValue)}
                    />
                </div>
            );
        }
        ```
    </TabItem>
</Tabs>

## Пользовательские кнопки

Кнопки увеличения и уменьшения можно кастомизировать:

<Tabs>
    <TabItem value="icons" label="Иконки" default>
        С помощью свойств `decrementIcon` и `incrementIcon` можно заменить иконки кнопок:

        ```tsx live
        import React, { useState } from 'react';
        import { NumberInput } from '@salutejs/sdds-cs';
        import { IconVolumeLevel1Fill, IconVolumeLevel2Fill } from '@salutejs/plasma-icons';

        export function App() {
            const [value, setValue] = useState(5);

            return (
                <div>
                    <NumberInput
                        value={value}
                        min={0}
                        max={10}
                        size="s"
                        width={188}
                        decrementIcon={<IconVolumeLevel1Fill color="inherit" />}
                        incrementIcon={<IconVolumeLevel2Fill color="inherit" />}
                        onChange={(_, newValue) => setValue(newValue)}
                    />
                </div>
            );
        }
        ```
    </TabItem>
    <TabItem value="custom" label="Кастомные кнопки">
        С помощью свойств `customDecrementButton` и `customIncrementButton` можно полностью заменить кнопки.
        В этом случае логику изменения значения нужно реализовать самостоятельно:

        ```tsx live
        import React, { useState } from 'react';
        import { NumberInput, IconButton } from '@salutejs/sdds-cs';
        import { IconVolumeLevel1Fill, IconVolumeLevel2Fill } from '@salutejs/plasma-icons';

        export function App() {
            const [value, setValue] = useState(0);
            const min = 0;
            const max = 10;
            const step = 2;

            return (
                <div>
                    <NumberInput
                        value={value}
                        step={step}
                        size="s"
                        width={188}
                        customDecrementButton={
                            <IconButton
                                size="s"
                                view={value <= min ? 'critical' : 'accent'}
                                disabled={value <= min}
                                onClick={() => setValue(Math.max(min, value - step))}
                            >
                                <IconVolumeLevel1Fill color="inherit" />
                            </IconButton>
                        }
                        customIncrementButton={
                            <IconButton
                                size="s"
                                view={value >= max ? 'critical' : 'accent'}
                                disabled={value >= max}
                                onClick={() => setValue(Math.min(max, value + step))}
                            >
                                <IconVolumeLevel2Fill color="inherit" />
                            </IconButton>
                        }
                    />
                </div>
            );
        }
        ```
    </TabItem>
</Tabs>

## Состояния

<Tabs>
    <TabItem value="disabled" label="Disabled" default>
        ```tsx live
        import React from 'react';
        import { NumberInput } from '@salutejs/sdds-cs';

        export function App() {
            return (
                <div>
                    <NumberInput value={5} width={188} disabled />
                </div>
            );
        }
        ```
    </TabItem>
    <TabItem value="loading" label="Loading">
        ```tsx live
        import React from 'react';
        import { NumberInput } from '@salutejs/sdds-cs';

        export function App() {
            return (
                <div>
                    <NumberInput value={5} size="s" width={188} isLoading />
                </div>
            );
        }
        ```
    </TabItem>
</Tabs>

## Таблица свойств
<PropsTable name="NumberInput" exclude={['css']} />