five-on-it / apps/client/src/ui/AccountBar / AccountBarProps

Interface: AccountBarProps

Defined in: apps/client/src/ui/AccountBar.tsx:65

Props of the account bar.

Properties

account

account: PlatformAccount | undefined

Defined in: apps/client/src/ui/AccountBar.tsx:69

The account, once known.

---

autoSignIn?

optional autoSignIn?: boolean

Defined in: apps/client/src/ui/AccountBar.tsx:83

Whether the desktop app signs in again by itself with its Steam ticket here (the main menu does on Play online).

---

busy

busy: boolean

Defined in: apps/client/src/ui/AccountBar.tsx:75

Whether an action is running.

---

error?

optional error?: string

Defined in: apps/client/src/ui/AccountBar.tsx:77

What went wrong with the last action, shown in the sign-in form.

---

onAccount

onAccount: (account) => void

Defined in: apps/client/src/ui/AccountBar.tsx:71

Called with the account after signing in, and with none after signing out.

Parameters

account

PlatformAccount | undefined

Returns

void

---

platform

platform: Platform

Defined in: apps/client/src/ui/AccountBar.tsx:67

The platform's client.

---

prefix

prefix: string

Defined in: apps/client/src/ui/AccountBar.tsx:79

The ids' prefix.

---

quiet?

optional quiet?: boolean

Defined in: apps/client/src/ui/AccountBar.tsx:81

Nothing shows until the platform answered its /info (the main menu, which may have none).

---

run

run: (action) => Promise<void>

Defined in: apps/client/src/ui/AccountBar.tsx:73

Runs an action, showing its error; the buttons wait while one runs.

Parameters

action

() => Promise<void>

Returns

Promise<void>