-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(sdds-serv): TextArea docs added
- Loading branch information
1 parent
aa150a1
commit 1e52329
Showing
1 changed file
with
87 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
--- | ||
id: textarea | ||
title: TextArea | ||
--- | ||
|
||
import { PropsTable, Description } from '@site/src/components'; | ||
|
||
# TextArea | ||
<Description name="TextArea" /> | ||
<PropsTable name="TextArea" exclude={['$isFocused']} /> | ||
|
||
## Использование | ||
Компонент `TextArea` может содержать иконку (или кнопку) справа. | ||
Для этого используйте свойство `contentRight`: | ||
|
||
```tsx live | ||
import React from 'react'; | ||
import { TextArea } from '@salutejs/sdds-serv'; | ||
import { IconDownload } from '@salutejs/plasma-icons'; | ||
|
||
export function App() { | ||
return ( | ||
<div> | ||
<TextArea | ||
placeholder="Положение иконки" | ||
defaultValue="Справа" | ||
contentRight={<IconDownload />} | ||
/> | ||
</div> | ||
); | ||
} | ||
``` | ||
|
||
Также можно регулировать высоту и ширину, используя свойства `height` и `width`, | ||
указав значения в `rem` или соответствующие свойствам css значения. | ||
|
||
## Autoresize | ||
Также можно включить автоматическое регулирование высоты поля ввода по длине контента внутри (параметра `value`). | ||
Для этого необходимо использовать свойство `autoResize`. | ||
|
||
В этом режиме можно указать крайние значения высоты поля ввода, используя свойства `autoMin`, `autoMax`, | ||
указав их в `rem`. | ||
|
||
```tsx live | ||
import React from 'react'; | ||
import { TextArea } from '@salutejs/sdds-serv'; | ||
|
||
export function App() { | ||
const [value, setValue] = React.useState('Значение'); | ||
|
||
return ( | ||
<div> | ||
<TextArea | ||
placeholder="Введите значение" | ||
value={value} | ||
onChange={(e) => { | ||
setValue(e.target.value); | ||
}} | ||
autoResize | ||
minAuto={3} | ||
maxAuto={5} | ||
/> | ||
</div> | ||
); | ||
} | ||
``` | ||
|
||
### Подсказка | ||
Для вывода подсказки снизу от поля используйте свойство `leftHelper` и/или `rightHelper`. | ||
|
||
```tsx live | ||
import React from 'react'; | ||
import { TextArea } from '@salutejs/sdds-serv'; | ||
|
||
export function App() { | ||
return ( | ||
<div> | ||
<TextArea | ||
placeholder="Введите значение" | ||
defaultValue="Значение" | ||
leftHelper="Подсказка снизу слева" | ||
rightHelper="Подсказка снизу справа" | ||
/> | ||
</div> | ||
); | ||
} | ||
``` |