superset2/docs/src/theme/DocVersionBanner/index.js

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import React, { useState, useEffect } from 'react';
import DocVersionBanner from '@theme-original/DocVersionBanner';
import {
  useActivePlugin,
  useDocsVersion,
  useVersions,
} from '@docusaurus/plugin-content-docs/client';
import { useLocation } from '@docusaurus/router';
import { useDocsPreferredVersion } from '@docusaurus/theme-common';
import { Dropdown } from 'antd';
import { DownOutlined } from '@ant-design/icons';

import styles from './styles.module.css';

export default function DocVersionBannerWrapper(props) {
  const activePlugin = useActivePlugin();
  const { pathname } = useLocation();
  const pluginId = activePlugin?.pluginId;
  const [versionedPath, setVersionedPath] = useState('');

  // Only show version selector for tutorials
  // Main docs, components, and developer_portal use the DocVersionBadge component instead
  const isVersioned = pluginId && ['tutorials'].includes(pluginId);

  const { preferredVersion } = useDocsPreferredVersion(pluginId);
  const versions = useVersions(pluginId);
  const version = useDocsVersion();

  // Early return if required data is not available
  if (!isVersioned || !versions || !version) {
    return <DocVersionBanner {...props} />;
  }

  // Extract the current page path relative to the version
  useEffect(() => {
    if (!pathname || !version || !pluginId) return;

    let relativePath = '';

    // Handle different version path patterns
    if (pathname.includes(`/${pluginId}/`)) {
      // Extract the part after the version
      // Example: /components/1.1.0/ui-components/button -> /ui-components/button
      const parts = pathname.split(`/${pluginId}/`);
      if (parts.length > 1) {
        const afterPluginId = parts[1];
        // Find where the version part ends
        const versionParts = afterPluginId.split('/');
        if (versionParts.length > 1) {
          // Remove the version part and join the rest
          relativePath = '/' + versionParts.slice(1).join('/');
        }
      }
    }

    setVersionedPath(relativePath);
  }, [pathname, version, pluginId]);

  // Create dropdown items for version selection
  const items = versions.map(v => {
    // Construct the URL for this version, preserving the current page
    // v.path is the version-specific path like "1.0.0" or "next"
    let versionUrl = v.path;

    if (versionedPath) {
      // Construct the full URL with the version and the current page path
      versionUrl = v.path + versionedPath;
    }

    return {
      key: v.name,
      label: (
        <a href={versionUrl}>
          {v.label}
          {v.name === version.name && ' (current)'}
          {v.name === preferredVersion?.name && ' (preferred)'}
        </a>
      ),
    };
  });

  return (
    <>
      <DocVersionBanner {...props} />
      {isVersioned && (
        <div className={styles.versionBanner}>
          <div className={styles.versionContainer}>
            <span className={styles.versionLabel}>Version:</span>
            <Dropdown menu={{ items }} trigger={['click']}>
              <a
                onClick={e => e.preventDefault()}
                className={styles.versionSelector}
              >
                {version.label} <DownOutlined />
              </a>
            </Dropdown>
          </div>
        </div>
      )}
    </>
  );
}