Skip to content

Commit f561e5d

Browse files
committed
Alert docs updates based on feedback
1 parent 09c5231 commit f561e5d

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

apps/website/screens/components/alert/code/AlertCodePage.tsx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ const actionTypeString = `{
1717
onClick: () => void;
1818
}`;
1919

20+
const messageTypeString = `{
21+
onClose?: () => void;
22+
text: React.ReactNode;
23+
}`;
24+
2025
const sections = [
2126
{
2227
title: "Props",
@@ -50,15 +55,10 @@ const sections = [
5055
<td>
5156
<td>
5257
<TableCode>{"Message | Message[]"}</TableCode>
53-
<dl>
54-
<dt>
55-
<TableCode>Message</TableCode>
56-
</dt>
57-
<dd>
58-
An object type with the following attributes:{" "}
59-
<TableCode>{"{ text: React.ReactNode; onClose?: () => void; }"}</TableCode>
60-
</dd>
61-
</dl>
58+
<p>
59+
being <Code>Message</Code> an object with the following properties:
60+
</p>
61+
<ExtendedTableCode>{messageTypeString}</ExtendedTableCode>
6262
</td>
6363
</td>
6464
<td>
@@ -117,7 +117,7 @@ const sections = [
117117
<tr>
118118
<td>semantic</td>
119119
<td>
120-
<TableCode>'error' | 'info" | 'success' | 'warning'</TableCode>
120+
<TableCode>'error' | 'info' | 'success' | 'warning'</TableCode>
121121
</td>
122122
<td>Specifies the semantic meaning of the alert.</td>
123123
<td>

apps/website/screens/components/alert/usage/AlertUsagePage.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ const sections = [
139139
content: (
140140
<>
141141
<DxcParagraph>
142-
Displayed always bellow the header of the site, the banner alert is used for critical system or
142+
Displayed always below the header of the site, the banner alert is used for critical system or
143143
application messages. These alerts are actionable, meaning the user can interact with the message to
144144
resolve the issue directly from the alert itself. However, closing the message is not considered an action
145145
and is mandatory, as the message remains visible and cannot be dismissed until addressed. Additionally, if
@@ -272,7 +272,7 @@ const sections = [
272272
level so the user will assess the most important one first.
273273
</DxcBulletedList.Item>
274274
<DxcBulletedList.Item>
275-
Only use alerts for critical messages that requires immediate attention from the user. Overusing the
275+
Only use alerts for critical messages that require immediate attention from the user. Overusing the
276276
component can desensitize users to their importance and increase the cognitive load.
277277
</DxcBulletedList.Item>
278278
</DxcBulletedList>

apps/website/screens/components/tag/TagPageLayout.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { DxcParagraph, DxcFlex, DxcAlert, DxcLink, DxcTypography } from "@dxc-technology/halstack-react";
1+
import { DxcParagraph, DxcFlex, DxcAlert, DxcLink } from "@dxc-technology/halstack-react";
22
import PageHeading from "@/common/PageHeading";
33
import TabsPageHeading from "@/common/TabsPageLayout";
44
import ComponentHeading from "@/common/ComponentHeading";

0 commit comments

Comments
 (0)