Global UI Api

GL.ui

get message(): AntdMessage

Gimkit’s message object

AntdMessage

get modal(): AntdModal

Gimkit’s modal object

AntdModal

get notification(): AntdNotification

Gimkit’s notification object, only available when joining or playing a game

AntdNotification

addStyles(id, style): () => void

Adds a style to the DOM

Parameter	Type
`id`	`string`
`style`	`string`

Function

A function to remove the styles

void

removeStyles(id): void

Remove all styles with a given id

Parameter	Type
`id`	`string`

void

showModal(element, options): void

Shows a customizable modal to the user

Parameter	Type
`element`	`HTMLElement` \| `ReactElement`<`any`, `string` \| `JSXElementConstructor`<`any`>>
`options`	{ `buttons`: `ModalButton`[]; `className`: `string`; `closeOnBackgroundClick`: `boolean`; `id`: `string`; `onClosed`: () => `void`; `style`: `string`; `title`: `string`; }
`options.buttons`?	`ModalButton`[]
`options.className`?	`string`
`options.closeOnBackgroundClick`?	`boolean`
`options.id`?	`string`
`options.onClosed`?	() => `void`
`options.style`?	`string`
`options.title`?	`string`

void