#Notifications

A NotificationArea fills its parent and stacks toast bubbles in one corner. Each workspace has one, created on first use:

Video tutorial: Notifications. All videos: Video tutorials.

workspace.Notifications.Show("Layout saved", Severity.Success);

var bubble = workspace.Notifications.Show("Connection lost", Severity.Error, durationMs: 0);
bubble.Title = "Network";
bubble.AddAction("Retry", Reconnect);
bubble.Clicked += _ => OpenLog();

Outside a workspace, add an area yourself:

<UIToolbox.NotificationArea name="toasts" corner="BottomRight" max-visible="3" stack-duplicates="true" />

In the UI Builder, the area shows a dashed outline with its name, so you can find it. The outline does not show in Play mode or in a build.

• The countdown pauses while the pointer is on the bubble. It continues from the same time when the pointer leaves.
• A change of the message, the title, the severity or the duration of a shown bubble starts the countdown again.
• The countdown bar is on the bottom edge, in the color of the severity. It shrinks from the full width to nothing, and it pauses with the countdown.
• A bubble that does not dismiss itself (a duration of 0, or a loading bubble) has no bar.
• The countdown uses real time, so it also runs in a paused game.
• The area ignores the pointer, so the workspace under it still takes clicks.
• Show brings the area to the front of its siblings, so bubbles show above windows.

#Update a shown bubble

Keep the bubble that Show returns and set its properties. The bubble changes in place and its countdown starts again.

var bubble = workspace.Notifications.Show("3 files left");
// Later
bubble.Message = "2 files left";
bubble.Severity = Severity.Warning;

#Show a task

ShowTask shows a loading bubble while a task runs. When the task ends, the same bubble changes to a success or to an error, and then dismisses itself.

workspace.Notifications.ShowTask(SaveAsync(), "Saving...", "Saved", "Cannot save");

// The success message from the result of the task
workspace.Notifications.ShowTask(LoadAsync(), "Loading...", (int count) => $"{count} items loaded", "Cannot load");

• An error bubble has the message of the exception as its detail.
• A canceled task dismisses the bubble.

To control the bubble yourself, set Loading and clear it when the work ends:

var bubble = workspace.Notifications.Show(new NotificationBubble { Message = "Connecting...", Loading = true });
// Later
bubble.Message = "Connected";
bubble.Severity = Severity.Success;
bubble.Loading = false;

#Open a window on click

Clicked is raised on a click on the bubble, not on its close button or its action buttons. OpenWindow opens the window, or focuses it when it is open.

var bubble = workspace.Notifications.Show("New message: click to open");
// Keyboard and gamepad users can move to the bubble and press Submit
bubble.focusable = true;
bubble.Clicked += clicked =>
{
    workspace.OpenWindow("chat");
    clicked.Dismiss();
};

#Show a pickup in a game

Give each pickup an icon and a count. With stack-duplicates, a pickup with the same message adds its count to the bubble that shows, so ten pickups of wood show as one "Wood x10" line.

<tb:NotificationArea name="feed" corner="BottomLeft" stack-duplicates="true" show-progress="false" queue="false" />

feed.Show(new NotificationBubble
{
    Message = "Wood",
    Count = amount,
    Icon = Background.FromTexture2D(woodIcon),
    Severity = Severity.Success,
    DurationMs = 2500,
    Closable = false,
});

• queue="false" drops the oldest pickup when the feed is full, so a new pickup never waits.
• For only the icon and the text, give the bubble no background and no border in USS. The Gathering example scene has a panel look and this plain look, a quest bubble and a "Backpack full" bubble that stays until the player sells.

#Tips

• Use a title for the source of the message, and the detail for text that most users do not need.
• Use durationMs: 0 for an error that the user must see.
• Turn the countdown bar on when the bubbles have actions, so the user sees how much time is left.

#Styling

The rules are in Assets/UIToolbox/Runtime/Resources/UIToolbox/Styles/Controls.uss.