From 0ef77c70e2d0b84be0659fb3bc64588644117118 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 26 Jan 2024 11:31:32 -0700 Subject: [PATCH 1/4] Add a ReleaseTag component that displays its release status --- docs/shared/ApiDoc/DocBlock.js | 29 +++++++++++++++++++++++++++++ docs/shared/ApiDoc/index.js | 9 ++++++++- 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/shared/ApiDoc/DocBlock.js b/docs/shared/ApiDoc/DocBlock.js index 18e29d26d19..28ee46b305a 100644 --- a/docs/shared/ApiDoc/DocBlock.js +++ b/docs/shared/ApiDoc/DocBlock.js @@ -11,10 +11,12 @@ export function DocBlock({ example = false, remarksCollapsible = false, deprecated = false, + releaseTag = false, }) { return ( {deprecated && } + {releaseTag && } {summary && } {remarks && ( + This is in{" "} + + {item.releaseTag.toLowerCase()} stage + {" "} + and is subject to breaking changes. + + ); +} + +ReleaseTag.propTypes = { + canonicalReference: PropTypes.string.isRequired, +}; diff --git a/docs/shared/ApiDoc/index.js b/docs/shared/ApiDoc/index.js index 4173bdebe62..06728b10116 100644 --- a/docs/shared/ApiDoc/index.js +++ b/docs/shared/ApiDoc/index.js @@ -1,5 +1,12 @@ export { useApiDocContext } from "./Context"; -export { DocBlock, Deprecated, Example, Remarks, Summary } from "./DocBlock"; +export { + DocBlock, + Deprecated, + Example, + Remarks, + ReleaseTag, + Summary, +} from "./DocBlock"; export { PropertySignatureTable } from "./PropertySignatureTable"; export { ApiDocHeading, SubHeading, SectionHeading } from "./Heading"; export { InterfaceDetails } from "./InterfaceDetails"; From 300d765ea0f482cc89ab2137f54180a99dc526cc Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 26 Jan 2024 11:34:14 -0700 Subject: [PATCH 2/4] Remove unused import --- docs/shared/ApiDoc/PropertySignatureTable.js | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/shared/ApiDoc/PropertySignatureTable.js b/docs/shared/ApiDoc/PropertySignatureTable.js index b25a9fd0810..63ca31bf01d 100644 --- a/docs/shared/ApiDoc/PropertySignatureTable.js +++ b/docs/shared/ApiDoc/PropertySignatureTable.js @@ -7,7 +7,6 @@ import { FunctionSignature, useApiDocContext, ApiDocHeading, - SectionHeading, } from "."; import { GridItem, Text } from "@chakra-ui/react"; import { ResponsiveGrid } from "./ResponsiveGrid"; From 072afdb7a98375ea58b21f92e2ad3e6396fce660 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 26 Jan 2024 11:34:21 -0700 Subject: [PATCH 3/4] Show release tag on properties --- docs/shared/ApiDoc/PropertySignatureTable.js | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/shared/ApiDoc/PropertySignatureTable.js b/docs/shared/ApiDoc/PropertySignatureTable.js index 63ca31bf01d..40fa53b3df6 100644 --- a/docs/shared/ApiDoc/PropertySignatureTable.js +++ b/docs/shared/ApiDoc/PropertySignatureTable.js @@ -104,6 +104,7 @@ export function PropertySignatureTable({ summary remarks remarkCollapsible + releaseTag /> From 447816e13b98a0ba38980b172fbabaa8437ff477 Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 26 Jan 2024 11:44:46 -0700 Subject: [PATCH 4/4] Show alpha/beta status for functions --- docs/shared/ApiDoc/Function.js | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/shared/ApiDoc/Function.js b/docs/shared/ApiDoc/Function.js index 7cf0e8cbc3d..aad711fe8f7 100644 --- a/docs/shared/ApiDoc/Function.js +++ b/docs/shared/ApiDoc/Function.js @@ -109,7 +109,12 @@ export function FunctionDetails({ headingLevel={headingLevel} since /> - + {item.comment?.examples.length == 0 ? null : ( <>