;
}
};
Notifications are essential in digital products to alert, warn, or give positive feedback. They give awareness and confidence to the user as they interact throughout the product.
## Message priority
When deciding what to use for a notification, you have to understand how important the message is to the user and/or the system.
| Component | High | Medium | Low |
| -------------------------------------------------------- | ---- | ------ | --- |
| [Announcement](/docs/web/components/announcement/design) | ✓ | | |
| [Dialog](/docs/web/components/dialog/design) | ✓ | | |
| [Toast](/docs/web/components/toast/design) | ✓ | ✓ | ✓ |
| [Alert](/docs/web/components/alert/design) | | ✓ | ✓ |
Use one of the following criteria for determining notification priority:
### High priority
* Messages that persist across the entire app (system or account level)
* Messages that require an interruption and user action to proceed
* Messages that are important for users to see from ST’s perspective - new feature announcement etc.
### Medium priority
* Messages to indicate status of information on a page
* Messages to indicate status of actions taken, including additional information on how to proceed
### Low priority
* Messages to indicate status of actions taken, without needing additional information or actions
## Announcement
Announcement component can be used for high priority notification that is persistent across the entire application. Primary use cases are to notify things such as New Feature or System-Wide status such as "Server is down" or "Unable to connect to the internet" Announcements should not stack and only appear one at a time.
```tsx lines theme={null}
import { Announcement, Button } from "@servicetitan/anvil2";
function App() {
return (
);
}
export default App;
```
## Dialog
Dialog is a component that can be used for notification. It can be used for high priority notification that interrupts user until an action is taken. A primary use case is confirmation of deletion on critical information.
```tsx lines theme={null}
import { Dialog, Flex, Button } from "@servicetitan/anvil2";
function App() {
return (
);
}
export default App;
```
## Toast
Toast component can be used as any priority notifications. The notification is not bound to the current page content, and it can notify users about another part of the app. By default, it can stack up to 5 and also queues after 5 showing visually. A primary use case is a notification to show the progress bar.
```tsx lines theme={null}
import { toast, ProgressBar } from "@servicetitan/anvil2";
import { useEffect, useRef } from "react";
function App() {
const firstRenderRef = useRef(true);
useEffect(() => {
if (firstRenderRef.current) {
firstRenderRef.current = false;
toast.success({
title: "Successful import",
message: (
) as unknown as string,
actions: {
primary: {
label: "View Import",
},
},
});
toast.info({
title: "Import adjustments",
message: (
) as unknown as string,
actions: {
primary: {
label: "Cancel",
},
},
});
}
}, []);
return ;
}
export default App;
```
## Alert
Alert component is used for contextual notifications for items such as a page or a section on a page. It can be used for medium to low priority notification and ideally placed above the related content. A primary use case is to show error messages for a [form group](/docs/web/patterns/forms). Learn more about this on the [error pattern page](/docs/web/patterns/errors-and-warnings).
```tsx lines theme={null}
import { Alert, Grid, TextField } from "@servicetitan/anvil2";
function App() {
return (
);
}
export default App;
```
### Grouping multiple messages in one Alert
When multiple messages related to a single Alert exist, they can be combined into one summary Alert. This is usually done when multiple error messages need to be displayed.
```tsx lines theme={null}
import { Alert, Grid, TextField } from "@servicetitan/anvil2";
function App() {
return (
Enter a last name
Enter a valid email address
Enter a valid area code
);
}
export default App;
```
### Multiple Alerts
Multiple Alerts can be used at once, divided by category of information. Order should be based on importance.
```tsx lines theme={null}
import { Alert, Grid, Flex, TextField, Link } from "@servicetitan/anvil2";
function App() {
return (
Enter a last name
Enter a valid email address
Enter a valid area code
Unsure on how to configure Widgets? Check out our{" "}
guide on how to foo bar.
);
}
export default App;
```
