bundle.website.builtin.components.websocket.base.component
==========================================================

.. py:module:: bundle.website.builtin.components.websocket.base.component


Classes
-------

.. autoapisummary::

   bundle.website.builtin.components.websocket.base.component.WebSocketComponentParams
   bundle.website.builtin.components.websocket.base.component.WebSocketBaseComponent


Module Contents
---------------

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

   Bases: :py:obj:`bundle.core.data.Data`


   Shared websocket parameters for component instances.


   .. py:attribute:: endpoint
      :type:  str
      :value: '/ws/default'



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

   Bases: :py:obj:`bundle.website.core.component.Component`


   Base websocket component with default params and shared assets.


   .. py:attribute:: shared_assets
      :type:  ClassVar[tuple[str, Ellipsis]]
      :value: ('websocket/base/component.css',)



   .. py:attribute:: params
      :type:  WebSocketComponentParams
      :value: None



   .. py:method:: shared_asset_paths() -> list[str]
      :classmethod:



   .. py:method:: component_asset_paths_for(component_file: str | pathlib.Path, *, asset_filenames: collections.abc.Iterable[str] | None = None) -> list[str]
      :classmethod:



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


      Default websocket handler (keepalive protocol).



   .. py:method:: build_routers()

      Attach the component websocket route using the configured endpoint.