@logicflow/dumi-theme-simple/dist/slots/Header/index.d.ts

Simple website theme based on dumi2.

import React from 'react';
import { INav } from './Navs';
import type { IC } from '../../types';
export type HeaderProps = {
    pathPrefix?: string;
    /** 子标题 */
    subTitle?: React.ReactNode;
    /** 子标题的链接 */
    subTitleHref?: string;
    /** 文档和演示的菜单数据 */
    navs?: INav[];
    /** 是否显示搜索框 */
    showSearch?: boolean;
    /** 是否显示 Github 图标 */
    showGithubCorner?: boolean;
    /** 是否显示 Github Star */
    showGithubStar?: boolean;
    /** 是否显示切换语言选项 */
    showLanguageSwitcher?: boolean;
    /**
     * 国内镜像相关的信息
     */
    internalSite?: {
        url: string;
        name: object;
    };
    /** 切换语言的回调 */
    onLanguageChange?: (language: string) => void;
    /** 是否二维码 */
    showWxQrcode?: boolean;
    /** 自定义 logo */
    logo?: {
        img?: React.ReactNode;
        link?: string;
    };
    siteUrl?: string;
    /** github 仓库地址 */
    githubUrl?: string;
    /** 默认语言 */
    defaultLanguage?: 'zh' | 'en';
    /** 自定义 Link */
    Link?: React.ComponentType<any>;
    /** 底色是否透明 */
    transparent?: boolean;
    /** 是否首页模式 */
    isHomePage?: boolean;
    /** 项目 root 域名 */
    rootDomain?: string;
    /**
     * 当前版本
     */
    version?: string;
    /** 展示版本切换 */
    versions?: {
        [key: string]: string;
    };
    /** 展示周边生态 */
    ecosystems?: Array<{
        name: Record<string /** zh, en */, string>;
        url: string;
    }>;
    /** 头部搜索框配置 */
    searchOptions?: {
        docSearchOptions: {
            versionV3: boolean;
            apiKey: string;
            indexName: string;
            appId: string;
        };
    };
    announcement?: {
        title: IC;
        icon: string;
        link: {
            url: string;
            text: IC;
        };
    };
};
export declare const Header: React.FC<Partial<HeaderProps>>;