@docusaurus/theme-classic 0.0.0-5670 → 0.0.0-5673

package/lib/getSwizzleConfig.js

@@ -17,13 +17,6 @@ function getSwizzleConfig() {
                 },
                 description: 'The folder containing all admonition icons',
             },
-            'Admonition/Icon/Caution': {
-                actions: {
-                    eject: 'safe',
-                    wrap: 'safe',
-                },
-                description: 'The admonition caution icon',
-            },
             'Admonition/Icon/Danger': {
                 actions: {
                     eject: 'safe',
@@ -52,6 +45,13 @@ function getSwizzleConfig() {
                 },
                 description: 'The admonition tip icon',
             },
+            'Admonition/Icon/Warning': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The admonition warning icon',
+            },
             'Admonition/Layout': {
                 actions: {
                     eject: 'safe',
@@ -101,6 +101,13 @@ function getSwizzleConfig() {
                 },
                 description: 'The component responsible for rendering a :::tip admonition type',
             },
+            'Admonition/Type/Warning': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The component responsible for rendering a :::warning admonition type',
+            },
             'Admonition/Types': {
                 actions: {
                     eject: 'safe',

package/lib/theme/Admonition/Icon/{Caution.d.ts → Warning.d.ts}

@@ -5,5 +5,5 @@
  * LICENSE file in the root directory of this source tree.
  */
 /// <reference types="react" />
-import type { Props } from '@theme/Admonition/Icon/Caution';
+import type { Props } from '@theme/Admonition/Icon/Warning';
 export default function AdmonitionIconCaution(props: Props): JSX.Element;

package/lib/theme/Admonition/Type/Caution.js

@@ -8,10 +8,10 @@ import React from 'react';
 import clsx from 'clsx';
 import Translate from '@docusaurus/Translate';
 import AdmonitionLayout from '@theme/Admonition/Layout';
-import IconCaution from '@theme/Admonition/Icon/Caution';
+import IconWarning from '@theme/Admonition/Icon/Warning';
 const infimaClassName = 'alert alert--warning';
 const defaultProps = {
-  icon: <IconCaution />,
+  icon: <IconWarning />,
   title: (
     <Translate
       id="theme.admonition.caution"
@@ -20,6 +20,8 @@ const defaultProps = {
     </Translate>
   ),
 };
+// TODO remove before v4: Caution replaced by Warning
+// see https://github.com/facebook/docusaurus/issues/7558
 export default function AdmonitionTypeCaution(props) {
   return (
     <AdmonitionLayout

package/lib/theme/Admonition/Type/Warning.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/Admonition/Type/Warning';
+export default function AdmonitionTypeWarning(props: Props): JSX.Element;

package/lib/theme/Admonition/Type/Warning.js

@@ -0,0 +1,32 @@
+/**
+ * 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 React from 'react';
+import clsx from 'clsx';
+import Translate from '@docusaurus/Translate';
+import AdmonitionLayout from '@theme/Admonition/Layout';
+import IconWarning from '@theme/Admonition/Icon/Warning';
+const infimaClassName = 'alert alert--warning';
+const defaultProps = {
+  icon: <IconWarning />,
+  title: (
+    <Translate
+      id="theme.admonition.warning"
+      description="The default label used for the Warning admonition (:::warning)">
+      warning
+    </Translate>
+  ),
+};
+export default function AdmonitionTypeWarning(props) {
+  return (
+    <AdmonitionLayout
+      {...defaultProps}
+      {...props}
+      className={clsx(infimaClassName, props.className)}>
+      {props.children}
+    </AdmonitionLayout>
+  );
+}

package/lib/theme/Admonition/Types.js

@@ -8,13 +8,14 @@ import React from 'react';
 import AdmonitionTypeNote from '@theme/Admonition/Type/Note';
 import AdmonitionTypeTip from '@theme/Admonition/Type/Tip';
 import AdmonitionTypeInfo from '@theme/Admonition/Type/Info';
-import AdmonitionTypeCaution from '@theme/Admonition/Type/Caution';
+import AdmonitionTypeWarning from '@theme/Admonition/Type/Warning';
 import AdmonitionTypeDanger from '@theme/Admonition/Type/Danger';
+import AdmonitionTypeCaution from '@theme/Admonition/Type/Caution';
 const admonitionTypes = {
   note: AdmonitionTypeNote,
   tip: AdmonitionTypeTip,
   info: AdmonitionTypeInfo,
-  caution: AdmonitionTypeCaution,
+  warning: AdmonitionTypeWarning,
   danger: AdmonitionTypeDanger,
 };
 // Undocumented legacy admonition type aliases
@@ -24,8 +25,7 @@ const admonitionAliases = {
   secondary: (props) => <AdmonitionTypeNote title="secondary" {...props} />,
   important: (props) => <AdmonitionTypeInfo title="important" {...props} />,
   success: (props) => <AdmonitionTypeTip title="success" {...props} />,
-  // TODO bad legacy mapping, warning is usually yellow, not red...
-  warning: (props) => <AdmonitionTypeDanger title="warning" {...props} />,
+  caution: AdmonitionTypeCaution,
 };
 export default {
   ...admonitionTypes,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "0.0.0-5670",
+  "version": "0.0.0-5673",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
   "types": "src/theme-classic.d.ts",
@@ -20,18 +20,18 @@
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5670",
-    "@docusaurus/mdx-loader": "0.0.0-5670",
-    "@docusaurus/module-type-aliases": "0.0.0-5670",
-    "@docusaurus/plugin-content-blog": "0.0.0-5670",
-    "@docusaurus/plugin-content-docs": "0.0.0-5670",
-    "@docusaurus/plugin-content-pages": "0.0.0-5670",
-    "@docusaurus/theme-common": "0.0.0-5670",
-    "@docusaurus/theme-translations": "0.0.0-5670",
-    "@docusaurus/types": "0.0.0-5670",
-    "@docusaurus/utils": "0.0.0-5670",
-    "@docusaurus/utils-common": "0.0.0-5670",
-    "@docusaurus/utils-validation": "0.0.0-5670",
+    "@docusaurus/core": "0.0.0-5673",
+    "@docusaurus/mdx-loader": "0.0.0-5673",
+    "@docusaurus/module-type-aliases": "0.0.0-5673",
+    "@docusaurus/plugin-content-blog": "0.0.0-5673",
+    "@docusaurus/plugin-content-docs": "0.0.0-5673",
+    "@docusaurus/plugin-content-pages": "0.0.0-5673",
+    "@docusaurus/theme-common": "0.0.0-5673",
+    "@docusaurus/theme-translations": "0.0.0-5673",
+    "@docusaurus/types": "0.0.0-5673",
+    "@docusaurus/utils": "0.0.0-5673",
+    "@docusaurus/utils-common": "0.0.0-5673",
+    "@docusaurus/utils-validation": "0.0.0-5673",
     "@mdx-js/react": "^2.1.5",
     "clsx": "^1.2.1",
     "copy-text-to-clipboard": "^3.2.0",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "2449c29e71a3f9327e597fbb3902d1ef61416b27"
+  "gitHead": "92d08bfdd2b6b8a4b7ceddab39573941abf0fe2d"
 }

package/src/getSwizzleConfig.ts

@@ -19,13 +19,6 @@ export default function getSwizzleConfig(): SwizzleConfig {
         },
         description: 'The folder containing all admonition icons',
       },
-      'Admonition/Icon/Caution': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe',
-        },
-        description: 'The admonition caution icon',
-      },
       'Admonition/Icon/Danger': {
         actions: {
           eject: 'safe',
@@ -54,6 +47,13 @@ export default function getSwizzleConfig(): SwizzleConfig {
         },
         description: 'The admonition tip icon',
       },
+      'Admonition/Icon/Warning': {
+        actions: {
+          eject: 'safe',
+          wrap: 'safe',
+        },
+        description: 'The admonition warning icon',
+      },
       'Admonition/Layout': {
         actions: {
           eject: 'safe',
@@ -110,6 +110,14 @@ export default function getSwizzleConfig(): SwizzleConfig {
         description:
           'The component responsible for rendering a :::tip admonition type',
       },
+      'Admonition/Type/Warning': {
+        actions: {
+          eject: 'safe',
+          wrap: 'safe',
+        },
+        description:
+          'The component responsible for rendering a :::warning admonition type',
+      },
       'Admonition/Types': {
         actions: {
           eject: 'safe',

package/src/theme/Admonition/Icon/{Caution.tsx → Warning.tsx}

@@ -6,7 +6,7 @@
  */
 
 import React from 'react';
-import type {Props} from '@theme/Admonition/Icon/Caution';
+import type {Props} from '@theme/Admonition/Icon/Warning';
 
 export default function AdmonitionIconCaution(props: Props): JSX.Element {
   return (

package/src/theme/Admonition/Type/Caution.tsx

@@ -10,12 +10,12 @@ import clsx from 'clsx';
 import Translate from '@docusaurus/Translate';
 import type {Props} from '@theme/Admonition/Type/Caution';
 import AdmonitionLayout from '@theme/Admonition/Layout';
-import IconCaution from '@theme/Admonition/Icon/Caution';
+import IconWarning from '@theme/Admonition/Icon/Warning';
 
 const infimaClassName = 'alert alert--warning';
 
 const defaultProps = {
-  icon: <IconCaution />,
+  icon: <IconWarning />,
   title: (
     <Translate
       id="theme.admonition.caution"
@@ -25,6 +25,8 @@ const defaultProps = {
   ),
 };
 
+// TODO remove before v4: Caution replaced by Warning
+// see https://github.com/facebook/docusaurus/issues/7558
 export default function AdmonitionTypeCaution(props: Props): JSX.Element {
   return (
     <AdmonitionLayout

package/src/theme/Admonition/Type/Warning.tsx

@@ -0,0 +1,37 @@
+/**
+ * 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 React from 'react';
+import clsx from 'clsx';
+import Translate from '@docusaurus/Translate';
+import type {Props} from '@theme/Admonition/Type/Warning';
+import AdmonitionLayout from '@theme/Admonition/Layout';
+import IconWarning from '@theme/Admonition/Icon/Warning';
+
+const infimaClassName = 'alert alert--warning';
+
+const defaultProps = {
+  icon: <IconWarning />,
+  title: (
+    <Translate
+      id="theme.admonition.warning"
+      description="The default label used for the Warning admonition (:::warning)">
+      warning
+    </Translate>
+  ),
+};
+
+export default function AdmonitionTypeWarning(props: Props): JSX.Element {
+  return (
+    <AdmonitionLayout
+      {...defaultProps}
+      {...props}
+      className={clsx(infimaClassName, props.className)}>
+      {props.children}
+    </AdmonitionLayout>
+  );
+}

package/src/theme/Admonition/Types.tsx

@@ -9,15 +9,16 @@ import React from 'react';
 import AdmonitionTypeNote from '@theme/Admonition/Type/Note';
 import AdmonitionTypeTip from '@theme/Admonition/Type/Tip';
 import AdmonitionTypeInfo from '@theme/Admonition/Type/Info';
-import AdmonitionTypeCaution from '@theme/Admonition/Type/Caution';
+import AdmonitionTypeWarning from '@theme/Admonition/Type/Warning';
 import AdmonitionTypeDanger from '@theme/Admonition/Type/Danger';
+import AdmonitionTypeCaution from '@theme/Admonition/Type/Caution';
 import type AdmonitionTypes from '@theme/Admonition/Types';
 
 const admonitionTypes: typeof AdmonitionTypes = {
   note: AdmonitionTypeNote,
   tip: AdmonitionTypeTip,
   info: AdmonitionTypeInfo,
-  caution: AdmonitionTypeCaution,
+  warning: AdmonitionTypeWarning,
   danger: AdmonitionTypeDanger,
 };
 
@@ -28,8 +29,7 @@ const admonitionAliases: typeof AdmonitionTypes = {
   secondary: (props) => <AdmonitionTypeNote title="secondary" {...props} />,
   important: (props) => <AdmonitionTypeInfo title="important" {...props} />,
   success: (props) => <AdmonitionTypeTip title="success" {...props} />,
-  // TODO bad legacy mapping, warning is usually yellow, not red...
-  warning: (props) => <AdmonitionTypeDanger title="warning" {...props} />,
+  caution: AdmonitionTypeCaution,
 };
 
 export default {

package/src/theme-classic.d.ts

@@ -74,6 +74,8 @@ declare module '@theme/Admonition/Type/Tip' {
   export default function AdmonitionTypeTip(props: Props): JSX.Element;
 }
 
+// TODO remove before v4: Caution replaced by Warning
+// see https://github.com/facebook/docusaurus/issues/7558
 declare module '@theme/Admonition/Type/Caution' {
   import type {Props as AdmonitionProps} from '@theme/Admonition';
 
@@ -81,6 +83,13 @@ declare module '@theme/Admonition/Type/Caution' {
   export default function AdmonitionTypeCaution(props: Props): JSX.Element;
 }
 
+declare module '@theme/Admonition/Type/Warning' {
+  import type {Props as AdmonitionProps} from '@theme/Admonition';
+
+  export interface Props extends AdmonitionProps {}
+  export default function AdmonitionTypeWarning(props: Props): JSX.Element;
+}
+
 declare module '@theme/Admonition/Type/Danger' {
   import type {Props as AdmonitionProps} from '@theme/Admonition';
 
@@ -128,12 +137,12 @@ declare module '@theme/Admonition/Icon/Tip' {
   export default function AdmonitionIconTip(props: Props): JSX.Element;
 }
 
-declare module '@theme/Admonition/Icon/Caution' {
+declare module '@theme/Admonition/Icon/Warning' {
   import type {ComponentProps} from 'react';
 
   export interface Props extends ComponentProps<'svg'> {}
 
-  export default function AdmonitionIconCaution(props: Props): JSX.Element;
+  export default function AdmonitionIconWarning(props: Props): JSX.Element;
 }
 
 declare module '@theme/Admonition/Icon/Danger' {