componentDefines an alert action. Either provide an onClick handler (rendered as a default button
with the given label), or a component for full control over rendering and hook access.
Allows you to define custom alerts that can be displayed in the dashboard.
stringA unique identifier for the alert.
string | ((data: TResponse) => string)The title of the alert. Can be a string or a function that returns a string based on the response data.
string | ((data: TResponse) => string)The description of the alert. Can be a string or a function that returns a string based on the response data.
AlertSeverity | ((data: TResponse) => AlertSeverity)The severity level of the alert.
() => Promise<TResponse> | TResponseA function that checks the condition and returns the response data.
(data: TResponse) => booleanA function that determines whether the alert should be rendered based on the response data.
numberThe interval in milliseconds to recheck the condition.
Array<DashboardAlertAction<TResponse>>Optional actions that can be performed when the alert is shown.
Each action is either a simple onClick handler (rendered as a default button
with the given label), or a component for full control over rendering and
access to React hooks.
Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.
Talk to the team