Rename Drafted to Draft and move under theme/ContentVisibility

facebook · Aug 8, 2024 · 0d7d7e8 · 0d7d7e8
1 parent a852c69
commit 0d7d7e8
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 30 deletions.
diff --git a/packages/docusaurus-theme-classic/src/theme-classic.d.ts b/packages/docusaurus-theme-classic/src/theme-classic.d.ts
@@ -1602,20 +1602,20 @@ declare module '@theme/Tag' {
   export default function Tag(props: Props): JSX.Element;
 }
 
-declare module '@theme/Unlisted' {
+declare module '@theme/ContentVisibility/Unlisted' {
   export interface Props {
     className?: string;
   }
 
   export default function Unlisted(props: Props): JSX.Element;
 }
 
-declare module '@theme/Drafted' {
+declare module '@theme/ContentVisibility/Draft' {
   export interface Props {
     className?: string;
   }
 
-  export default function Unlisted(props: Props): JSX.Element;
+  export default function Draft(props: Props): JSX.Element;
 }
 
 declare module '@theme/prism-include-languages' {

diff --git a/packages/docusaurus-theme-classic/src/theme/BlogPostPage/index.tsx b/packages/docusaurus-theme-classic/src/theme/BlogPostPage/index.tsx
@@ -19,8 +19,8 @@ import BlogPostPageMetadata from '@theme/BlogPostPage/Metadata';
 import BlogPostPageStructuredData from '@theme/BlogPostPage/StructuredData';
 import TOC from '@theme/TOC';
 import type {Props} from '@theme/BlogPostPage';
-import Unlisted from '@theme/Unlisted';
-import Drafted from '@theme/Drafted';
+import Unlisted from '@theme/ContentVisibility/Unlisted';
+import Draft from '@theme/ContentVisibility/Draft';
 import type {BlogSidebar} from '@docusaurus/plugin-content-blog';
 
 function BlogPostPageContent({
@@ -50,7 +50,7 @@ function BlogPostPageContent({
         ) : undefined
       }>
       {(unlisted || frontMatter.unlisted) && <Unlisted />}
-      {frontMatter.draft && <Drafted />}
+      {frontMatter.draft && <Draft />}
 
       <BlogPostItem>{children}</BlogPostItem>
 

diff --git a/packages/docusaurus-theme-classic/src/theme/BlogTagsPostsPage/index.tsx b/packages/docusaurus-theme-classic/src/theme/BlogTagsPostsPage/index.tsx
@@ -20,7 +20,7 @@ import BlogListPaginator from '@theme/BlogListPaginator';
 import SearchMetadata from '@theme/SearchMetadata';
 import type {Props} from '@theme/BlogTagsPostsPage';
 import BlogPostItems from '@theme/BlogPostItems';
-import Unlisted from '@theme/Unlisted';
+import Unlisted from '@theme/ContentVisibility/Unlisted';
 import Heading from '@theme/Heading';
 
 function BlogTagsPostsPageMetadata({tag}: Props): JSX.Element {

diff --git a/...theme-classic/src/theme/Drafted/index.tsx → ...c/theme/ContentVisibility/Draft/index.tsx b/...theme-classic/src/theme/Drafted/index.tsx → ...c/theme/ContentVisibility/Draft/index.tsx
@@ -9,19 +9,19 @@ import React from 'react';
 import clsx from 'clsx';
 import {
   ThemeClassNames,
-  DraftedBannerTitle,
-  DraftedBannerMessage,
+  DraftBannerTitle,
+  DraftBannerMessage,
 } from '@docusaurus/theme-common';
 import Admonition from '@theme/Admonition';
-import type {Props} from '@theme/Drafted';
+import type {Props} from '@theme/ContentVisibility/Draft';
 
-export default function Drafted({className}: Props): JSX.Element | null {
+export default function Draft({className}: Props): JSX.Element | null {
   return (
     <Admonition
       type="caution"
-      title={<DraftedBannerTitle />}
-      className={clsx(className, ThemeClassNames.common.draftedBanner)}>
-      <DraftedBannerMessage />
+      title={<DraftBannerTitle />}
+      className={clsx(className, ThemeClassNames.common.draftBanner)}>
+      <DraftBannerMessage />
     </Admonition>
   );
 }
diff --git a/...heme-classic/src/theme/Unlisted/index.tsx → ...heme/ContentVisibility/Unlisted/index.tsx b/...heme-classic/src/theme/Unlisted/index.tsx → ...heme/ContentVisibility/Unlisted/index.tsx
@@ -14,7 +14,7 @@ import {
   UnlistedMetadata,
 } from '@docusaurus/theme-common';
 import Admonition from '@theme/Admonition';
-import type {Props} from '@theme/Unlisted';
+import type {Props} from '@theme/ContentVisibility/Unlisted';
 
 function UnlistedBanner({className}: Props) {
   return (

diff --git a/packages/docusaurus-theme-classic/src/theme/DocItem/Layout/index.tsx b/packages/docusaurus-theme-classic/src/theme/DocItem/Layout/index.tsx
@@ -17,10 +17,10 @@ import DocItemTOCMobile from '@theme/DocItem/TOC/Mobile';
 import DocItemTOCDesktop from '@theme/DocItem/TOC/Desktop';
 import DocItemContent from '@theme/DocItem/Content';
 import DocBreadcrumbs from '@theme/DocBreadcrumbs';
-import Unlisted from '@theme/Unlisted';
+import Unlisted from '@theme/ContentVisibility/Unlisted';
+import Draft from '@theme/ContentVisibility/Draft';
 import type {Props} from '@theme/DocItem/Layout';
 
-import Drafted from '@theme/Drafted';
 import styles from './styles.module.css';
 
 /**
@@ -56,7 +56,7 @@ export default function DocItemLayout({children}: Props): JSX.Element {
     <div className="row">
       <div className={clsx('col', !docTOC.hidden && styles.docItemCol)}>
         {(unlisted || frontMatter.unlisted) && <Unlisted />}
-        {frontMatter.draft && <Drafted />}
+        {frontMatter.draft && <Draft />}
         <DocVersionBanner />
         <div className={styles.docItemContainer}>
           <article>

diff --git a/packages/docusaurus-theme-classic/src/theme/DocTagDocListPage/index.tsx b/packages/docusaurus-theme-classic/src/theme/DocTagDocListPage/index.tsx
@@ -17,7 +17,7 @@ import {
 import Translate, {translate} from '@docusaurus/Translate';
 import SearchMetadata from '@theme/SearchMetadata';
 import type {Props} from '@theme/DocTagDocListPage';
-import Unlisted from '@theme/Unlisted';
+import Unlisted from '@theme/ContentVisibility/Unlisted';
 import Heading from '@theme/Heading';
 
 // Very simple pluralization: probably good enough for now

diff --git a/packages/docusaurus-theme-classic/src/theme/MDXPage/index.tsx b/packages/docusaurus-theme-classic/src/theme/MDXPage/index.tsx
@@ -15,11 +15,11 @@ import {
 import Layout from '@theme/Layout';
 import MDXContent from '@theme/MDXContent';
 import TOC from '@theme/TOC';
-import Unlisted from '@theme/Unlisted';
+import Unlisted from '@theme/ContentVisibility/Unlisted';
+import Draft from '@theme/ContentVisibility/Draft';
 import type {Props} from '@theme/MDXPage';
 
 import EditMetaRow from '@theme/EditMetaRow';
-import Drafted from '@theme/Drafted';
 import styles from './styles.module.css';
 
 export default function MDXPage(props: Props): JSX.Element {
@@ -62,7 +62,7 @@ export default function MDXPage(props: Props): JSX.Element {
           <div className={clsx('row', styles.mdxPageWrapper)}>
             <div className={clsx('col', !hideTableOfContents && 'col--8')}>
               {(unlisted || frontMatter.unlisted) && <Unlisted />}
-              {frontMatter.draft && <Drafted />}
+              {frontMatter.draft && <Draft />}
               <article>
                 <MDXContent>
                   <MDXPageContent />

diff --git a/packages/docusaurus-theme-common/src/index.ts b/packages/docusaurus-theme-common/src/index.ts
@@ -125,7 +125,7 @@ export {
   UnlistedMetadata,
 } from './utils/unlistedUtils';
 
-export {DraftedBannerTitle, DraftedBannerMessage} from './utils/draftedUtils';
+export {DraftBannerTitle, DraftBannerMessage} from './utils/draftUtils';
 
 export {
   ErrorBoundaryTryAgainButton,

diff --git a/packages/docusaurus-theme-common/src/utils/ThemeClassNames.ts b/packages/docusaurus-theme-common/src/utils/ThemeClassNames.ts
@@ -43,7 +43,7 @@ export const ThemeClassNames = {
     codeBlock: 'theme-code-block',
     admonition: 'theme-admonition',
     unlistedBanner: 'theme-unlisted-banner',
-    draftedBanner: 'theme-drafted-banner',
+    draftBanner: 'theme-drafted-banner',
 
     admonitionType: (type: string) => `theme-admonition-${type}`,
   },

diff --git a/...s-theme-common/src/utils/draftedUtils.tsx → ...rus-theme-common/src/utils/draftUtils.tsx b/...s-theme-common/src/utils/draftedUtils.tsx → ...rus-theme-common/src/utils/draftUtils.tsx
@@ -8,20 +8,20 @@
 import React from 'react';
 import Translate from '@docusaurus/Translate';
 
-export function DraftedBannerTitle(): JSX.Element {
+export function DraftBannerTitle(): JSX.Element {
   return (
     <Translate
-      id="theme.draftedContent.title"
+      id="theme.draftContent.title"
       description="The drafted content banner title">
       Drafted page
     </Translate>
   );
 }
 
-export function DraftedBannerMessage(): JSX.Element {
+export function DraftBannerMessage(): JSX.Element {
   return (
     <Translate
-      id="theme.draftedContent.message"
+      id="theme.draftContent.message"
       description="The drafted content banner message">
       This page is drafted and will be excluded from production build.
     </Translate>

diff --git a/packages/docusaurus-theme-translations/locales/base/theme-common.json b/packages/docusaurus-theme-translations/locales/base/theme-common.json
@@ -123,8 +123,8 @@
   "theme.docs.versions.unmaintainedVersionLabel___DESCRIPTION": "The label used to tell the user that he's browsing an unmaintained doc version",
   "theme.docs.versions.unreleasedVersionLabel": "This is unreleased documentation for {siteTitle} {versionLabel} version.",
   "theme.docs.versions.unreleasedVersionLabel___DESCRIPTION": "The label used to tell the user that he's browsing an unreleased doc version",
-  "theme.draftedContent.message": "This page is drafted and will be excluded from production build.",
-  "theme.draftedContent.title": "Drafted page",
+  "theme.draftContent.title": "Draft page",
+  "theme.draftContent.message": "This page is a draft and will be excluded from production build.",
   "theme.lastUpdated.atDate": " on {date}",
   "theme.lastUpdated.atDate___DESCRIPTION": "The words used to describe on which date a page has been last updated",
   "theme.lastUpdated.byUser": " by {user}",