docusaurus/packages/docusaurus-theme-classic/src/getSwizzleConfig.ts

/**
 * 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';

/* eslint sort-keys: "error" */

export default function getSwizzleConfig(): SwizzleConfig {
  return {
    components: {
      CodeBlock: {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'The component used to render multi-line code blocks, generally used in Markdown files.',
      },
      ColorModeToggle: {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'The color mode toggle to switch between light and dark mode.',
      },
      DocSidebar: {
        actions: {
          eject: 'unsafe', // Too much technical code in sidebar, not very safe atm
          wrap: 'safe',
        },
        description: 'The sidebar component on docs pages',
      },
      Footer: {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: "The footer component of you site's layout",
      },
      'Footer/Copyright': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The footer copyright',
      },
      'Footer/Layout': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The footer main layout component',
      },
      'Footer/LinkItem': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The footer link item component',
      },
      'Footer/Links': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The footer component rendering the footer links',
      },
      'Footer/Links/MultiColumn': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'The footer component rendering the footer links with a multi-column layout',
      },
      'Footer/Links/Simple': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'The footer component rendering the footer links with a simple layout (single row)',
      },
      'Footer/Logo': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The footer logo',
      },
      'Icon/Arrow': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The arrow icon component',
      },
      'Icon/DarkMode': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The dark mode icon component.',
      },
      'Icon/Edit': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The edit icon component',
      },
      'Icon/LightMode': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The light mode icon component.',
      },
      'Icon/Menu': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The menu icon component',
      },
      MDXComponents: {
        actions: {
          eject: 'safe',
          wrap: 'forbidden', /// TODO allow wrapping objects???
        },
        description:
          'The MDX components to use for rendering MDX files. Meant to be ejected.',
      },
      'MDXComponents/A': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'The component used to render <a> tags and Markdown links in MDX',
      },
      'MDXComponents/Code': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'The component used to render <code> tags and Markdown code blocks in MDX',
      },
      'MDXComponents/Details': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The component used to render <details> tags in MDX',
      },
      'MDXComponents/Head': {
        actions: {
          eject: 'forbidden',
          wrap: 'forbidden',
        },
        description:
          'Technical component used to assign metadata (generally for SEO purpose) to the current MDX document',
      },
      'MDXComponents/Heading': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'The component used to render heading tags (<h1>, <h2>...) and Markdown headings in MDX',
      },
      'MDXComponents/Img': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'The component used to render <img> tags and Markdown images in MDX',
      },
      'MDXComponents/Pre': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description: 'The component used to render <pre> tags in MDX',
      },
      'MDXComponents/Ul': {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'The component used to render <ul> tags and Markdown unordered lists in MDX',
      },
      MDXContent: {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'A component wrapping all MDX content and providing the MDXComponents to the MDX context',
      },
      'NavbarItem/ComponentTypes': {
        actions: {
          eject: 'safe',
          wrap: 'forbidden',
        },
        description:
          'The Navbar item components mapping. Can be ejected to add custom navbar item types. See https://github.com/facebook/docusaurus/issues/7227.',
      },
      NotFound: {
        actions: {
          eject: 'safe',
          wrap: 'safe',
        },
        description:
          'The global 404 page of your site, meant to be ejected and customized',
      },
      SearchBar: {
        actions: {
          eject: 'safe',
          wrap: '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.',
      },
      'prism-include-languages': {
        actions: {
          eject: 'safe',
          wrap: 'forbidden', // Not a component!
        },
        description:
          'The Prism languages to include for code block syntax highlighting. Meant to be ejected.',
      },
    },
  };
}