turbo_response.frame#

Module Contents#

Classes#

TurboFrameTemplate

Wraps template functionality.

TurboFrame

Class for creating Turbo Frame strings and responses.

class turbo_response.frame.TurboFrameTemplate(template_name, context=None, *, dom_id, **template_kwargs)#

Wraps template functionality.

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

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

  • dom_id (str) –

render(**kwargs)#
Parameters:

content – enclosed content

Returns:

a <turbo-frame> string

Return type:

str

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

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

Return type:

turbo_response.response.TurboFrameTemplateResponse

class turbo_response.frame.TurboFrame(dom_id)#

Class for creating Turbo Frame strings and responses.

Parameters:

dom_id (str) –

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

content (str) – enclosed content

Returns:

a <turbo-frame> string

Return type:

str

response(content='', **kwargs)#
Parameters:
  • content (str) – enclosed content

  • is_safe – mark content safe for HTML escaping.

Returns:

a <turbo-frame> HTTP response

Return type:

turbo_response.response.TurboFrameResponse

template(template_name, context=Optional[Dict[str, Any]], **template_kwargs)#
Parameters:
  • template_name (Union[str, List[str]]) – Django template name(s)

  • context – template context

Returns:

a <turbo-frame> HTTP response

Return type:

TurboFrameTemplate