Alert

Alert is a banner that gives the user a message. Its colour shows how serious the message is.

Usage

Call Components.Alert with a scope and a table of properties:

C.Alert(scope, {
    Title = "Heads up",
    Text = "Your session expires in five minutes.",
    Tone = "Warning", -- (1)!
})

1. Tone is "Info", "Success", "Warning" or "Error".

Properties

Name	Type	Required	Default	Description
Theme	ThemeRef		The contextual theme	Theme to use for this component instead of the one from Theme.Provide.
LayoutOrder	UsedAs<number>		0	Position in a parent UIListLayout or UIGridLayout.
Size	UsedAs<UDim2>		-	Size of the component.
Visible	UsedAs<boolean>		true	Whether the component is shown.
Title	UsedAs<string>		-	Bold heading above the text.
Text	UsedAs<string>		-	The message.
Tone	AlertTone		"Info"	Colour of the alert: "Info", "Success", "Warning" or "Error".

See also

• Snackbar