Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/auth/components/LoginScreen

Cockpit client (features), next. Source: ui/client/features/auth/components/LoginScreen.tsx.

Functions#

LoginScreen()#

LoginScreen(__namedParameters): Element

Defined in: ui/client/features/auth/components/LoginScreen.tsx:39

The whole screen when this browser has no session — it replaces the Cockpit frame rather than appearing inside it, because there is nothing behind it that would work: every /api/* call answers 401 and the wizard WebSocket upgrade is refused (ui/server/src/auth.mjs).

Presentation only (COMPONENT-*): no fetch, no application state.

Props#

Prop Type Required Default Description
session `AuthSession null` Yes —
unreachable `string null` Yes —
signingIn boolean Yes —
error `string null` Yes —
canSignIn boolean Yes —
onSignInWithGithub () => void Yes —
onSignInAsTestUser () => void Yes —
onRetry () => void Yes —
tagline string Yes — The typed, changing tagline shown above the card.
taglineAnimated boolean Yes — False under reduced motion: no caret.
exiting boolean No false : true for the short beat after a real sign-in where this screen is still mounted (as a
fixed overlay — see AuthGatePage.tsx) so the mark's exit hand-off can play before it is removed.
Not set on the ordinary "signed out" render, so the class/prop below is a no-op by default.
onExitEnd () => void No — : fires once the hand-off finishes (or immediately under reduced motion). Only meaningful
together with exiting.

Returns#

Element