Plugin¶

litestar_vite.inertia.plugin.set_js_routes(app: Litestar) → None[source]¶: Generate the route structure of the application on startup.

class litestar_vite.inertia.plugin.InertiaPlugin[source]¶

Bases: InitPluginProtocol

Inertia plugin.

__init__(config: InertiaConfig) → None[source]¶

Initialize Inertia.

Parameters:: config – Inertia configuration.

lifespan(app: Litestar) → AsyncGenerator[None, None][source]¶

Lifespan to ensure the event loop is available.

Parameters:: app – The Litestar instance.
Yields:: An asynchronous context manager.

property portal: BlockingPortal¶: Get the portal.

on_app_init(app_config: AppConfig) → AppConfig[source]¶

Configure application for use with Vite.

Parameters:: app_config – The AppConfig instance.
Raises:: ImproperlyConfiguredException – If the Inertia plugin is not properly configured.
Returns:: The AppConfig instance.