| 1 | import React from 'react';
|
| 2 | export declare const SelectKeyProvide: React.Context<{
|
| 3 | selectedKey: string | undefined;
|
| 4 | setSelectedKey: (key: string | undefined) => void;
|
| 5 | }>;
|
| 6 | export type ProHelpPanelProps = {
|
| 7 | /**
|
| 8 | * 帮助面板的标题
|
| 9 | */
|
| 10 | title?: string;
|
| 11 | /**
|
| 12 | * 帮助面板首次打开时的默认选中文档的键名
|
| 13 | */
|
| 14 | defaultSelectedKey?: string;
|
| 15 | /**
|
| 16 | * 当前选中的帮助文档的键名。如果提供了这个 prop，那么该组件将是一个受控组件，其状态将由父组件管理。如果未提供，那么该组件将是一个非受控组件，其状态将在组件内部管理。
|
| 17 | */
|
| 18 | selectedKey?: string;
|
| 19 | /**
|
| 20 | * 当选中的文档键名发生变化时调用的回调函数。新的键名将作为参数传递给该函数。
|
| 21 | */
|
| 22 | onSelectedKeyChange?: (key: string | undefined) => void;
|
| 23 | /**
|
| 24 | *控制左侧面板是否能够打开
|
| 25 | */
|
| 26 | showLeftPanel?: boolean;
|
| 27 | /**
|
| 28 | * 当左侧面板打开状态发生变化时调用的回调函数。新的打开状态将作为参数传递给该函数。
|
| 29 | */
|
| 30 | onShowLeftPanelChange?: (show: boolean) => void;
|
| 31 | /**
|
| 32 | * 是否显示边框
|
| 33 | */
|
| 34 | bordered?: boolean;
|
| 35 | /**
|
| 36 | * 当帮助面板关闭时调用的回调函数。
|
| 37 | */
|
| 38 | onClose?: () => void;
|
| 39 | /**
|
| 40 | * 帮助面板的高度，可以是数字或字符串类型。
|
| 41 | */
|
| 42 | height?: number | string;
|
| 43 | /**
|
| 44 | * 帮助面板的页脚
|
| 45 | */
|
| 46 | footer?: React.ReactNode;
|
| 47 | /**
|
| 48 | * 在一页内加载所有的 children 内容
|
| 49 | */
|
| 50 | infiniteScrollFull?: boolean;
|
| 51 | /**
|
| 52 | * 自定义渲染 extra 部分的内容
|
| 53 | *
|
| 54 | * @param {React.ReactNode} collapsePannelAction - 折叠收起的左侧按钮
|
| 55 | * @param {React.ReactNode} helpSelectAction - 默认的帮助筛选按钮
|
| 56 | * @param {React.ReactNode} closeAction - 关闭操作按钮
|
| 57 | * @returns {React.ReactNode} - 返回自定义渲染的 extra 操作按钮
|
| 58 | *
|
| 59 | */
|
| 60 | extraRender?: (collapsePannelAction: React.ReactNode, helpSelectAction: React.ReactNode, closeAction: React.ReactNode) => React.ReactNode;
|
| 61 | };
|
| 62 | /**
|
| 63 | * ProHelpPanel 组件是一个帮助中心面板组件，具有可折叠的左侧菜单和右侧帮助内容区域。
|
| 64 | * 左侧菜单显示了帮助文档的目录结构，右侧帮助内容区域显示了用户选中的帮助文档内容。
|
| 65 | * 在左侧菜单中，用户可以通过点击目录来选择并显示相应的文档内容。
|
| 66 | * @param param0
|
| 67 | * @returns
|
| 68 | */
|
| 69 | export declare const ProHelpPanel: React.FC<ProHelpPanelProps>;
|