@openviking/react 0.1.1 → 0.1.3

package/dist/components/file-preview/file-preview-state.d.ts

@@ -0,0 +1,35 @@
+import type { FilePreviewLabels } from './types.js';
+/** 空文件态：严格长度为 0。The empty-file state, for a strictly zero-length body. */
+export declare function EmptyFileState({ text, }: {
+    text: Required<FilePreviewLabels>;
+}): import("react").JSX.Element;
+/** 无可见内容态：正文存在但没有可渲染的文本。 */
+export declare function NoContentState({ text, }: {
+    text: Required<FilePreviewLabels>;
+}): import("react").JSX.Element;
+/**
+ * 加载态。只用到 `loading` 一条文案，因此参数收窄到这一项：宿主在正文还没
+ * 取回来时手上没有完整的一套文案，也不该为了显示加载中而编一份。
+ *
+ * A loading state. Only `loading` is read, so the parameter narrows to that one
+ * field: a host that has not received the body yet has no full copy set, and should
+ * not have to invent one just to show that something is loading.
+ */
+export declare function LoadingState({ text, }: {
+    text: Pick<FilePreviewLabels, 'loading'>;
+}): import("react").JSX.Element;
+/** 读取失败态，带重试入口。A read-failure state with a retry entry. */
+export declare function LoadFailedState({ text, description, onRetry, }: {
+    text: Required<FilePreviewLabels>;
+    description?: string;
+    onRetry?: () => void;
+}): import("react").JSX.Element;
+/** 格式不支持态，带下载入口。An unsupported-format state with a download entry. */
+export declare function UnsupportedState({ text, onDownload, }: {
+    text: Required<FilePreviewLabels>;
+    onDownload?: () => void;
+}): import("react").JSX.Element;
+/** 正文被截断时的提示，固定在正文下方。 */
+export declare function TruncatedNotice({ text, }: {
+    text: Required<FilePreviewLabels>;
+}): import("react").JSX.Element;

package/dist/components/file-preview/file-preview-tab-row.d.ts

@@ -0,0 +1,16 @@
+import type { FilePreviewTab } from './types.js';
+export interface FilePreviewTabRowProps {
+    tabs: readonly FilePreviewTab[];
+    activeKey: string;
+    disabled: boolean;
+    /** 按 key 生成页签的 DOM id，带实例前缀避免多实例重复。 */
+    tabId: (key: string) => string;
+    /** 按 key 生成面板的 DOM id，与 `tabId` 同源。 */
+    panelId: (key: string) => string;
+    onSelect: (key: string) => void;
+}
+/**
+ * 页签行：文件夹卡片式页签，选中页签与内容区连成一体。
+ * The tab row: folder-style tabs where the selected one joins the content area.
+ */
+export declare function FilePreviewTabRow({ tabs, activeKey, disabled, tabId, panelId, onSelect, }: FilePreviewTabRowProps): import("react").JSX.Element;

package/dist/components/file-preview/file-preview-viewer.d.ts

@@ -0,0 +1,31 @@
+import type { ViewerHandle, ViewerViewModeOption } from '@ark-design/ui/file-viewer/core';
+import type { MarkdownAdapterOptions } from '@ark-design/ui/file-viewer/adapters/markdown';
+import type { FilePreviewFileTab, FilePreviewLabels, FilePreviewViewMode } from './types.js';
+export interface FilePreviewViewerProps {
+    tab: FilePreviewFileTab;
+    text: Required<FilePreviewLabels>;
+    locale?: 'en-US' | 'zh-CN';
+    viewMode: FilePreviewViewMode;
+    onViewModeChange: (mode: FilePreviewViewMode) => void;
+    onDownload: () => void;
+    onHandleChange: (handle: ViewerHandle | null) => void;
+    onViewModesChange: (modes: readonly ViewerViewModeOption[]) => void;
+    /** Markdown 正文里的链接被点击时调用；传入即由宿主接管导航。 */
+    onLinkClick?: MarkdownAdapterOptions['onLinkClick'];
+}
+/**
+ * 文件页签的正文：把宿主的 `source` 交给底座按格式渲染。
+ *
+ * `toolbar` 恒为 `false`，外壳全部由组件渲染；兜底态通过 `slots` 换成组件
+ * 自己的文案，底座只负责格式路由、渲染器按需加载与准入。
+ *
+ * 本模块会静态引入底座，只能由懒加载入口引用，见 `file-preview-body.tsx`。
+ *
+ * The body of a file tab: hands the host `source` to the base component for
+ * format rendering. `toolbar` stays `false` because the component renders the
+ * whole shell, and the fallback states are replaced through `slots` so the copy
+ * comes from this component. The base keeps format routing, on-demand renderer
+ * loading and admission. This module statically imports the base, so only the
+ * lazy entry may reference it; see `file-preview-body.tsx`.
+ */
+export declare function FilePreviewViewer({ tab, text, locale, viewMode, onViewModeChange, onDownload, onHandleChange, onViewModesChange, onLinkClick, }: FilePreviewViewerProps): string | number | bigint | boolean | import("react").JSX.Element | Iterable<import("react").ReactNode> | Promise<string | number | bigint | boolean | Iterable<import("react").ReactNode> | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | import("react").ReactPortal | null | undefined>;

package/dist/components/file-preview/file-preview.d.ts

@@ -1,17 +1,15 @@
 import type { FilePreviewComponent } from './types.js';
-export type { FilePreviewComponent, FilePreviewContentTab, FilePreviewEditing, FilePreviewFileTab, FilePreviewFileTabSlots, FilePreviewHandle, FilePreviewHeaderSlots, FilePreviewLabels, FilePreviewOperations, FilePreviewProps, FilePreviewSource, FilePreviewTab, FilePreviewTabBase, } from './types.js';
+export { LoadingState } from './file-preview-state.js';
+export type { FilePreviewActions, FilePreviewComponent, FilePreviewContentTab, FilePreviewDirectoryLevel, FilePreviewDirectoryTab, FilePreviewEditing, FilePreviewFileTab, FilePreviewFileTabSlots, FilePreviewHandle, FilePreviewHeaderSlots, FilePreviewLabels, FilePreviewOperations, FilePreviewProps, FilePreviewSource, FilePreviewTab, FilePreviewTabBase, FilePreviewViewMode, } from './types.js';
 /**
- * 文件预览的占位实现。
+ * 文件预览：页签行、内容区标题行与正文组成的外壳，正文由底座按格式渲染。
  *
- * 外壳（页签行、内容区标题行、页签切换与 ref 句柄）按最终形态实现，可直接
- * 交互；文件正文尚未接入 FileViewer，文件页签先以纯文本降级展示，内容页签
- * 按宿主给的节点渲染。
+ * 文件页签的正文交给 `FileViewerCore`，内容页签的正文由宿主原样渲染。空文件、
+ * 截断与编辑态由组件自己处理，不经过底座。
  *
- * Placeholder implementation of the file preview.
- *
- * The shell — tab row, content header row, tab switching and the ref handle — is
- * implemented as it will ship and is fully interactive. The file body is not
- * wired to FileViewer yet: a file tab falls back to plain text, while a content
- * tab renders the node the host supplies.
+ * File preview: a shell of tab row, content header and body, where the body is
+ * rendered by the base component according to the format. A file tab hands its
+ * body to `FileViewerCore`; a content tab renders the host node as-is. Empty
+ * files, truncation and editing are handled by this component, not the base.
  */
 export declare const FilePreview: FilePreviewComponent;

package/dist/components/file-preview/level-selection.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 目录页签的初始层级：受控值优先，其次是非受控时记下的选择，然后是
+ * `defaultLevelKey`，最后回落到第一级。
+ *
+ * 单列成纯函数是因为它有一条容易漏掉的规则：外壳算出的 `activeLevelKey` 是受控
+ * 值，正文组件因此没有机会用上自己的初值，`defaultLevelKey` 必须在这里就被尊重，
+ * 否则宿主声明的默认层级会被静默改成第一级。
+ *
+ * The initial level of a directory tab: the controlled value first, then the choice
+ * recorded while uncontrolled, then `defaultLevelKey`, and the first level as the last
+ * resort.
+ *
+ * It is a standalone pure function because of one easily missed rule: the
+ * `activeLevelKey` the shell computes is a controlled value, so the body component never
+ * applies its own initial one — `defaultLevelKey` has to be honoured here, or the
+ * host's declared default is silently replaced by the first level.
+ */
+export interface LevelChoiceTab {
+    levels: readonly {
+        key: string;
+    }[];
+    activeLevelKey?: string;
+    defaultLevelKey?: string;
+}
+export declare function initialLevelKey(tab: LevelChoiceTab, remembered: Readonly<Record<string, string>>, tabKey: string): string;