dumi-theme-lobehub/dist/components/ApiHeader/index.d.ts

dumi-theme-lobehub is a documentation site theme package designed for dumi2. It provides a more beautiful and user-friendly development and reading experience based on @lobehub/ui

import { type ReactNode } from 'react';
import { ApiHeaderConfig } from "../../types";
/**
 * @title ApiHeaderProps
 * @category Props
 * @description ApiHeader 组件的 props 类型定义
 */
export interface ApiHeaderProps extends ApiHeaderConfig {
    /**
     * @title 组件名
     * @description ApiHeader 组件的名称
     */
    componentName?: string;
    /**
     * @title 是否默认导入
     * @description 是否默认导入组件
     * @default false
     */
    defaultImport?: boolean;
    /**
     * @title 描述
     * @description ApiHeader 组件的描述信息
     */
    description?: string;
    /**
     * @title 标题
     * @description ApiHeader 组件的标题
     */
    title: string;
}
/**
 * @title ApiHeader 配置项
 */
export interface ApiTitleProps extends ApiHeaderProps {
    /**
     * @title 服务列表
     * @description 可选，若存在则展示 API 服务列表
     */
    serviceList?: ServiceItem[];
    /**
     * @title 标题
     */
    title: string;
}
export interface ServiceItem {
    /**
     * @title 服务描述
     */
    children: string;
    /**
     * @title 服务图标
     */
    icon: ReactNode;
    /**
     * @title 服务标签
     */
    label: string;
    /**
     * @title 服务链接
     */
    url: string;
}
export declare const ApiHeader: import("react").NamedExoticComponent<ApiTitleProps & import("react-layout-kit/lib/FlexBasic").FlexBasicProps & import("react-layout-kit").CommonProps>;