theme types

opentofu · Sep 20, 2023 · a289521 · a289521
1 parent 9b35139
commit a289521
Show file tree

Hide file tree

Showing 13 changed files with 59 additions and 19 deletions.
diff --git a/src/theme/BlogLastPost/index.tsx b/src/theme/BlogLastPost/index.tsx
@@ -2,8 +2,15 @@ import React from "react";
 import PatternBg from "@site/src/components/PatternBg";
 import Button from "@site/src/components/Button";
 import Link from "@docusaurus/Link";
+import { PropBlogPostContent } from "@docusaurus/plugin-content-blog";
 
-export default function BlogLastPost({ item }) {
+type BlogLastPostProps = {
+  item: {
+    content: PropBlogPostContent;
+  };
+};
+
+export default function BlogLastPost({ item }: BlogLastPostProps) {
   const { permalink, title, date, formattedDate, description } =
     item.content.metadata;
 

diff --git a/src/theme/BlogLayout/index.tsx b/src/theme/BlogLayout/index.tsx
@@ -1,8 +1,9 @@
 import React from "react";
 
 import Layout from "@theme/Layout";
+import { Props } from "@theme/BlogLayout";
 
-export default function BlogLayout(props) {
+export default function BlogLayout(props: Props) {
   const { children, ...layoutProps } = props;
 
   return (

diff --git a/src/theme/BlogListItem/index.tsx b/src/theme/BlogListItem/index.tsx
@@ -1,8 +1,15 @@
 import Link from "@docusaurus/Link";
 import Button from "@site/src/components/Button";
 import React from "react";
+import { PropBlogPostContent } from "@docusaurus/plugin-content-blog";
 
-export default function BlogListItem({ item }) {
+type BlogListItemProps = {
+  item: {
+    content: PropBlogPostContent;
+  };
+};
+
+export default function BlogListItem({ item }: BlogListItemProps) {
   const { permalink, title, date, formattedDate, description } =
     item.content.metadata;
 

diff --git a/src/theme/BlogListItems/index.tsx b/src/theme/BlogListItems/index.tsx
@@ -1,7 +1,15 @@
 import React from "react";
 
 import BlogListItem from "@theme/BlogListItem";
-export default function BlogListItems({ items }) {
+import { PropBlogPostContent } from "@docusaurus/plugin-content-blog";
+
+type BlogListItemsProps = {
+  items: readonly {
+    content: PropBlogPostContent;
+  }[];
+};
+
+export default function BlogListItems({ items }: BlogListItemsProps) {
   return (
     <div className="max-w-7xl mx-auto grid grid-cols-1 sm:grid-cols-2 md:grid-cols-3 gap-x-6 gap-y-12 py-4 md:py-10 px-4">
       {items.map((item) => (

diff --git a/src/theme/BlogListPage/index.tsx b/src/theme/BlogListPage/index.tsx
@@ -6,8 +6,9 @@ import BlogListPaginator from "@theme/BlogListPaginator";
 import SearchMetadata from "@theme/SearchMetadata";
 import BlogListItems from "@theme/BlogListItems";
 import BlogLastPost from "@theme/BlogLastPost";
+import { Props } from "@theme/BlogListPage";
 
-export default function BlogListPage(props) {
+export default function BlogListPage(props: Props) {
   const { metadata, items } = props;
 
   const { blogDescription, blogTitle } = metadata;

diff --git a/src/theme/BlogListPaginator/index.tsx b/src/theme/BlogListPaginator/index.tsx
@@ -1,7 +1,9 @@
 import React from "react";
 
 import Button from "@site/src/components/Button";
-export default function BlogListPaginator(props) {
+import { Props } from "@theme/BlogListPaginator";
+
+export default function BlogListPaginator(props: Props) {
   const { metadata } = props;
   const { previousPage, nextPage } = metadata;
   return (

diff --git a/src/theme/BlogPostItem/Content/index.tsx b/src/theme/BlogPostItem/Content/index.tsx
@@ -3,8 +3,9 @@ import { blogPostContainerID } from "@docusaurus/utils-common";
 import { useBlogPost } from "@docusaurus/theme-common/internal";
 import MDXContent from "@theme/MDXContent";
 import TextContent from "@site/src/components/TextContent";
+import { Props } from "@theme/BlogPostItem/Content";
 
-export default function BlogPostItemContent({ children }) {
+export default function BlogPostItemContent({ children }: Props) {
   const { isBlogPostPage } = useBlogPost();
   return (
     <TextContent

diff --git a/src/theme/DocBreadcrumbs/index.tsx b/src/theme/DocBreadcrumbs/index.tsx
@@ -7,15 +7,17 @@ import Link from "@docusaurus/Link";
 
 import HomeBreadcrumbItem from "@theme/DocBreadcrumbs/Items/Home";
 
+type BreadcrumbsItemLinkProps = {
+  children: ReactNode;
+  href: string | undefined;
+  isLast: boolean;
+};
+
 function BreadcrumbsItemLink({
   children,
   href,
   isLast,
-}: {
-  children: ReactNode;
-  href: string | undefined;
-  isLast: boolean;
-}) {
+}: BreadcrumbsItemLinkProps) {
   if (isLast) {
     return (
       <span className="text-gray-600 dark:text-gray-500" itemProp="name">

diff --git a/src/theme/DocItem/Content.tsx b/src/theme/DocItem/Content.tsx
@@ -1,8 +1,9 @@
 import React from "react";
 import MDXContent from "@theme/MDXContent";
 import TextContent from "@site/src/components/TextContent";
+import { Props } from "@theme/DocItem/Content";
 
-export default function DocItemContent({ children }) {
+export default function DocItemContent({ children }: Props) {
   return (
     <TextContent className="max-w-none">
       <MDXContent>{children}</MDXContent>

diff --git a/src/theme/DocPage/Layout/Sidebar.tsx b/src/theme/DocPage/Layout/Sidebar.tsx
@@ -27,12 +27,16 @@ export default function DocPageLayoutSidebar({
   sidebar,
 }: SidebarProps) {
   const { pathname } = useLocation();
-
   return (
     <aside className={className}>
       <ResetOnSidebarChange>
         <div className="p-2 xl:p-4 text-sm xl:text-base w-full sticky top-0">
-          <DocSidebar sidebar={sidebar} path={pathname} />
+          <DocSidebar
+            sidebar={sidebar}
+            path={pathname}
+            isHidden={false}
+            onCollapse={() => {}}
+          />
         </div>
       </ResetOnSidebarChange>
     </aside>

diff --git a/src/theme/DocPage/Layout/index.tsx b/src/theme/DocPage/Layout/index.tsx
@@ -1,8 +1,8 @@
 import React from "react";
+import DocPageLayoutSidebar from "./Sidebar";
 import { useDocsSidebar } from "@docusaurus/theme-common/internal";
 import Layout from "@theme/Layout";
 import BackToTopButton from "@theme/BackToTopButton";
-import DocPageLayoutSidebar from "@theme/DocPage/Layout/Sidebar";
 import type { Props } from "@theme/DocPage/Layout";
 
 export default function DocPageLayout({ children }: Props) {

diff --git a/src/theme/DocPaginator/index.tsx b/src/theme/DocPaginator/index.tsx
@@ -6,11 +6,16 @@ export default function DocPaginator(props: Props) {
   const { previous, next } = props;
   return (
     <nav className="grid grid-cols-2 gap-3" aria-label="Docs pages">
-      {previous && <PaginatorNavLink {...previous} subLabel="Previous" />}
+      {previous && (
+        <PaginatorNavLink
+          {...previous}
+          subLabel={<>Previous</>}
+        />
+      )}
       {next && (
         <PaginatorNavLink
           {...next}
-          subLabel="Next"
+          subLabel={<>Next</>}
           isNext
           className="col-start-2"
         />

diff --git a/src/theme/PaginatorNavLink/index.tsx b/src/theme/PaginatorNavLink/index.tsx
@@ -7,8 +7,9 @@ type PaginatorNavLink = Props & {
   className?: string;
 };
 
-export default function PaginatorNavLink(props: Props) {
+export default function PaginatorNavLink(props: PaginatorNavLink) {
   const { permalink, title, subLabel, isNext, className } = props;
+
   return (
     <Link
       className={clsx(