express.ui.MarkdownStream
self, id, *, on_error='auto') express.ui.MarkdownStream(
Methods
Name | Description |
---|---|
ui | Create a UI element for this MarkdownStream . |
ui
express.ui.MarkdownStream.ui(='',
content='markdown',
content_type=True,
auto_scroll='100%',
width='auto',
height )
Create a UI element for this MarkdownStream
.
Parameters
content : TagChild = ''
-
A string of content to display before any streaming occurs. When
content_type
is Markdown or HTML, it may also be UI element(s) such as input and output bindings. content_type :
StreamingContentType
= 'markdown'-
The content type. Default is
"markdown"
(specifically, CommonMark). Supported content types include: -"markdown"
: markdown text, specifically CommonMark -"html"
: for rendering HTML content. -"text"
: for plain text. -"semi-markdown"
: for rendering markdown, but with HTML tags escaped. auto_scroll : bool = True
-
Whether to automatically scroll to the bottom of a scrollable container when new content is added. Default is
True
. width :
CssUnit
= '100%'-
The width of the UI element.
height :
CssUnit
= 'auto'-
The height of the UI element.
Returns
:
Tag
-
A UI element for locating the
MarkdownStream
in the app.