turbo_response.stream#

Module Contents#

Classes#

TurboStreamTemplate

Wraps template functionality.

TurboStreamAction

Returns strings and responses for a specific Turbo Stream action type.

TurboStream

Class for creating Turbo Stream strings and responses.
class turbo_response.stream.TurboStreamTemplate(template_name, context=None, *, action, target, is_multiple=False, **template_kwargs)#

Wraps template functionality.

Parameters:

  • template_name (Union[str, List[str]]) –

  • context (Optional[Dict[str, Any]]) –

  • action (turbo_response.constants.Action) –

  • target (str) –

  • is_multiple (bool) –

render(**kwargs)#
Return type:

str

response(request=None, **kwargs)#
Parameters:

request (Optional[django.http.HttpRequest]) –

Return type:

turbo_response.response.TurboStreamTemplateResponse

class turbo_response.stream.TurboStreamAction(target, action, is_multiple=False)#

Returns strings and responses for a specific Turbo Stream action type.

Parameters:
render(content='', **kwargs)#
Parameters:

content (str) – enclosed content

Returns:

a <turbo-stream> string

Return type:

str

response(content='', **kwargs)#
Parameters:

content (str) – enclosed content

Returns:

a <turbo-stream> HTTP response wrapper

Return type:

turbo_response.response.TurboStreamResponse

template(template_name, context=None, **template_kwargs)#
Parameters:

  • template_name (Union[str, List[str]]) – Django template name

  • context (Optional[Dict[str, Any]]) – template context

Returns:

a <turbo-stream> template wrapper

Return type:

TurboStreamTemplate

class turbo_response.stream.TurboStream(target, is_multiple=False)#

Class for creating Turbo Stream strings and responses.

Parameters:

  • target (str) –

  • is_multiple (bool) –

property after: TurboStreamAction#
Return type:

TurboStreamAction

property append: TurboStreamAction#
Return type:

TurboStreamAction

property before: TurboStreamAction#
Return type:

TurboStreamAction

property prepend: TurboStreamAction#
Return type:

TurboStreamAction

property remove: TurboStreamAction#
Return type:

TurboStreamAction

property replace: TurboStreamAction#
Return type:

TurboStreamAction

property update: TurboStreamAction#
Return type:

TurboStreamAction

action(action)#
Parameters:

action (turbo_response.constants.Action) –

Return type:

TurboStreamAction