Merge branch 'notifications_olgab'
Before Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 22 KiB |
BIN
images/ui/notifications/notification_type_alert.png
Normal file
After Width: | Height: | Size: 106 KiB |
BIN
images/ui/notifications/notification_type_alert_dark.png
Normal file
After Width: | Height: | Size: 101 KiB |
After Width: | Height: | Size: 35 KiB |
After Width: | Height: | Size: 83 KiB |
After Width: | Height: | Size: 92 KiB |
After Width: | Height: | Size: 97 KiB |
After Width: | Height: | Size: 28 KiB |
After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 26 KiB |
Before Width: | Height: | Size: 15 KiB |
@ -6,96 +6,43 @@
|
|||||||
|
|
||||||
Notifications inform users about the status of user or system initiated operations. They can have different actions depending on the message.
|
Notifications inform users about the status of user or system initiated operations. They can have different actions depending on the message.
|
||||||
|
|
||||||
There are four types of notifications:
|
Types of notifications:
|
||||||
|
|
||||||
- Alert
|
- Alert
|
||||||
- [Banner](banner.md)
|
- [Banner](banner.md)
|
||||||
- [Balloon](balloon.md)
|
- [Notification balloon](balloon.md)
|
||||||
- Tool window balloon
|
|
||||||
|
|
||||||
## What notification to use
|
## What notification to use
|
||||||
|
|
||||||
Consider two factors when deciding which notification type to use.
|
Choose a notification type based on a combination of two factors:
|
||||||
|
|
||||||
**User action**
|
1. Is **user action** required to proceed?
|
||||||
|
- [Required immediately](#action-is-required-immediately)
|
||||||
|
- [Required but not immediately](#action-is-required-but-not-immediately)
|
||||||
|
- [Not required](#action-is-not-required-to-proceed)
|
||||||
|
|
||||||
<p> Are the users required to address the notification before they can proceed with current tasks?</p>
|
2. From what **context** the notification was initiated?
|
||||||
- Required immediately
|
- Editor
|
||||||
- Required, but not immediately
|
- Tool window
|
||||||
- Not required
|
- Dialog
|
||||||
|
- Any other location
|
||||||
|
|
||||||
**Context of trigger**
|
|
||||||
|
|
||||||
<p> What initiated the notification? Does the initiation point to a particular context or location?</p>
|
### Action is required immediately
|
||||||
- File tab
|
Use an alert in any context:
|
||||||
- Tool windows
|
{width=706}
|
||||||
- Other
|
|
||||||
|
|
||||||
Use the following table to determine which notification to use based on the two factors:
|
### Action is required but not immediately
|
||||||
|
Use a [banner](banner.md) if the context is the editor, a tool window, or a dialog:
|
||||||
|
{width=706}
|
||||||
|
|
||||||
|
In any other context, use a [notification balloon](balloon.md).
|
||||||
|
|
||||||
|
### Action is not required to proceed
|
||||||
|
Use a [notification balloon](balloon.md) in any context except dialogs:
|
||||||
|
{width=706}
|
||||||
|
|
||||||
|
In a dialog, use a [banner](banner.md):
|
||||||
|
{width=706}
|
||||||
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td width="16%">User action</td>
|
|
||||||
<td width="16%">Context</td>
|
|
||||||
<td width="16%">Type</td>
|
|
||||||
<td width="52%">Examples</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td>Required immediately
|
|
||||||
</td>
|
|
||||||
<td>All
|
|
||||||
</td>
|
|
||||||
<td>Alerts
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<p>Confirm Restart</p>
|
|
||||||
<p>Opening projects in new window</p>
|
|
||||||
<p>When trying to rename a method, but a conflict is found</p>
|
|
||||||
<p>Need a dependency before using a feature</p>
|
|
||||||
<p><img src="alert.png" width="406" /></p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>Required, but not immediately</td>
|
|
||||||
<td>
|
|
||||||
<p>File tabs</p>
|
|
||||||
<p>Tool windows</p>
|
|
||||||
</td>
|
|
||||||
<td>Banners</td>
|
|
||||||
<td>
|
|
||||||
<p>Configuring SDK for your project</p>
|
|
||||||
<p>Requiring a Gradle sync for tools to work properly</p>
|
|
||||||
<p><img src="banner.png" width="431" /></p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>Not required</td>
|
|
||||||
<td>Tool windows</td>
|
|
||||||
<td>Tool Window balloons</td>
|
|
||||||
<td>
|
|
||||||
<p>Status of task completion</p>
|
|
||||||
<p>When Find Usages is invoked on a method, use a tool window balloon to show the feedback since the results will be found in the Find tool window</p>
|
|
||||||
<p><img src="toolwindow_balloon.png" width="208" /></p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td></td>
|
|
||||||
<td>All but file tabs or tool windows</td>
|
|
||||||
<td>Sticky balloons</td>
|
|
||||||
<td>
|
|
||||||
IDE and Plugin Updates
|
|
||||||
<img src="sticky_toast.png" width="391" />
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td></td>
|
|
||||||
<td></td>
|
|
||||||
<td>Timed balloons</td>
|
|
||||||
<td>
|
|
||||||
<p>Module imported</p>
|
|
||||||
<p>Framework detection</p>
|
|
||||||
<p><img src="timed_toast.png" width="391" /></p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
**Exception**: If the action is highly recommended, consider using Banners across all files for visibility instead of Sticky balloon.
|
|
||||||
|