Skip to content

Commit

Permalink
chore: fix types for product name
Browse files Browse the repository at this point in the history
  • Loading branch information
rhamzeh committed Dec 17, 2024
1 parent 4f0bee6 commit 5f0bbe0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
10 changes: 4 additions & 6 deletions src/components/Docs/ProductName/ProductName.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,16 @@ interface ProductNameOpts {
}

// ProductName replaces the ProductName with the config's custom field value
export function ProductName(opts: ProductNameOpts): JSX.Element {
export function ProductName(opts: ProductNameOpts): React.ReactElement | string {
const { siteConfig } = useDocusaurusContext();
const productLink = (siteConfig.baseUrl + siteConfig.customFields.productDescriptionLink) as string as string;
const productLink = siteConfig.baseUrl + siteConfig.customFields.productDescriptionLink;
switch (opts.format) {
case ProductNameFormat.ProductLink:
return <a href={productLink}>{siteConfig.customFields.productName as string}</a>;
case ProductNameFormat.LongForm:
return <>{siteConfig.customFields.longProductName}</>;
case ProductNameFormat.ShortForm:
return <>{siteConfig.customFields.productName}</>;
return siteConfig.customFields.longProductName as string;
default:
return <>{siteConfig.customFields.productName}</>;
return siteConfig.customFields.productName as string;
}
}

Expand Down
3 changes: 2 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"@static/*": ["static/*"]
},
"module": "Node16",
"moduleResolution": "Node16"
"moduleResolution": "Node16",
"jsx": "react"
}
}

0 comments on commit 5f0bbe0

Please sign in to comment.