Skip to content

Commit 81c0f52

Browse files
authored
feat: Update <Alert> style (#12422)
1 parent 17d6ced commit 81c0f52

File tree

33 files changed

+139
-77
lines changed

33 files changed

+139
-77
lines changed

develop-docs/frontend/design-tenets.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Why minimize content refreshes?
4949
- Less rendering / data fetching for the browser
5050
- Assists user navigation by preserving sense of state ("where am I?")
5151

52-
<Alert level="error">
52+
<Alert level="warning">
5353
Note: while there are a few good examples of this in action in the app, we are actually pretty inconsistent applying this design principle.
5454
</Alert>
5555

docs/contributing/pages/components.mdx

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,62 @@ sidebar_order: 40
88

99
Render an alert callout.
1010

11-
<Alert title="Important">
12-
This is an alert
11+
<Alert title="Watch out!">
12+
This is an info alert. Use these for information that's critical to know; it's important for users to read, but won't cause a catastrophic problem if they don't read it. These include versions that introduce breaking changes or feature limitations. Use infrequently.
1313
</Alert>
1414

15-
```markdown {tabTitle:Example}
16-
<Alert title="Important">
17-
This is an alert
15+
<Alert level="warning" title="Important">
16+
This is a warning alert. Use these for items that MUST be well understood before proceeding. These highlight information that could cause users to make catastrophic errors that break their applications in ways that are very difficult to fix or create liabilities for them, such as information needed to avoid leaking PII. These should be used very rarely.
17+
</Alert>
18+
19+
<Alert level="success" title="Tip">
20+
This is a success alert. Use these when.... TODO?
21+
</Alert>
22+
23+
<Alert>
24+
This is an alert without title.
25+
</Alert>
26+
27+
<Alert>
28+
This is a multi-line alert without title. Use these for information that's critical to know; it's important for users to read, but won't cause a catastrophic problem if they don't read it. These include versions that introduce breaking changes or feature limitations. Use infrequently.
29+
</Alert>
30+
31+
<Alert title="List">
32+
<ul>
33+
<li>Item 1</li>
34+
<li>Item 2</li>
35+
</ul>
36+
</Alert>
37+
38+
39+
```markdown {tabTitle:Info}
40+
<Alert title="Watch out!">
41+
This is an info alert.
42+
</Alert>
43+
```
44+
45+
```markdown {tabTitle:Warning}
46+
<Alert level="warning" title="Important">
47+
This is a warning alert.
48+
</Alert>
49+
```
50+
51+
```markdown {tabTitle:Success}
52+
<Alert level="success" title="Tip">
53+
This is a success alert.
54+
</Alert>
55+
```
56+
57+
```markdown {tabTitle:No Title}
58+
<Alert>
59+
This is an alert without title.
1860
</Alert>
1961
```
2062

2163
Attributes:
2264

2365
- `title` (string) - optional
24-
- `level` (string: `'info' | 'warning') - optional, defaults to `'info'`
66+
- `level` (string: `'info' | 'warning' | 'success') - optional, defaults to `'info'`
2567

2668
Use this for these types of content:
2769

@@ -30,7 +72,7 @@ Use this for these types of content:
3072
- **Warning:** Use these for items that MUST be well understood before proceeding. These highlight information that could cause users to make catastrophic errors that break their applications in ways that are very difficult to fix or create liabilities for them, such as information needed to avoid leaking PII. These should be used very rarely.
3173
- Use with the title "Important"; do not use the title "Warning"
3274

33-
An Alert component with no level setting will render as a Note component.
75+
You can also omit the title of the alert.
3476

3577
See also the [Note component](#note).
3678

docs/platforms/android/enriching-events/breadcrumbs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an
77

88
This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).
99

10-
<Alert level="" title="Learn about SDK usage">
10+
<Alert title="Learn about SDK usage">
1111

1212
Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).
1313

docs/platforms/apple/common/enriching-events/breadcrumbs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an
77

88
This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).
99

10-
<Alert level="" title="Learn about SDK usage">
10+
<Alert title="Learn about SDK usage">
1111

1212
Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).
1313

docs/platforms/dart/enriching-events/breadcrumbs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an
77

88
This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).
99

10-
<Alert level="" title="Learn about SDK usage">
10+
<Alert title="Learn about SDK usage">
1111

1212
Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).
1313

docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an
77

88
This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).
99

10-
<Alert level="" title="Learn about SDK usage">
10+
<Alert title="Learn about SDK usage">
1111

1212
Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).
1313

docs/platforms/dotnet/guides/nlog/configuration/advanced-configuration-example.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_order: 20
44
description: "Review an advanced example of configuration for NLog."
55
---
66

7-
<Alert level="" title="NLog Layouts">
7+
<Alert title="NLog Layouts">
88

99
For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers).
1010

docs/platforms/dotnet/guides/nlog/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Messages logged from assemblies with the name starting with `Sentry` will not ge
4141

4242
## Configure
4343

44-
<Alert level="" title="NLog Layouts">
44+
<Alert title="NLog Layouts">
4545

4646
For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers).
4747

docs/platforms/elixir/enriching-events/breadcrumbs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an
77

88
This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).
99

10-
<Alert level="" title="Learn about SDK usage">
10+
<Alert title="Learn about SDK usage">
1111

1212
Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).
1313

docs/platforms/flutter/enriching-events/breadcrumbs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an
77

88
This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).
99

10-
<Alert level="" title="Learn about SDK usage">
10+
<Alert title="Learn about SDK usage">
1111

1212
Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).
1313

0 commit comments

Comments
 (0)