***
title: "Alerts"
generated: true
---------------
## AlertActionContext
The props passed to an alert action's `onClick` handler or `component`.
```ts title="Signature"
interface AlertActionContext {
data: TResponse;
dismiss: () => void;
}
```
### data
\
### dismiss
\ void`} />
## DashboardAlertAction
Defines 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.
```ts title="Signature"
type DashboardAlertAction = | {
label: string;
onClick: (args: AlertActionContext) => void | Promise;
component?: never;
}
| {
label?: string;
onClick?: never;
/**
* @description
* A React component to render as the action. This is useful when
* the action needs access to React hooks (e.g. `useNavigate` from TanStack Router).
*
* The component receives the alert `data` and a `dismiss` function as props.
*
* @since 3.6.0
*/
component: ComponentType>;
}
```
## DashboardAlertDefinition
Allows you to define custom alerts that can be displayed in the dashboard.
```ts title="Signature"
interface DashboardAlertDefinition {
id: string;
title: string | ((data: TResponse) => string);
description?: string | ((data: TResponse) => string);
severity: AlertSeverity | ((data: TResponse) => AlertSeverity);
check: () => Promise | TResponse;
shouldShow: (data: TResponse) => boolean;
recheckInterval?: number;
actions?: Array>;
}
```
### id
\
A unique identifier for the alert.
### title
\ string)`} />
The title of the alert. Can be a string or a function that returns a string based on the response data.
### description
\ string)`} />
The description of the alert. Can be a string or a function that returns a string based on the response data.
### severity
\ AlertSeverity)`} />
The severity level of the alert.
### check
\ Promise | TResponse`} />
A function that checks the condition and returns the response data.
### shouldShow
\ boolean`} />
A function that determines whether the alert should be rendered based on the response data.
### recheckInterval
\
The interval in milliseconds to recheck the condition.
### actions
\DashboardAlertAction>`} />
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.