Function signature | |
---|---|
st.text_input(label, value="", max_chars=None, key=None, type="default", help=None, autocomplete=None, on_change=None, args=None, kwargs=None, *, placeholder=None, disabled=False) | |
Parameters | |
label (str) | A short label explaining to the user what this input is for. |
value (any) | The text value of this widget when it first renders. This will be cast to str internally. |
max_chars (int or None) | Max number of characters allowed in text input. |
key (str or int) | An optional string or integer to use as the unique key for the widget. If this is omitted, a key will be generated for the widget based on its content. Multiple widgets of the same type may not share the same key. |
type (str) | The type of the text input. This can be either "default" (for a regular text input), or "password" (for a text input that masks the user's typed value). Defaults to "default". |
help (str) | An optional tooltip that gets displayed next to the input. |
autocomplete (str) | An optional value that will be passed to the <input> element's autocomplete property. If unspecified, this value will be set to "new-password" for "password" inputs, and the empty string for "default" inputs. For more details, see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete |
on_change (callable) | An optional callback invoked when this text_input's value changes. |
args (tuple) | An optional tuple of args to pass to the callback. |
kwargs (dict) | An optional dict of kwargs to pass to the callback. |
placeholder (str or None) | An optional string displayed when the text input is empty. If None, no text is displayed. This argument can only be supplied by keyword. |
disabled (bool) | An optional boolean, which disables the text input if set to True. The default is False. This argument can only be supplied by keyword. |
Returns | |
(str) | The current value of the text input widget. |
Example
title = st.text_input('Movie title', 'Life of Brian') st.write('The current movie title is', title)(view standalone Streamlit app)