You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/docs/contributing/pages/components.mdx
+18-3
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,14 @@ noindex: true
7
7
8
8
Render an alert callout.
9
9
10
-
<Alertlevel="info"title="Note">
10
+
<Alertlevel="info"title="Important">
11
11
12
12
This is an alert
13
13
14
14
</Alert>
15
15
16
16
```markdown {tabTitle:Example}
17
-
<Alert level="info" title="Note">
17
+
<Alert level="info" title="Important">
18
18
19
19
This is an alert
20
20
@@ -27,7 +27,16 @@ Attributes:
27
27
-`level` (string)
28
28
-`dismiss` (boolean)
29
29
30
-
See also the Note component.
30
+
Use this for these types of content:
31
+
32
+
-**Important:** 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.
33
+
- Use this with or without a title
34
+
-**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.
35
+
- Use with the title "Important"; do not use the title "Warning"
36
+
37
+
An Alert component with no level setting will render as a Note component.
38
+
39
+
See also the [Note component](#note).
31
40
32
41
## ConfigKey
33
42
@@ -99,8 +108,14 @@ Something important, but maybe not _that_ important.
99
108
</Note>
100
109
```
101
110
111
+
Use this for these types of content:
112
+
113
+
-**Prerequisite(s):** Use these to list things that are required to finish. Place them prior to the procedure/process that follows so a user doesn't start and stop.
114
+
-**Note:** to document information that's relevant to the topic, but isn't part of the larger point of the content. This might include a piece of information that should be highlighted, but isn't necessarily more important than other information. These include calling out early adopter features or providing clarification. Use sparingly.
102
115
See also the [Alert component](#alert).
103
116
117
+
Don't use a title with this type of note.
118
+
104
119
## PageGrid
105
120
106
121
Render all child pages of this document, including their `description` if available.
0 commit comments