TextAreaInput#

Open this notebook in Jupyterlite | Download this notebook from GitHub (right-click to download).

import panel as pn
pn.extension()

The TextAreaInput allows entering any multiline string using a text input box. Lines are joined with the newline character \n.

Discover more on using widgets to add interactivity to your applications in the how-to guides on interactivity. Alternatively, learn how to set up callbacks and (JS-)links between parameters or how to use them as part of declarative UIs with Param.

Parameters:#

For details on other options for customizing the component see the layout and styling how-to guides.

Core#

value (str): The current value updated when the widget loses focus because the user clicks away or presses the tab key.
value_input (str): The current value updated on every key press.

Display#

auto_grow (boolean, default=False): Whether the TextArea should automatically grow in height to fit the content.
cols (int, default=2): The number of columns in the text input field.
disabled (boolean, default=False): Whether the widget is editable
max_length (int, default=5000): Max character length of the input field. Defaults to 5000
max_rows (int, default=None): The maximum number of rows in the text input field when auto_grow=True.
name (str): The title of the widget
placeholder (str): A placeholder string displayed when no value is entered
rows (int, default=2): The number of rows in the text input field.
resizable (boolean | str, default=’both’): Whether the layout is interactively resizable, and if so in which dimensions: width, height, or both.

text_area_input = pn.widgets.TextAreaInput(name='Text Area Input', placeholder='Enter a string here...')
text_area_input

TextAreaInput.value returns a string type that can be read out and set like other widgets:

text_area_input.value

An auto-growing TextAreaInput will grow (and shrink) in height to accommodate the entered text. Setting rows together with auto_grow will set a lower bound on the number of rows and setting max_rows will provide an upper bound:

pn.widgets.TextAreaInput(name='Growing TextArea', auto_grow=True, max_rows=10, rows=6, value="""\
This text area will grow when newlines are added to the text:

1. Foo
2. Bar
3. Baz
""", width=500)

If you only want the text area to be resizable in the vertical direction, you can set the resizeable parameter to ‘height’:

pn.widgets.TextAreaInput(name="Vertical Adjustable TextArea", resizable="height")

Controls#

The TextAreaInput widget exposes a number of options which can be changed from both Python and Javascript. Try out the effect of these parameters interactively:

pn.Row(text_area_input.controls(jslink=True), text_area_input)

Open this notebook in Jupyterlite | Download this notebook from GitHub (right-click to download).