feat(plasma-docs-ui): Update types for props keys

salute-developers · Sep 27, 2023 · 598d486 · 598d486
1 parent fca1d88
commit 598d486
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 6 deletions.
diff --git a/utils/plasma-docs-ui/src/components/PropsTable.tsx b/utils/plasma-docs-ui/src/components/PropsTable.tsx
@@ -1,7 +1,7 @@
 import React, { FC, HTMLAttributes, useMemo } from 'react';
 import marked from 'marked';
 
-import type { ComponentProps } from '../types';
+import type { ComponentProps, ComponentProp } from '../types';
 
 export interface PropsTableProps extends HTMLAttributes<HTMLTableElement> {
     props: ComponentProps;
@@ -26,6 +26,18 @@ export const PropsTable: FC<PropsTableProps> = ({ props, exclude: propsExclude =
         return null;
     }
 
+    const getType = (type?: ComponentProp['type']) => {
+        if (!type) {
+            return '';
+        }
+
+        if (type.raw && type.value) {
+            return type.raw;
+        }
+
+        return type.name;
+    };
+
     return (
         <table>
             <thead>
@@ -47,7 +59,7 @@ export const PropsTable: FC<PropsTableProps> = ({ props, exclude: propsExclude =
                                 </code>
                             </td>
                             <td>
-                                <code>{prop.type?.name}</code>
+                                <code>{getType(prop.type)}</code>
                             </td>
                             <td>{prop.defaultValue && <code>{prop.defaultValue.value}</code>}</td>
                             <td dangerouslySetInnerHTML={{ __html: marked(prop.description || '') }} />

diff --git a/utils/plasma-docs-ui/src/types/DocgenInfo.ts b/utils/plasma-docs-ui/src/types/DocgenInfo.ts
@@ -1,6 +1,8 @@
-interface ComponentProp {
+export interface ComponentProp {
     type: {
         name: string;
+        raw: string;
+        value: any[];
     };
     defaultValue?: any;
     description?: string;

diff --git a/utils/plasma-docs-ui/src/types/index.ts b/utils/plasma-docs-ui/src/types/index.ts
@@ -1 +1 @@
-export type { ComponentProps, ComponentDocgenInfo, DocgenInfo } from './DocgenInfo';
+export type { ComponentProps, ComponentProp, ComponentDocgenInfo, DocgenInfo } from './DocgenInfo';
diff --git a/website/plasma-web-docs/docs/components/Link.mdx b/website/plasma-web-docs/docs/components/Link.mdx
@@ -7,7 +7,7 @@ import { PropsTable, Description, StorybookLink } from '@site/src/components';
 
 # Link
 <Description name="Link" />
-<PropsTable name="Link" exclude={['$isHover', '$isPressed', '$isVisited']} />
+<PropsTable name="Link" exclude={['css', 'focused']} />
 <StorybookLink name="Link" />
 
 ```tsx live
@@ -17,7 +17,7 @@ import { P1, Link } from '@salutejs/plasma-web';
 export function App() {
     return (
         <P1>
-            Скачайте <Link href="/" target="__blank">приложение</Link>.
+            Скачайте <Link href="/" target="_blank">приложение</Link>.
         </P1>
     );
 }
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export type { ComponentProps, ComponentDocgenInfo, DocgenInfo } from './DocgenInfo';
		export type { ComponentProps, ComponentProp, ComponentDocgenInfo, DocgenInfo } from './DocgenInfo';