Voice Input

Mic button with recording animation for speech input.

python 5 params

Preview

Arguments
voice_input(lang='en-US')

Usage

views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import VoiceInput


class MyView(LiveView):
    template_name = "my_template.html"

    def mount(self, request, **kwargs):
        self.component = VoiceInput(lang='en-US')

    @event_handler()
    def transcribe(self, value=None, **kwargs):
        ...  # write to self.component; the re-render carries it
my_template.html
django
{{ component }}

Events this component sends to the view: transcribe.

Needs a client hook djust does not ship: dj-hook="VoiceInput". The markup renders, but the interaction described above is yours to add — register window.djust.hooks.VoiceInput = { mounted() { … } } before client.js loads (see the hooks guide).

Parameters

NameTypeDefault
eventstr — renames the event; identity is `name`'transcribe'
langstr'en-US'
continuousboolFalse
custom_classstr''
**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
FilePathNotes
moduledjust.components.components.voice_inputSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 3 of this component's classes at line 2290, 2293, 2294. Override those rules, or the custom properties they read, in a stylesheet loaded after it.