TypeScript: Support showing optional properties on TypeTable

.changeset/bitter-melons-bow.md

@@ -0,0 +1,6 @@
+---
+'fumadocs-typescript': patch
+'fumadocs-ui': patch
+---
+
+Support showing optional properties on TypeTable

packages/typescript/src/generate/base.ts

@@ -18,6 +18,7 @@ export interface DocEntry {
   description: string;
   type: string;
   tags: Record<string, string>;
+  required: boolean;
 }
 
 interface EntryContext {
@@ -160,6 +161,7 @@ function getDocEntry(
     ),
     tags,
     type: typeName,
+    required: !prop.isOptional(),
   };
 
   transform?.call(context, entry, subType, prop);

packages/typescript/src/ui/auto-type-table.tsx

@@ -109,6 +109,7 @@ export async function AutoTypeTable({
                 type: entry.type,
                 description: await renderMarkdown(entry.description),
                 default: entry.tags.default || entry.tags.defaultValue,
+                required: entry.required,
               },
             ] as const,
         );

packages/ui/src/components/type-table.tsx

@@ -36,6 +36,8 @@ interface ObjectType {
    */
   typeDescriptionLink?: string;
   default?: string;
+
+  required?: boolean;
 }
 
 const field = cva('inline-flex flex-row items-center gap-1');
@@ -64,7 +66,10 @@ export function TypeTable({ type }: { type: Record<string, ObjectType> }) {
             <tr key={key}>
               <td>
                 <div className={field()}>
-                  <code className={cn(code({ color: 'primary' }))}>{key}</code>
+                  <code className={cn(code({ color: 'primary' }))}>
+                    {key}
+                    {!value.required && '?'}
+                  </code>
                   {value.description ? <Info>{value.description}</Info> : null}
                 </div>
               </td>