-
Notifications
You must be signed in to change notification settings - Fork 4
ModaqControl props
Alejandro edited this page Nov 6, 2021
·
5 revisions
All IModaqControlProps
fields are optional.
-
buildVersion
: The version you want to show in the Help dialog. -
customExport
: Changes the export options to a single button in the main menu, and calls theonExport
method when its clicked. This is passed in as anICustomExport
instance. -
gameExport
: Format-specific rules for the game, such as the number of points per power or if overtime has bonuses. Passed in as anIGameFormat
instance. -
googleClientId
: The client ID of the Google application the host uses to connect to Google Sheets. This is needed for loading and saving games to TJ Sheets and UCSD Sheets. -
packet
: The packet of questions as anIPacket
instance. -
persistState
: Determines if the MODAQ control should persist its state locally between sessions. When users refresh the page, they will see the same packet and teams. This can only be set on the first render. Defaults totrue
. -
players
: The players in the game. This is passed in as an array ofIPlayer
. -
storeName
: The name of the localStorage field where the state is stored. State is only stored ifpersistState
isn't set tofalse
. -
yappServiceUrl
: The URL to the Yet Another Packet Parser (YAPP) server, which parses packets in the DOCX format for MODAQ to read. This is needed to read .docx packet files; otherwise, the packet either needs to be passed in through thepacket
prop, or the user has to choose a pre-parsed packet in the JSON format.