feat: support hiding toc

niktverd · Jul 15, 2021 · b3446a1 · b3446a1
1 parent 033a824
commit b3446a1
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/src/components/DocLayout/DocLayout.tsx b/src/components/DocLayout/DocLayout.tsx
@@ -24,6 +24,7 @@ export interface DocLayoutProps {
     headerHeight?: number;
     tocTitleIcon?: React.ReactNode;
     hideTocHeader?: boolean;
+    hideToc?: boolean;
     className?: string;
     loading?: boolean;
 }
@@ -90,9 +91,9 @@ export class DocLayout extends React.Component<DocLayoutProps> {
     }
 
     private renderToc() {
-        const {toc, router, headerHeight, tocTitleIcon, hideRight, wideFormat, hideTocHeader} = this.props;
+        const {toc, router, headerHeight, tocTitleIcon, hideRight, wideFormat, hideTocHeader, hideToc} = this.props;
 
-        if (!toc) {
+        if (!toc || hideToc) {
             return null;
         }
 

diff --git a/src/components/DocLeadingPage/DocLeadingPage.tsx b/src/components/DocLeadingPage/DocLeadingPage.tsx
@@ -21,6 +21,7 @@ export interface DocLeadingPageProps extends DocLeadingPageData {
     headerHeight?: number;
     wideFormat?: boolean;
     hideTocHeader?: boolean;
+    hideToc?: boolean;
     tocTitleIcon?: React.ReactNode;
 }
 
@@ -91,7 +92,7 @@ export const Links: React.FC<DocLinksProps> = ({links, isRoot}) => {
 
 export const DocLeadingPage: React.FC<DocLeadingPageProps> = ({
     data: {title, description, links},
-    toc, router, lang, headerHeight, wideFormat = defaultWideFormat, hideTocHeader, tocTitleIcon,
+    toc, router, lang, headerHeight, wideFormat = defaultWideFormat, hideTocHeader, hideToc, tocTitleIcon,
 }) => {
     const modes = {
         'regular-page-width': !wideFormat,
@@ -105,6 +106,7 @@ export const DocLeadingPage: React.FC<DocLeadingPageProps> = ({
             headerHeight={headerHeight}
             className={b(modes)}
             hideTocHeader={hideTocHeader}
+            hideToc={hideToc}
             tocTitleIcon={tocTitleIcon}
         >
             <span/>

diff --git a/src/components/DocPage/DocPage.tsx b/src/components/DocPage/DocPage.tsx
@@ -31,6 +31,7 @@ export interface DocPageProps extends DocPageData, Partial<DocSettings> {
     headerHeight?: number;
     tocTitleIcon?: React.ReactNode;
     hideTocHeader?: boolean;
+    hideToc?: boolean;
 
     renderLoader?: () => React.ReactNode;
     convertPathToOriginalArticle?: (path: string) => string;
@@ -91,6 +92,7 @@ class DocPage extends React.Component<DocPageInnerProps, DocPageState> {
             singlePage,
             tocTitleIcon,
             hideTocHeader,
+            hideToc,
         } = this.props;
 
         const asideMiniToc = this.renderAsideMiniToc();
@@ -114,6 +116,7 @@ class DocPage extends React.Component<DocPageInnerProps, DocPageState> {
                 tocTitleIcon={tocTitleIcon}
                 wideFormat={wideFormat}
                 hideTocHeader={hideTocHeader}
+                hideToc={hideToc}
                 loading={this.state.loading}
             >
                 <DocLayout.Center>