bundle.website.builtin.components.websocket.toast
=================================================

.. py:module:: bundle.website.builtin.components.websocket.toast


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/bundle/website/builtin/components/websocket/toast/component/index


Classes
-------

.. autoapisummary::

   bundle.website.builtin.components.websocket.toast.WebSocketToastComponent


Package Contents
----------------

.. py:class:: WebSocketToastComponent(/, **data: Any)

   Bases: :py:obj:`bundle.website.builtin.components.websocket.base.WebSocketBaseComponent`


   Websocket component that pushes periodic toast messages to the client.


   .. py:attribute:: component_file
      :type:  str
      :value: '/home/runner/work/TheBundle/TheBundle/src/bundle/website/builtin/components/websocket/toast/comp...



   .. py:attribute:: slug
      :type:  str
      :value: 'ws-toast'



   .. py:attribute:: name
      :type:  str
      :value: 'WebSocket Toast Feed'



   .. py:attribute:: description
      :type:  str
      :value: 'Toast notifications for incoming messages.'



   .. py:attribute:: params
      :type:  bundle.website.builtin.components.websocket.base.WebSocketComponentParams


   .. py:method:: handle_websocket(websocket: fastapi.WebSocket) -> None
      :async:


      Run periodic server push while draining client messages.