diff --git a/docs/v2.6/23_extending-ui.md b/docs/v2.6/23_extending-ui.md new file mode 100644 index 0000000..eded46a --- /dev/null +++ b/docs/v2.6/23_extending-ui.md @@ -0,0 +1,40 @@ +--- +slug: /current/extending-ui +sidebar_position: 23 +sidebar_label: Extending UI +--- + +# Extending UI + +:::info + +This page shows you how to extend UI for the SDK. + +::: + +To Extend UI for the SDK, you can create your own UI scripts that inherit from `GuiScreen` + +## Overlays + +There are three overlay types `GuiOverlayManager.GuiOverlayType` available in the SDK: + +1. **Error :** Displays an error message. +2. **Loading :** Displays a message with a loading spinner. +3. **Toast :** Displays a toast message with a timeout. + +### Usage + +To show an overlay, you can call the following method: + +```csharp +int GuiManager.Instance.Overlays.Show(GuiOverlayType type, string message, bool deactivateOnClick, Action onClose = null, float timeOut = 0) +``` + +| **Name** | **Type** | **Description** | +|---------------------|------------------|------------------------------------------------------------------------------------------------------| +| `type` | `GuiOverlayType` | Type of the overlay, it be `Error`, `Loading` or `Toast` | +| `message` | `string` | Message to display in overlay | +| `deactivateOnClick` | `bool` | Can overlay be closed on click | +| `onClose` | `Action` | Callback to be invoked when overlay is closed | +| `timeOut` | `float` | Time in seconds after which overlay should be closed, if it is equal to 0 then it has has no timeout | + diff --git a/sidebars.js b/sidebars.js index 6e749ab..1ae0c07 100644 --- a/sidebars.js +++ b/sidebars.js @@ -35,6 +35,7 @@ module.exports = { 'v2.6/ramp', 'v2.6/lootboxes', 'v2.6/extending-the-sdk', + 'v2.6/extending-ui', ], }, {