Five On It

Appearance

five-on-it / apps/client/src/ui/MainMenu / MainMenuProps

Interface: MainMenuProps ​

Defined in: apps/client/src/ui/MainMenu.tsx:117

Props of the main menu.

Properties ​

checkPlatform ​

checkPlatform: (base) => Promise<PlatformInfo>

Defined in: apps/client/src/ui/MainMenu.tsx:125

Asks a platform what it is (its /info).

Parameters ​

base ​

string

Returns ​

Promise<PlatformInfo>

isAdmin? ​

optional isAdmin?: () => Promise<boolean>

Defined in: apps/client/src/ui/MainMenu.tsx:139

Whether the page's session is an admin's of its platform: Admin is offered then (?admin).

Returns ​

Promise<boolean>

local? ​

optional local?: LocalHost

Defined in: apps/client/src/ui/MainMenu.tsx:127

The desktop app's local game server: Play local and Quit are offered with it.

onlineTarget ​

onlineTarget: (chosen) => OnlineTarget

Defined in: apps/client/src/ui/MainMenu.tsx:123

Where Play online plays with the platform's address the player set (empty for none).

Parameters ​

chosen ​

string

Returns ​

OnlineTarget

onNavigate ​

onNavigate: (href) => void

Defined in: apps/client/src/ui/MainMenu.tsx:133

Goes to another address of the client (a level, a page, a gallery).

Parameters ​

href ​

string

Returns ​

void

onQuit ​

onQuit: () => void

Defined in: apps/client/src/ui/MainMenu.tsx:135

Closes the app (the desktop app's Quit).

Returns ​

void

onSound ​

onSound: (sound) => void

Defined in: apps/client/src/ui/MainMenu.tsx:131

Plays a menu cue.

Parameters ​

sound ​

UiSound

Returns ​

void

onView? ​

optional onView?: (view) => void

Defined in: apps/client/src/ui/MainMenu.tsx:137

Hears where the menu is, for the end-to-end tests.

Parameters ​

view ​

MenuView

Returns ​

void

search: string

Defined in: apps/client/src/ui/MainMenu.tsx:121

The page's query, whose server and api the links keep.

settings ​

settings: Store<Settings>

Defined in: apps/client/src/ui/MainMenu.tsx:119

The player's settings.

steam? ​

optional steam?: MenuSteam

Defined in: apps/client/src/ui/MainMenu.tsx:141

Signing in through Steam at a platform that takes it.

way? ​

optional way?: PlayWay

Defined in: apps/client/src/ui/MainMenu.tsx:129

The way to play whose screen the menu opens on, coming back from its game.