refactor(ContentHero): allow description prop to accept components

TylerAPfledderer · TylerAPfledderer · commit 4479689aca6a · 2024-04-03T00:23:56.000-04:00
diff --git a/src/components/Hero/ContentHero/index.tsx b/src/components/Hero/ContentHero/index.tsx
@@ -38,7 +38,11 @@ const ContentHero = (props: ContentHeroProps) => {
             <Heading as="h1" size="2xl">
               {title}
             </Heading>
-            <Text fontSize="lg">{description}</Text>
+            {typeof description === "string" ? (
+              <Text fontSize="lg">{description}</Text>
+            ) : (
+              description
+            )}
             {buttons && (
               <HStack spacing="4">
                 {buttons.map((button, idx) => {
diff --git a/src/components/Hero/HubHero/HubHero.stories.tsx b/src/components/Hero/HubHero/HubHero.stories.tsx
@@ -62,7 +62,7 @@ export const HubHero: StoryObj<typeof meta> = {
       <HubHeroComponent
         title={t(title)}
         header={t(header)}
-        description={t(description)}
+        description={t(description as string)}
         buttons={buttons}
         {...props}
       />
diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -417,7 +417,7 @@ export type CommonHeroProps<
   /**
    * Preface text about the content in the given page
    */
-  description: string
+  description: ReactNode
 }
 
 // Learning Tools

Original file line number	Diff line number	Diff line change
`@@ -417,7 +417,7 @@ export type CommonHeroProps<`
`417`	`417`	`/**`
`418`	`418`	`* Preface text about the content in the given page`
`419`	`419`	`*/`
`420`		`- description: string`
	`420`	`+ description: ReactNode`
`421`	`421`	`}`
`422`	`422`
`423`	`423`	`// Learning Tools`