website/plasma-web-docs/docs/components/TextField.mdx - dev - sdds/plasma

website/plasma-web-docs/docs/components/TextField.mdx
312 строк12 KB
Alexander Lobyntsev
docs(textfield): add example for cleaning logic [PLASMA-6734]
06 мар 2026, 11:33
06 мар 2026, 11:33be84255
---
id: TextField
title: TextField
---

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

import CleaningLogicExample from '../_examples/_textfield/_cleaning-logic.mdx'

# TextField
<Description name="TextField" />

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

<Tabs>
    <TabItem value="default" label="Uncontrolled" default>
        ```tsx live
        import React, {useState} from 'react';
        import { TextField } from '@salutejs/plasma-web';
        import { IconBellFill, IconDone } from '@salutejs/plasma-icons';

        export function App() {
            return (
                <div>
                    <TextField
                        label="Uncontrolled TextField"
                        defaultValue="Дефолтное значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                        status="default"
                    />
                </div>
            );
        }
        ```
    </TabItem>
    <TabItem value="controlled" label="Controlled">
        ```tsx live
        import React, {useState} from 'react';
        import { DateTimePicker } from '@salutejs/plasma-web';
        import { IconBellFill, IconDone } from '@salutejs/plasma-icons';

        export function App() {
            const [text, setText] = useState('Значение поля');

            return (
                <div>
                    <TextField
                        value={text}
                        onChange={(e: ChangeEvent<HTMLInputElement>) => {
                            setText(e.target.value);
                        }}
                        label="Uncontrolled TextField"
                        defaultValue="Дефолтное значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                        status="default"
                    />
                </div>
            );
        }
        ```
    </TabItem>
</Tabs>

### Управление внешним видом

Внешний вид компонента зависит от свойств `appearance`, `status`, `size`:

<Tabs>
    <TabItem value="appearance" label="Appearance" default>
        Для `appearance="clear"` есть возможность отобразить разделитель с помощью `hasDivider`

        ```tsx live
        import React, {useState} from 'react';
        import { TextField } from '@salutejs/plasma-web';
        import { IconBellFill, IconDone } from '@salutejs/plasma-icons';

        export function App() {
            return (
                <div style={{ display: 'flex', gap: '3rem', flexWrap: 'wrap'}}>
                    <TextField
                        status="default"
                        appearance="default"
                        label="Appearance default"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                    <TextField
                        status="default"
                        appearance="clear"
                        label="Appearance clear"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                    <TextField
                        status="success"
                        appearance="clear"
                        hasDivider
                        label="Appearance clear"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                </div>
            );
        }
        ```
    </TabItem>
    <TabItem value="status" label="Status">
        ```tsx live
        import React, {useState} from 'react';
        import { TextField } from '@salutejs/plasma-web';
        import { IconBellFill, IconDone } from '@salutejs/plasma-icons';

        export function App() {
            return (
                <div style={{ display: 'flex', gap: '3rem', flexWrap: 'wrap'}}>
                    <TextField
                        status="default"
                        label="View default"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                    <TextField
                        status="success"
                        label="View success"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                    <TextField
                        status="warning"
                        label="View warning"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                    <TextField
                        status="error"
                        label="View error"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                </div>
            );
        }
        ```
    </TabItem>
    <TabItem value="size" label="Size">
        ```tsx live
        import React, {useState} from 'react';
        import { TextField } from '@salutejs/plasma-web';
        import { IconBellFill, IconDone } from '@salutejs/plasma-icons';

        export function App() {
            return (
                <div style={{ display: 'flex', gap: '3rem', flexWrap: 'wrap'}}>
                    <TextField
                        size="xl"
                        label="Size xl"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                    <TextField
                        size="l"
                        label="Size l"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                    <TextField
                        size="m"
                        label="Size m"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                    <TextField
                        size="s"
                        label="Size s"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                    <TextField
                        size="xs"
                        label="Size xs"
                        placeholder="Введите значение"
                        contentLeft={<IconBellFill size="s" color="inherit" />}
                        contentRight={<IconDone size="s" color="inherit" />}
                    />
                </div>
            );
        }
        ```
    </TabItem>
</Tabs>

### Подсказки
Для вывода подсказки снизу от поля используйте свойство `helperText`,
для подсказки в виде Tooltip - `hintText`, для подсказки сверху справа - `titleCaption`:

```tsx live
import React from 'react';
import { TextField } from '@salutejs/plasma-web';

export function App() {
    return (
        <div>
            <TextField
                placeholder="Введите значение"
                helperText="Подсказка снизу"
                titleCaption="Подсказка сверху"
                hintText="Подсказка в виде Tooltip"
                hintView="default"
                hintSize="m"
            />
        </div>
    );
}
```

### Обязательность поля

:::tip
Наличие индикатора регулируется свойством `hasRequiredIndicator`.
:::

Обязательность поля задаётся с помощью свойства `required`. 
Если поле является обязательным, то у компонента появляется специальный индикатор. 
Изменить расположение индикатора можно с помощью свойства `requiredPlacement`, которое принимает значения `left` и `right`. 

```tsx live
import React from 'react';
import { TextField } from '@salutejs/plasma-web';
import { IconBellFill, IconDone } from '@salutejs/plasma-icons';

export function App() {
    return (
        <div>
            <TextField
                hasRequiredIndicator
                required
                requiredPlacement="right"
                label="Лейбл"
                helperText="Подсказка к полю"
                placeholder="Введите значение"
                contentLeft={<IconBellFill size="s" color="inherit" />}
                contentRight={<IconDone size="s" color="inherit" />}
            />
        </div>
    );
}
```

### Расширенные примеры

<Tabs>
    <TabItem value="cleaning logic" label="Cleaning logic">
        <CleaningLogicExample />
    </TabItem>
</Tabs>

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

### Режим ввода (DEPRECATED)
С помощью свойства `enumerationType` можно вводить элементы как теги. Свойство `chipType` изменяет внешний вид чипа.
С помощью `chipView` можно задать общий вид Chip. Валидация Chip происходит с помощью функции chipValidator.
По нажатию Enter, после ввода нужного текста, он преобразуется в Chip.

```tsx live
import React from 'react';
import { TextField } from '@salutejs/plasma-web';

export function App() {
    const validateChip = (value) => (value === 'Значение 1' ? { view: 'negative' } : {});

    return (
        <div>
            <TextField
                placeholder="Введите значение"
                defaultValue="Значение"
                size="l"
                enumerationType="chip"
                helperText="Подсказка снизу"
                chips={["Значение 1", "Значение 2"]}
                chipView="positive"
                chipValidator={validateChip}
            />

            <TextField
                placeholder="Введите значение"
                defaultValue="Значение"
                size="l"
                enumerationType="chip"
                helperText="Подсказка снизу"
                chips={["Значение 1"]}
                chipType="text"
            />
        </div>
    );
}
```