From 733c96c2553a69c86307b46635200c6c58f63698 Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Mon, 10 Apr 2023 12:56:43 +0100 Subject: [PATCH] feat: Support `@defaultValue` (#9363) --- .../website/src/components/documentation/tsdoc/TSDoc.tsx | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/apps/website/src/components/documentation/tsdoc/TSDoc.tsx b/apps/website/src/components/documentation/tsdoc/TSDoc.tsx index 6742f134a..3f2e471e3 100644 --- a/apps/website/src/components/documentation/tsdoc/TSDoc.tsx +++ b/apps/website/src/components/documentation/tsdoc/TSDoc.tsx @@ -6,7 +6,7 @@ import { Fragment, useCallback, type ReactNode } from 'react'; import { ItemLink } from '../../ItemLink'; import { SyntaxHighlighter } from '../../SyntaxHighlighter'; import { resolveItemURI } from '../util'; -import { DeprecatedBlock, ExampleBlock, RemarksBlock, SeeBlock } from './BlockComment'; +import { DefaultValueBlock, DeprecatedBlock, ExampleBlock, RemarksBlock, SeeBlock } from './BlockComment'; export function TSDoc({ item, tsdoc }: { item: ApiItem; tsdoc: DocNode }): JSX.Element { const createNode = useCallback( @@ -84,6 +84,10 @@ export function TSDoc({ item, tsdoc }: { item: ApiItem; tsdoc: DocNode }): JSX.E (block) => block.blockTag.tagName.toUpperCase() === StandardTags.example.tagNameWithUpperCase, ); + const defaultValueBlock = comment.customBlocks.find( + (block) => block.blockTag.tagName.toUpperCase() === StandardTags.defaultValue.tagNameWithUpperCase, + ); + return (
{comment.deprecatedBlock ? ( @@ -91,6 +95,9 @@ export function TSDoc({ item, tsdoc }: { item: ApiItem; tsdoc: DocNode }): JSX.E ) : null} {comment.summarySection ? createNode(comment.summarySection) : null} {comment.remarksBlock ? {createNode(comment.remarksBlock.content)} : null} + {defaultValueBlock ? ( + {createNode(defaultValueBlock.content)} + ) : null} {exampleBlocks.length ? exampleBlocks.map((block, idx) => {createNode(block.content)}) : null}