@docusaurus/theme-classic 0.0.0-4632 → 0.0.0-4635

package/lib/getSwizzleConfig.js

@@ -0,0 +1,102 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = getSwizzleConfig;
+
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+function getSwizzleConfig() {
+  return {
+    components: {
+      CodeBlock: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe'
+        },
+        description: 'The component used to render multi-line code blocks, generally used in Markdown files.'
+      },
+      DocSidebar: {
+        actions: {
+          wrap: 'safe',
+          eject: 'unsafe' // too much technical code in sidebar, not very safe atm
+
+        },
+        description: 'The sidebar component on docs pages'
+      },
+      Footer: {
+        actions: {
+          wrap: 'safe',
+          eject: 'unsafe' // TODO split footer into smaller parts
+
+        },
+        description: "The footer component of you site's layout"
+      },
+      NotFound: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe'
+        },
+        description: 'The global 404 page of your site, meant to be ejected and customized'
+      },
+      SearchBar: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe'
+        },
+        // TODO how to describe this one properly?
+        // By default it's an empty placeholder for the user to fill
+        description: 'The search bar component of your site, appearing in the navbar.'
+      },
+      IconArrow: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe'
+        },
+        description: 'The arrow icon component'
+      },
+      IconEdit: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe'
+        },
+        description: 'The edit icon component'
+      },
+      IconMenu: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe'
+        },
+        description: 'The menu icon component'
+      },
+      'prism-include-languages': {
+        actions: {
+          wrap: 'forbidden',
+          // not a component!
+          eject: 'safe'
+        },
+        description: 'The Prism languages to include for code block syntax highlighting. Meant to be ejected.'
+      },
+      MDXComponents: {
+        actions: {
+          wrap: 'forbidden',
+          /// TODO allow wrapping objects???
+          eject: 'safe'
+        },
+        description: 'The MDX components to use for rendering MDX files. Meant to be ejected.'
+      },
+      // TODO should probably not even appear here
+      'NavbarItem/utils': {
+        actions: {
+          wrap: 'forbidden',
+          eject: 'forbidden'
+        }
+      }
+    }
+  };
+}

package/lib/index.js

@@ -5,7 +5,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.AnnouncementBarDismissStorageKey = void 0;
 exports.default = docusaurusThemeClassic;
-exports.getSwizzleComponentList = getSwizzleComponentList;
+Object.defineProperty(exports, "getSwizzleConfig", {
+  enumerable: true,
+  get: function () {
+    return _getSwizzleConfig.default;
+  }
+});
 Object.defineProperty(exports, "validateThemeConfig", {
   enumerable: true,
   get: function () {
@@ -23,6 +28,8 @@ var _rtlcss = _interopRequireDefault(require("rtlcss"));
 
 var _themeTranslations = require("@docusaurus/theme-translations");
 
+var _getSwizzleConfig = _interopRequireDefault(require("./getSwizzleConfig"));
+
 var _validateThemeConfig = require("./validateThemeConfig");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -214,10 +221,4 @@ ${announcementBar ? AnnouncementBarInlineJavaScript : ''}
     }
 
   };
-}
-
-const swizzleAllowedComponents = ['CodeBlock', 'DocSidebar', 'Footer', 'NotFound', 'SearchBar', 'IconArrow', 'IconEdit', 'IconMenu', 'hooks/useTheme', 'prism-include-languages'];
-
-function getSwizzleComponentList() {
-  return swizzleAllowedComponents;
 }

package/lib-next/theme/Heading/index.js

@@ -8,7 +8,6 @@ import React from 'react';
 import clsx from 'clsx';
 import {translate} from '@docusaurus/Translate';
 import {useThemeConfig} from '@docusaurus/theme-common';
-import './styles.css';
 import styles from './styles.module.css';
 
 function AnchorHeading({as: As, id, ...props}) {

package/lib-next/theme/Heading/styles.module.css

@@ -17,3 +17,19 @@ See https://twitter.com/JoshWComeau/status/1332015868725891076
 .anchorWithHideOnScrollNavbar {
   scroll-margin-top: 0.5rem;
 }
+
+:global(.hash-link) {
+  opacity: 0;
+  padding-left: 0.5rem;
+  transition: opacity var(--ifm-transition-fast);
+  user-select: none;
+}
+
+:global(.hash-link::before) {
+  content: '#';
+}
+
+:global(.hash-link:focus),
+:global(*:hover > .hash-link) {
+  opacity: 1;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "0.0.0-4632",
+  "version": "0.0.0-4635",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
   "types": "src/theme-classic.d.ts",
@@ -21,15 +21,15 @@
     "format:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4632",
-    "@docusaurus/plugin-content-blog": "0.0.0-4632",
-    "@docusaurus/plugin-content-docs": "0.0.0-4632",
-    "@docusaurus/plugin-content-pages": "0.0.0-4632",
-    "@docusaurus/theme-common": "0.0.0-4632",
-    "@docusaurus/theme-translations": "0.0.0-4632",
-    "@docusaurus/utils": "0.0.0-4632",
-    "@docusaurus/utils-common": "0.0.0-4632",
-    "@docusaurus/utils-validation": "0.0.0-4632",
+    "@docusaurus/core": "0.0.0-4635",
+    "@docusaurus/plugin-content-blog": "0.0.0-4635",
+    "@docusaurus/plugin-content-docs": "0.0.0-4635",
+    "@docusaurus/plugin-content-pages": "0.0.0-4635",
+    "@docusaurus/theme-common": "0.0.0-4635",
+    "@docusaurus/theme-translations": "0.0.0-4635",
+    "@docusaurus/utils": "0.0.0-4635",
+    "@docusaurus/utils-common": "0.0.0-4635",
+    "@docusaurus/utils-validation": "0.0.0-4635",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.0.1",
@@ -42,8 +42,8 @@
     "rtlcss": "^3.3.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4632",
-    "@docusaurus/types": "0.0.0-4632",
+    "@docusaurus/module-type-aliases": "0.0.0-4635",
+    "@docusaurus/types": "0.0.0-4635",
     "@types/mdx-js__react": "^1.5.5",
     "@types/prismjs": "^1.26.0",
     "@types/rtlcss": "^3.1.2",
@@ -59,5 +59,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "71b49c9f003f9388f0e329846dce3d8ea82d5bc0"
+  "gitHead": "267eecbcba13dd00dd8b9a23bde16cfb2171ae7f"
 }

package/src/getSwizzleConfig.ts

@@ -0,0 +1,101 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import type {SwizzleConfig} from '@docusaurus/types';
+
+export default function getSwizzleConfig(): SwizzleConfig {
+  return {
+    components: {
+      CodeBlock: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe',
+        },
+        description:
+          'The component used to render multi-line code blocks, generally used in Markdown files.',
+      },
+      DocSidebar: {
+        actions: {
+          wrap: 'safe',
+          eject: 'unsafe', // too much technical code in sidebar, not very safe atm
+        },
+        description: 'The sidebar component on docs pages',
+      },
+      Footer: {
+        actions: {
+          wrap: 'safe',
+          eject: 'unsafe', // TODO split footer into smaller parts
+        },
+        description: "The footer component of you site's layout",
+      },
+      NotFound: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe',
+        },
+        description:
+          'The global 404 page of your site, meant to be ejected and customized',
+      },
+      SearchBar: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe',
+        },
+        // TODO how to describe this one properly?
+        // By default it's an empty placeholder for the user to fill
+        description:
+          'The search bar component of your site, appearing in the navbar.',
+      },
+      IconArrow: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe',
+        },
+        description: 'The arrow icon component',
+      },
+      IconEdit: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe',
+        },
+        description: 'The edit icon component',
+      },
+      IconMenu: {
+        actions: {
+          wrap: 'safe',
+          eject: 'safe',
+        },
+        description: 'The menu icon component',
+      },
+
+      'prism-include-languages': {
+        actions: {
+          wrap: 'forbidden', // not a component!
+          eject: 'safe',
+        },
+        description:
+          'The Prism languages to include for code block syntax highlighting. Meant to be ejected.',
+      },
+      MDXComponents: {
+        actions: {
+          wrap: 'forbidden', /// TODO allow wrapping objects???
+          eject: 'safe',
+        },
+        description:
+          'The MDX components to use for rendering MDX files. Meant to be ejected.',
+      },
+
+      // TODO should probably not even appear here
+      'NavbarItem/utils': {
+        actions: {
+          wrap: 'forbidden',
+          eject: 'forbidden',
+        },
+      },
+    },
+  };
+}

package/src/index.ts

@@ -207,21 +207,5 @@ ${announcementBar ? AnnouncementBarInlineJavaScript : ''}
   };
 }
 
-const swizzleAllowedComponents = [
-  'CodeBlock',
-  'DocSidebar',
-  'Footer',
-  'NotFound',
-  'SearchBar',
-  'IconArrow',
-  'IconEdit',
-  'IconMenu',
-  'hooks/useTheme',
-  'prism-include-languages',
-];
-
-export function getSwizzleComponentList(): string[] {
-  return swizzleAllowedComponents;
-}
-
+export {default as getSwizzleConfig} from './getSwizzleConfig';
 export {validateThemeConfig} from './validateThemeConfig';

package/src/theme/Heading/index.tsx

@@ -11,7 +11,6 @@ import type {Props} from '@theme/Heading';
 import {translate} from '@docusaurus/Translate';
 import {useThemeConfig} from '@docusaurus/theme-common';
 
-import './styles.css';
 import styles from './styles.module.css';
 
 function AnchorHeading({as: As, id, ...props}: Props) {

package/src/theme/Heading/styles.module.css

@@ -17,3 +17,19 @@ See https://twitter.com/JoshWComeau/status/1332015868725891076
 .anchorWithHideOnScrollNavbar {
   scroll-margin-top: 0.5rem;
 }
+
+:global(.hash-link) {
+  opacity: 0;
+  padding-left: 0.5rem;
+  transition: opacity var(--ifm-transition-fast);
+  user-select: none;
+}
+
+:global(.hash-link::before) {
+  content: '#';
+}
+
+:global(.hash-link:focus),
+:global(*:hover > .hash-link) {
+  opacity: 1;
+}

package/lib-next/theme/Heading/styles.css

@@ -1,22 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-.hash-link {
-  opacity: 0;
-  padding-left: 0.5rem;
-  transition: opacity var(--ifm-transition-fast);
-  user-select: none;
-}
-
-.hash-link::before {
-  content: '#';
-}
-
-.hash-link:focus,
-*:hover > .hash-link {
-  opacity: 1;
-}

package/src/theme/Heading/styles.css

@@ -1,22 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-.hash-link {
-  opacity: 0;
-  padding-left: 0.5rem;
-  transition: opacity var(--ifm-transition-fast);
-  user-select: none;
-}
-
-.hash-link::before {
-  content: '#';
-}
-
-.hash-link:focus,
-*:hover > .hash-link {
-  opacity: 1;
-}