@antv/dumi-theme-antv 0.5.3 → 0.5.4-beta.1

package/dist/slots/CodeEditor/index.d.ts

@@ -1,62 +0,0 @@
-import React from 'react';
-export declare type CodeEditorProps = {
-    /**
-     * 标题
-     */
-    title?: string;
-    /**
-     * 示例的 id
-     */
-    exampleId: string;
-    /**
-     * 输入的源码
-     */
-    source: string;
-    /**
-     * 相对地址
-     */
-    relativePath?: string;
-    /**
-     * 是否全屏状态
-     */
-    isFullscreen?: boolean;
-    /**
-     * 在一个文档中有多个 DEMO 的时候，需要有不同的 dom id
-     */
-    replaceId?: string;
-    /**
-     * 点击全屏按钮
-     */
-    onFullscreen: (isFullScreen: boolean) => void;
-    /**
-     * 初始化
-     */
-    onReady: () => void;
-    /**
-     * 销毁
-     */
-    onDestroy: () => void;
-    /**
-     * 执行出错的时候，回调，方便上层做显示
-     */
-    onError: (e: any) => void;
-    /**
-     * playground 的一些配置
-     */
-    playground: {
-        container?: string;
-        playgroundDidMount?: string;
-        playgroundWillUnmount?: string;
-        dependencies?: {
-            [key: string]: string;
-        };
-        devDependencies?: {
-            [key: string]: string;
-        };
-        htmlCodeTemplate?: string;
-    };
-};
-/**
- * 代码编辑器
- */
-export declare const CodeEditor: React.FC<CodeEditorProps>;

package/dist/slots/CodeEditor/utils.d.ts

@@ -1,42 +0,0 @@
-export declare function replaceFetchUrl(sourceCode: string): string;
-/**
- * 通过代码提取代码片段的 pkg 依赖
- * @param sourceCode
- */
-export declare function extractImportDeps(sourceCode: string): any;
-export declare function getCodeSandboxConfig(title: string, sourceCode: string, fileExtension: string, deps: any, devDependencies: any, playground: any): {
-    files: {
-        [key: string]: any;
-    };
-};
-export declare function getRiddleConfig(title: string, sourceCode: string, fileExtension: string, deps: any, devDependencies: any, playground: any): {
-    title: string;
-    js: string;
-    html: any;
-    json: string;
-};
-export declare function getStackblitzConfig(title: string, sourceCode: string, fileExtension: string, deps: any, devDependencies: any, playground: any): {
-    title: string;
-    description: string;
-    template: any;
-    dependencies: any;
-    files: {
-        [x: string]: any;
-        'index.html': any;
-    };
-};
-export declare function getHtmlCodeTemplate(title: string, sourceCode: string, fileExtension: string, deps: any, devDependencies: any, playground: any): any;
-export declare function replaceInsertCss(str: string, lang: string): string;
-/**
- * 执行代码
- * @param code 运行的代码
- * @param playgroundScriptContainer 运行的节点
- * @param container 代码中 container dom
- * @param replaceId rid
- * @param cb 回调错误
- */
-export declare function execute(code: string, playgroundScriptContainer: string, container: string, replaceId?: string): void;
-/**
- * 编译代码
- */
-export declare function compile(value: string, relativePath: string, es5?: boolean): any;

package/dist/slots/CodePreview/CodeHeader.d.ts

@@ -1,19 +0,0 @@
-import React from 'react';
-export declare type CodeHeaderProps = {
-    /**
-     * 代码的标题
-     */
-    title: string;
-    /**
-     * 代码的路径
-     */
-    relativePath: string;
-    /**
-     * GitHub 的地址，用于拼接最后 GitHub 编辑地址
-     */
-    githubUrl: string;
-};
-/**
- * 组件的 header
- */
-export declare const CodeHeader: React.FC<any>;

package/dist/slots/CodePreview/index.d.ts

@@ -1,25 +0,0 @@
-import React from 'react';
-export declare type CodePreviewProps = {
-    /**
-     * 在文档中预览
-     */
-    isPlayground: boolean;
-    /**
-     * id
-     */
-    exampleId: string;
-    /**
-     * 预览页面头部组件，用于显示 demo 名称，一些操作栏等
-     */
-    header?: React.ReactElement;
-    /**
-     * 需要展示的错误信息
-     */
-    error: any;
-};
-/**
- * DEMO 预览页面的预览，主要包含有：
- * 1. 一些 header 菜单
- * 2. 错误预览
- */
-export declare const CodePreview: React.FC<CodePreviewProps>;

package/dist/slots/CodeRunner/index.d.ts

@@ -1,17 +0,0 @@
-import React from 'react';
-import { ExampleTopic } from '../../types';
-declare type CodeRunnerProps = {
-    isPlayground?: boolean;
-    topic: string;
-    example: string;
-    demo: string;
-    exampleTopics: ExampleTopic[];
-    size?: number;
-    replaceId?: string;
-    notFound?: React.ReactElement;
-};
-/**
- * 代码编辑器 + 代码预览区域
- */
-export declare const CodeRunner: React.FC<CodeRunnerProps>;
-export {};

package/dist/slots/CodeRunner/utils.d.ts

@@ -1,11 +0,0 @@
-import { Demo, ExampleTopic } from '../../types';
-/**
- * 将数据结构转化成 map，便于后续检索的速度
- * @param exampleTopics
- * @returns
- */
-export declare function getExampleTopicMap(exampleTopics: ExampleTopic[]): Map<string, Demo>;
-/**
- * 从 Context 信息中，获取到 Example 相关的信息，用于页面渲染
- */
-export declare function getDemoInfo(exampleTopics: ExampleTopic[], topic: string, example: string, demo: string): Demo;

package/dist/slots/Companies/index.d.ts

@@ -1,13 +0,0 @@
-import React from 'react';
-declare type Company = {
-    name: string;
-    img: string;
-};
-interface CompaniesProps {
-    title: any;
-    companies: Company[];
-    className?: string;
-    style?: React.CSSProperties;
-}
-export declare const Companies: React.FC<CompaniesProps>;
-export {};

package/dist/slots/ContentTable/index.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-import './index.module.less';
-/**
- * 文档右侧的指示器（table of content）
- */
-export declare const ContentTable: React.FC<{}>;

package/dist/slots/Detail/News.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-import { IC } from '../../types';
-export interface NewsProps {
-    index?: number;
-    type: IC;
-    title: IC;
-    date: string;
-    link: string;
-    subTitle?: string;
-    img?: string;
-}
-export declare const News: React.FC<NewsProps>;

package/dist/slots/Detail/index.d.ts

@@ -1,30 +0,0 @@
-import React from 'react';
-import { IC } from '../../types';
-import { NewsProps } from './News';
-declare type DetailButtonProps = {
-    text: IC;
-    link: string;
-    style?: React.CSSProperties;
-    type?: string;
-    shape?: 'round' | 'square';
-    icon?: string;
-};
-declare type DetailProps = {
-    className?: string;
-    style?: React.CSSProperties;
-    title: IC;
-    engine?: IC;
-    description: IC;
-    image?: string;
-    imageStyle?: React.CSSProperties;
-    buttons?: DetailButtonProps[];
-    githubUrl: string;
-    showGithubStars?: boolean;
-    news: NewsProps[];
-};
-/**
- * Index.技术栈的描述区域！
- * 各自配置
- */
-export declare const Detail: React.FC<DetailProps>;
-export {};

package/dist/slots/ExampleSider/index.d.ts

@@ -1,21 +0,0 @@
-import React from 'react';
-import { Demo, ExampleTopic } from '../../types';
-export interface ExampleSiderProps {
-    /**
-     * 当前 Example (受控)
-     */
-    currentDemo: Demo;
-    /**
-     * 当选中的 Demo 被改变时做些什么
-     */
-    onDemoClicked: (demo: Demo) => void;
-    /**
-     * 所有的案例主题
-     */
-    exampleTopics: ExampleTopic[];
-    showExampleDemoTitle: boolean;
-}
-/**
- * DEMO 预览页面的菜单
- */
-export declare const ExampleSider: React.FC<ExampleSiderProps>;

package/dist/slots/Features/FeatureCard.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-import { IC } from '../../types';
-interface FeatureProps {
-    icon: string;
-    title: IC;
-    description: string;
-}
-declare const FeatureCard: React.FC<FeatureProps>;
-export default FeatureCard;

package/dist/slots/Features/index.d.ts

@@ -1,15 +0,0 @@
-import React from 'react';
-interface Card {
-    icon: string;
-    title: string;
-    description: string;
-}
-interface FeaturesProps {
-    title?: string;
-    features: Card[];
-    className?: string;
-    style?: React.CSSProperties;
-    id?: string;
-}
-export declare const Features: React.FC<FeaturesProps>;
-export {};

package/dist/slots/Footer/index.d.ts

@@ -1,18 +0,0 @@
-import React from 'react';
-import { FooterProps as RcFooterProps } from 'rc-footer';
-import 'rc-footer/assets/index.less';
-interface FooterProps extends RcFooterProps {
-    rootDomain?: string;
-    language?: string;
-    githubUrl?: string;
-    /**
-     * 是否为动态 footer
-     */
-    isDynamicFooter?: boolean;
-}
-/**
- * 底部菜单
- * @returns
- */
-export declare const Footer: React.FC<FooterProps>;
-export {};

package/dist/slots/Header/Navs.d.ts

@@ -1,27 +0,0 @@
-import React from 'react';
-declare type dropdownItem = {
-    name: {
-        [key: string]: string;
-    };
-    url: string;
-    target?: '_blank';
-};
-export declare type INav = {
-    slug?: string;
-    order: number;
-    title: {
-        [key: string]: string;
-    };
-    target?: '_blank';
-    notPage?: boolean;
-    dropdownItems?: dropdownItem[];
-};
-export declare type NavProps = {
-    navs: INav[];
-    path: string;
-};
-/**
- * Header 中的导航菜单
- */
-export declare const Navs: React.FC<NavProps>;
-export {};

package/dist/slots/Header/Products/NavigatorBanner.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-export interface NavigatorBannerProps {
-    post?: {
-        slug?: string;
-        title?: string;
-    };
-    type: 'prev' | 'next';
-}
-declare const NavigatorBanner: React.FC<NavigatorBannerProps>;
-export default NavigatorBanner;

package/dist/slots/Header/Products/Product.d.ts

@@ -1,14 +0,0 @@
-import React from 'react';
-import { ProductType } from './getProducts';
-interface ProductProps {
-    name?: string;
-    icon?: string;
-    slogan?: string;
-    description?: string;
-    url?: string;
-    links: ProductType['links'];
-    style?: React.CSSProperties;
-    language?: string;
-}
-declare const Product: React.FC<ProductProps>;
-export default Product;

package/dist/slots/Header/Products/getProducts.d.ts

@@ -1,48 +0,0 @@
-import React from 'react';
-declare const Categories: ["basic", "extension", "ecology"];
-export interface ProductCategory {
-    type: (typeof CATEGORY_TYPE)[number];
-    name: string;
-    products: ProductType[];
-}
-export interface ProductItem {
-    title: string;
-    icon?: React.ReactNode;
-    slogan?: string;
-    description: string;
-    category: typeof Categories[number];
-    links?: Array<{
-        icon?: React.ReactNode;
-        title: React.ReactNode;
-        url?: string;
-        openExternal?: boolean;
-    }>;
-}
-export declare type ValuesOf<T extends any[]> = T[number];
-declare const CATEGORY_TYPE: ["basic", "extension", "mobile", "ecology"];
-export declare const CATEGORIES: Array<ProductCategory>;
-export declare type ProductType = {
-    links: {
-        /** 产品首页 */
-        readonly home?: {
-            url: string;
-            title?: string;
-        };
-        /** 图表示例 */
-        readonly example?: {
-            url: string;
-            title?: string;
-        };
-        /** 使用文档 */
-        readonly api?: {
-            url: string;
-            title?: string;
-        };
-    };
-    [k: string]: any;
-};
-export declare function getNewProducts({ language, isChinaMirrorHost, }: {
-    language: 'zh' | 'en';
-    isChinaMirrorHost: boolean;
-}): Promise<ProductType[]>;
-export {};

package/dist/slots/Header/Products/index.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-interface ProductsProps {
-    show: boolean;
-    rootDomain: string;
-    language?: 'zh' | 'en';
-    className?: string;
-    bannerVisible?: boolean;
-}
-export declare const Products: React.FC<ProductsProps>;
-export {};

package/dist/slots/Header/Search/SearchResult.d.ts

@@ -1,21 +0,0 @@
-import React from 'react';
-export declare type ITextSegment = {
-    text: string;
-    highlighted?: boolean;
-};
-export declare type ISearchResult = {
-    /**
-     * 搜索结果的主题，显示在最左边，一般是页面的标题。
-     */
-    subject: string;
-    tilte: ITextSegment[];
-    description?: ITextSegment[];
-    link: string;
-};
-/**
- * 展示搜索结果
- * @returns
- */
-export declare const SearchResult: React.FC<{
-    results: ISearchResult[];
-}>;

package/dist/slots/Header/Search/helper.d.ts

@@ -1,8 +0,0 @@
-import type { ISearchResult } from './SearchResult';
-/**
- * dumi 搜索结果转页面 UI 的数据结构，默认取 30 条
- * @param dumiResult
- * @param limit
- * @returns
- */
-export declare function getSearchResults(dumiResults: any[], limit?: number): ISearchResult[];

package/dist/slots/Header/Search/index.d.ts

@@ -1 +0,0 @@
-export declare const Search: () => JSX.Element;

package/dist/slots/Header/index.d.ts

@@ -1,84 +0,0 @@
-import React from 'react';
-import { INav } from './Navs';
-import type { IC } from '../../types';
-export declare 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;
-    /** 是否是AntV官网 */
-    isAntVSite?: boolean;
-    /** AntV root 域名，直接用主题的可不传 */
-    rootDomain?: string;
-    /** 是否显示 AntV 产品卡片 */
-    showAntVProductsCard?: boolean;
-    /**
-     * 当前版本
-     */
-    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>>;

package/dist/slots/Header/utils.d.ts

@@ -1,10 +0,0 @@
-export declare function getLangUrl(url: string, lang: string): string;
-/**
- * /en/api/xxx -> api
- * /api/xxx -> api
- * /docs/api/xxx -> api
- * api/xxx -> api
- * @param url
- */
-export declare function getNavCategory(url: string): string;
-export declare function findVersion(v: string, versions: string[]): string;

package/dist/slots/Loading/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * Loading
- */
-declare const Loading: () => JSX.Element;
-export default Loading;

package/dist/slots/ManualContent/NavigatorBanner.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-export interface NavigatorBannerProps {
-    post?: {
-        slug?: string;
-        title?: string;
-    } | undefined;
-    type: 'prev' | 'next';
-}
-export declare const NavigatorBanner: React.FC<NavigatorBannerProps>;

package/dist/slots/ManualContent/Preview.d.ts

@@ -1,7 +0,0 @@
-import { FC } from 'react';
-export declare type PreviewProps = {
-    source: string;
-    pin: boolean;
-    code: HTMLDivElement;
-};
-export declare const Preview: FC<any>;

package/dist/slots/ManualContent/ReadingTime.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const ReadingTime: React.FC<any>;
-export default ReadingTime;

package/dist/slots/ManualContent/index.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-import 'rc-drawer/assets/index.css';
-export declare type ManualContent = {
-    readonly children: any;
-};
-/**
- * 文档的结构
- */
-export declare const ManualContent: React.FC<ManualContent>;

package/dist/slots/ManualContent/usePreview.d.ts

@@ -1 +0,0 @@
-export declare function usePreview(options: {}, select: any): void;

package/dist/slots/ManualContent/utils.d.ts

@@ -1,19 +0,0 @@
-export declare function getOpenKeys(): any[];
-export declare function getBaseRoute(): string;
-export declare function getIndexRoute(MenuData: any): any;
-/**
- * 返回需要跳转的 pathname
- * /en/api/ ----> /en/api/[first-doc]
- * /zh/api/ ----> /api/[first-doc]
- * /en/docs/api/ ----> /en/api/[first-doc]
- * /zh/docs/api/ ----> /api/[first-doc]
- *
- * /en/docs/api/xxx ----> /en/api/xxx
- * /zh/docs/api/xxx ----> /api/xxx
- *
- * /docs/api/xxx -----> /api/xxx
- *
- * @param p
- */
-export declare function getNavigateUrl(pathname: string, first: string, siderbarMenu: any[]): string;
-export declare function safeEval(source: any): any;

package/dist/slots/SEO.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-interface SEOProps {
-    description?: string;
-    lang?: string;
-    meta?: any[];
-    title?: string;
-    titleSuffix?: string;
-}
-export declare const SEO: React.FC<SEOProps>;
-export {};