Streaming Text
Renders text arriving incrementally via WebSocket with typing cursor.
Preview
Generating response...
python
streaming_text(text='Generating response...')Usage
views.py
python
from djust import LiveView
from djust.components import StreamingText
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = StreamingText(text='Generating response...')my_template.html
django
{{ component }}Needs its script on the page: <script src="{% static 'djust_components/streaming-text.js' %}"></script>. djust ships it; without it the markup renders but does not update in the browser.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| stream_event | str — the event your server pushes to it | 'stream_chunk' | WebSocket event name for incoming text chunks |
| text | str | '' | Initial text content |
| markdown | bool | False | Whether to render text as markdown |
| auto_scroll | bool | True | Whether to auto-scroll to bottom on new content |
| cursor | bool | True | Whether to show a typing cursor animation |
| custom_class | str | '' | Additional CSS classes |
| **kwargs | — passed to `Component.__init__`: `name=` identifies the instance in the events it sends, `id=` sets `component.id`, and any other keyword is kept as state | — | — |
Source & styles
| File | Path | Notes |
|---|---|---|
| module | djust.components.components.streaming_text | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components.css | Defines 3 of this component's classes at line 1235, 1236, 1237. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |