Make descriptions and imports consistent for heading and heading level

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

Hide file tree

Showing 4 changed files with 9 additions and 8 deletions.
diff --git a/packages/react/src/Alert/Alert.tsx b/packages/react/src/Alert/Alert.tsx
@@ -8,7 +8,7 @@ import clsx from 'clsx'
 import { forwardRef } from 'react'
 import type { ForwardedRef, HTMLAttributes, PropsWithChildren } from 'react'
 import { Heading } from '../Heading'
-import type { HeadingProps } from '../Heading'
+import type { HeadingLevel } from '../Heading'
 import { Icon } from '../Icon'
 import { IconButton } from '../IconButton'
 
@@ -19,8 +19,8 @@ export type AlertProps = {
   closeButtonLabel?: string
   /** The text for the Heading. */
   heading?: string
-  /** The hierarchical level of the Alert’s heading within the document. */
-  headingLevel?: HeadingProps['level']
+  /** The hierarchical level of the Heading within the document. */
+  headingLevel?: HeadingLevel
   /** A function to run when dismissing. */
   onClose?: () => void
   /** The significance of the message conveyed. */

diff --git a/packages/react/src/FormErrorList/FormErrorList.tsx b/packages/react/src/FormErrorList/FormErrorList.tsx
@@ -7,7 +7,7 @@ import clsx from 'clsx'
 import { forwardRef } from 'react'
 import type { ForwardedRef, HTMLAttributes } from 'react'
 import { Alert } from '../Alert'
-import { HeadingLevel } from '../Heading/Heading'
+import type { HeadingLevel } from '../Heading'
 import { LinkList } from '../LinkList'
 
 export type FormError = {

diff --git a/packages/react/src/Heading/index.ts b/packages/react/src/Heading/index.ts
@@ -1,2 +1,2 @@
-export type { HeadingProps } from './Heading'
 export { Heading } from './Heading'
+export type { HeadingLevel, HeadingProps } from './Heading'
diff --git a/packages/react/src/TableOfContents/TableOfContents.tsx b/packages/react/src/TableOfContents/TableOfContents.tsx
@@ -8,13 +8,14 @@ import { forwardRef } from 'react'
 import type { ForwardedRef, HTMLAttributes, PropsWithChildren } from 'react'
 import { TableOfContentsLink } from './TableOfContentsLink'
 import { TableOfContentsList } from './TableOfContentsList'
-import { Heading, type HeadingProps } from '../Heading'
+import { Heading } from '../Heading'
+import type { HeadingLevel } from '../Heading'
 
 export type TableOfContentsProps = {
   /** The text for the Heading. */
   heading?: string
-  /** The hierarchical level of the Alert’s heading within the document. */
-  headingLevel?: HeadingProps['level']
+  /** The hierarchical level of the Heading within the document. */
+  headingLevel?: HeadingLevel
 } & PropsWithChildren<HTMLAttributes<HTMLElement>>
 
 const TableOfContentsRoot = forwardRef(