Clarify that heading level has no visual effect

Amsterdam · Jun 7, 2024 · 9ec5da7 · 9ec5da7
1 parent 9b5038a
commit 9ec5da7
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/packages/react/src/Alert/Alert.tsx b/packages/react/src/Alert/Alert.tsx
@@ -19,7 +19,10 @@ export type AlertProps = {
   closeButtonLabel?: string
   /** The text for the Heading. */
   heading?: string
-  /** The hierarchical level of the Heading within the document. */
+  /**
+   * The hierarchical level of the Heading within the document.
+   * Note: this intentionally does not change the font size.
+   */
   headingLevel?: HeadingLevel
   /** A function to run when dismissing. */
   onClose?: () => void

diff --git a/packages/react/src/FormErrorList/FormErrorList.tsx b/packages/react/src/FormErrorList/FormErrorList.tsx
@@ -20,7 +20,10 @@ export type FormErrorListProps = {
   errors: FormError[]
   /** The text for the Heading. */
   heading?: string
-  /** The hierarchical level of the Heading within the document. */
+  /**
+   * The hierarchical level of the Heading within the document.
+   * Note: this intentionally does not change the font size.
+   */
   headingLevel?: HeadingLevel
 } & HTMLAttributes<HTMLDivElement>
 

diff --git a/packages/react/src/TableOfContents/TableOfContents.tsx b/packages/react/src/TableOfContents/TableOfContents.tsx
@@ -14,7 +14,10 @@ import type { HeadingLevel } from '../Heading'
 export type TableOfContentsProps = {
   /** The text for the Heading. */
   heading?: string
-  /** The hierarchical level of the Heading within the document. */
+  /**
+   * The hierarchical level of the Heading within the document.
+   * Note: this intentionally does not change the font size.
+   */
   headingLevel?: HeadingLevel
 } & PropsWithChildren<HTMLAttributes<HTMLElement>>