chore: add custom types for transform function

This is to avoid exposing complex types from our internal deps. Signed-off-by: Côme Tresarrieu <c.tresarrieu@gmail.com>
2022-06-20 17:32:29 +02:00
parent 32204fa794
commit 411e8e6081
1 changed files with 14 additions and 3 deletions
@@ -64,12 +64,23 @@ const useStyles = makeStyles<BackstageTheme>(
  { name: 'BackstageMarkdownContent' },
 );

+type TransformLink = (
+  href: string,
+  // Complex type from internal react-markdown dep library (hast)[./node_modules/@types/hast/index.d.ts]
+  children: any[],
+  title: string | null,
+) => string;
+
 type Props = {
  content: string;
  dialect?: 'gfm' | 'common-mark';
-  linkTarget?: Options['linkTarget'];
-  transformLinkUri?: Options['transformLinkUri'];
-  transformImageUri?: Options['transformImageUri'];
+  linkTarget?: React.HTMLAttributeAnchorTarget | TransformLink;
+  transformLinkUri?: TransformLink;
+  transformImageUri?: (
+    src: string,
+    alt: string,
+    title: string | null,
+  ) => string;
 };

 const components: Options['components'] = {