Skip to main content

Rich Text Input

Offers a rich text editor for formatted textual input.

Examples

Basic Example

The following example demonstrate some of the available functionality for read_richtext

read_richtext("Write here your bio")

Parameters

NameDescriptionType
labelThe label to display to the userstr
initial_valueThe initial value to display to the user. Defaults to "".str
placeholderThe placeholder text to display to the user. Defaults to "Your rich text here".str
disabledwhether the input is disabled. Defaults to False.bool
requiredWhether the input is required or not eg. "this field is required". Defaults to True.Union[bool, str]
hintA tooltip displayed to the user. Defaults to None.str
end_programWhether the program should end after the widget is shown. Defaults to False.bool
full_widthWhether the input should use full screen width. Defaults to False.bool
button_textWhat text to display on the button when the widget is not part of a Page. Defaults to 'Next'.str

Return Values

TypeDescription
strThe rich text value entered by the user