fix(theme-common): allow details to not provide a summary (#7267)

facebook · Apr 29, 2022 · 41f5371 · 41f5371
1 parent e053f39
commit 41f5371
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/packages/docusaurus-theme-classic/src/theme/MDXComponents/Details.tsx b/packages/docusaurus-theme-classic/src/theme/MDXComponents/Details.tsx
@@ -13,9 +13,8 @@ export default function MDXDetails(props: Props): JSX.Element {
   const items = React.Children.toArray(props.children) as ReactElement[];
   // Split summary item from the rest to pass it as a separate prop to the
   // Details theme component
-  const summary: ReactElement<ComponentProps<'summary'>> = items.find(
-    (item) => item?.props?.mdxType === 'summary',
-  )!;
+  const summary: ReactElement<ComponentProps<'summary'>> | undefined =
+    items.find((item) => item?.props?.mdxType === 'summary');
   const children = <>{items.filter((item) => item !== summary)}</>;
 
   return (

diff --git a/packages/docusaurus-theme-common/src/components/Details/index.tsx b/packages/docusaurus-theme-common/src/components/Details/index.tsx
@@ -91,7 +91,7 @@ export function Details({
           // setOpen(false);
         }
       }}>
-      {summary}
+      {summary || <summary>Details</summary>}
 
       <Collapsible
         lazy={false} // Content might matter for SEO in this case

diff --git a/website/_dogfooding/_pages tests/markdownPageTests.md b/website/_dogfooding/_pages tests/markdownPageTests.md
@@ -175,3 +175,11 @@ Code tag + double pipe: <code>||</code>
 ![](/4/图片.png)
 
 ![](/4/docu.png)
+
+## Details
+
+<details>
+
+Details without a summary
+
+</details>