default forNoticeProps[politeness]

WordPress · Jan 27, 2023 · 639be12 · 639be12
1 parent b875859
commit 639be12
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/components/src/notice/types.ts b/packages/components/src/notice/types.ts
@@ -59,6 +59,9 @@ export type NoticeProps = {
 	 * a sensible default is used based on the notice status. Note that this
 	 * value should be considered a suggestion; assistive technologies may
 	 * override it based on internal heuristics.
+	 *
+	 * @ default - 'assertive' for 'error' status
+	 * 			 - 'polite' for all other statuses
 	 */
 	politeness?: 'polite' | 'assertive';
 	/**