@antv/dumi-theme-antv 0.5.2 → 0.5.4-beta.0

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 type ITextSegment = {
-    text: string;
-    highlighted?: boolean;
-};
-export 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,2 +0,0 @@
-import React from 'react';
-export declare const Search: () => React.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 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,6 +0,0 @@
-import React from 'react';
-/**
- * Loading
- */
-declare const Loading: () => React.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 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 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 {};

package/dist/slots/SEO.js

@@ -1,57 +0,0 @@
-import { useSiteData } from 'dumi';
-import React from 'react';
-import { Helmet } from 'react-helmet';
-export var SEO = function SEO(_ref) {
-  var description = _ref.description,
-    _ref$lang = _ref.lang,
-    lang = _ref$lang === void 0 ? '' : _ref$lang,
-    _ref$meta = _ref.meta,
-    meta = _ref$meta === void 0 ? [] : _ref$meta,
-    title = _ref.title,
-    titleSuffix = _ref.titleSuffix;
-  var _useSiteData = useSiteData(),
-    themeConfig = _useSiteData.themeConfig;
-  var defaultTitle = themeConfig.title,
-    defaultDescription = themeConfig.defaultDescription;
-  var metaDescription = description || defaultDescription;
-  return /*#__PURE__*/React.createElement(Helmet, {
-    htmlAttributes: {
-      lang: lang
-    },
-    title: title,
-    titleTemplate: "%s | ".concat(titleSuffix || defaultTitle),
-    meta: [{
-      name: "description",
-      content: metaDescription
-    }, {
-      property: "og:title",
-      content: title
-    }, {
-      property: "og:description",
-      content: metaDescription
-    }, {
-      property: "og:image",
-      content: 'https://gw.alipayobjects.com/zos/antfincdn/FLrTNDvlna/antv.png'
-    }, {
-      property: "og:type",
-      content: "website"
-    }, {
-      name: "twitter:card",
-      content: "summary"
-    }, {
-      name: "twitter:title",
-      content: title
-    }, {
-      name: "twitter:description",
-      content: metaDescription
-    }, {
-      property: "twitter:image",
-      content: 'https://gw.alipayobjects.com/zos/antfincdn/FLrTNDvlna/antv.png'
-    }].concat(meta)
-  });
-};
-SEO.defaultProps = {
-  lang: "zh",
-  meta: [],
-  description: ""
-};

package/dist/slots/global.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/slots/hooks.d.ts

@@ -1,16 +0,0 @@
-import { NavigatorBannerProps } from './ManualContent/NavigatorBanner';
-export declare const useChinaMirrorHost: () => [boolean];
-export declare const useScrollToTop: () => void;
-export declare const useLogoLink: ({ link, siteUrl, lang, }: {
-    link?: string;
-    siteUrl?: string;
-    lang?: string;
-}) => [string];
-export declare const usePrevAndNext: () => NavigatorBannerProps['post'][];
-/**
- * i18n .umirc config
- * 如果是 object，则取 locale，否则直接用
- * @param v
- */
-export declare function ic(v: string | object): any;
-export declare function icWithLocale(v: string | object, locale: any): any;

package/dist/slots/utils.d.ts

@@ -1,5 +0,0 @@
-import { Status, TreeNode } from '../types';
-export declare function ping(): Promise<Status>;
-export declare const getChinaMirrorHost: (host?: string) => string;
-export declare function getGithubSourceURL(githubUrl: string, relativePath: string, prefix?: string): string;
-export declare const filterTreeNode: (treeNode: TreeNode, keyValue: string, locale: string) => TreeNode;

package/dist/types.d.ts

@@ -1,86 +0,0 @@
-export interface IThemeConfig {
-    [key: string]: any;
-}
-export type Status = 'responded' | 'error' | 'timeout';
-/**
- * 配置文件中的国际化配置
- */
-export type IC = string | {
-    zh: string;
-    en: string;
-};
-export interface TreeNode {
-    /**
-     * id
-     */
-    id: string;
-    /**
-     * 孩子节点 key
-     */
-    childrenKey?: string;
-    /**
-     * 标题（支持国际化）
-     */
-    title: {
-        zh: string;
-        en: string;
-    };
-    [key: string]: any;
-}
-/** 案例 DEMO */
-export interface Demo extends TreeNode {
-    /**
-     * 截图
-     */
-    screenshot: string;
-    /**
-     * TypeScript 源码文件
-     */
-    source: string;
-    /**
-     * DEMO 代码文件名称
-     */
-    filename: string;
-    /**
-     * 衍生属性，通过 topic.id + example.id + demo.id 可以计算获取
-     */
-    relativePath?: string;
-    /**
-     * 是否为新品
-     */
-    isNew?: boolean;
-    /**
-     * 目标 example
-     */
-    targetExample?: Example;
-    /**
-     * 目标主题
-     */
-    targetTopic?: ExampleTopic;
-}
-/** 示例 */
-export interface Example extends TreeNode {
-    /**
-     * 图标
-     */
-    icon: string;
-    /**
-     * DEMO
-     */
-    demos: Demo[];
-}
-/** 案例主题 */
-export interface ExampleTopic extends TreeNode {
-    /**
-     * 图标
-     */
-    icon: string;
-    /**
-     * slug 和 id 一样，兼容旧配置
-     */
-    slug?: string;
-    /**
-     * 所有案例
-     */
-    examples: Example[];
-}