@gravity-ui/react-unipika

中文文档
0.8.1发布于 2026/07/04MITTypeScriptESM + CJS零依赖近 30 天下载 4894

该库通过使用已注册的字段类型来帮助创建与窗体的对话框. 也可以用你自己的字段类型来扩展.

中文使用文档
文档目录10 节
  1. 简短说明
  2. 特征
  3. 安装
  4. 使用量
  5. 窗口滚动( 默认)
  6. 容器滚动
  7. YSON 通知
  8. 道具
  9. ReactUnipika 组件道具
  10. 统一安排

简短说明

目的 @gravity-ui/react-unipika 正在视觉 JSON 和 亚森 数据对象. 图书馆使用 @gravity-ui/unipika 财务报告和审定财务报表 @gravity-ui/table 内部.

特征

  • 虚拟化
  • 两种滚动模式:窗口滚动和容器滚动
  • 崩溃/扩展对象/阵列
  • 搜索按键/值的子串(对大小写敏感和对大小写不敏感)
  • 每行生成一升
    • 长字符串被椭圆切换
      • 在对话框中可以看到全部值

安装

$ npm install @gravity-ui/react-unipika

根据您的软件包管理器, 您可能需要安装 peerDependencies 手动.

使用量

图书馆根据您的滚动需要提供两个切入点:

窗口滚动( 默认)

如果您希望组件与浏览器窗口滚动, 请使用此选项 :

import '@gravity-ui/uikit/styles/styles.scss';
import '@gravity-ui/unipika/styles/unipika.scss';

import {ReactUnipika} from '@gravity-ui/react-unipika/window-scroll';

function renderJson(data: any) {
  return <ReactUnipika value={data} />;
}

容器滚动

当您希望组件滚动到特定容器中时使用此选项。 您必须提供滚动容器的校对 :

import '@gravity-ui/uikit/styles/styles.scss';
import '@gravity-ui/unipika/styles/unipika.scss';

import {ReactUnipika} from '@gravity-ui/react-unipika/container-scroll';

function renderJson(data: any) {
  const scrollContainerRef = React.useRef<HTMLDivElement>(null);

  return (
    <div ref={scrollContainerRef} style={{height: '500px', overflow: 'auto'}}>
      <ReactUnipika value={data} scrollContainerRef={scrollContainerRef} />
    </div>
  );
}

YSON 通知

库不支持YSON-format"as is",即无法使用/保存YSON数据. 但是它提供了使JSON对象成为YSON的方法,这种JSON对象保留了字段名,比如: $attributes, (中文(简体) ), $value。 。 。 .

更多信息见 故事书。 。 。 .

道具

ReactUnipika 组件道具

Prop类型默认说明
valueany所需经费将提供的数据
settingsUnipikaSettings见下文Unipika 格式化设置
inlinebooleanfalse内嵌模式中的渲染
childrenReact.ReactNode- 说吧儿童反应节点
extraToolsReact.ReactNode- 说吧工具的额外反应节点
virtualizedbooleantrue启用虚拟化,以便用大数据改进性能
classNamestring- 说吧自定义 CSS 类名称
customLayout(args: {toolbar: React.ReactNode; content: React.ReactNode}) => React.ReactNode- 说吧自定义布局的函数
toolbarStickyTopnumber0粘性工具栏在像素中的最高位置
renderToolbar(props: ToolbarProps) => React.ReactNode- 说吧自定义工具栏渲染器功能
collapseIconTypeCollapseIconType- 说吧要使用的崩溃/扩展图标类型
showContainerSizeboolean- 说吧显示容器大小(对象/阵列)
initiallyCollapsedboolean- 说吧是否使树初倒塌
caseInsensitiveSearchboolean- 说吧启用不区分大小写搜索
renderError(error: unknown) => React.ReactNode- 说吧自定义错误渲染器功能
renderRowExtraTools(params: RenderRowExtraToolsParams) => React.ReactNode- 说吧每个行的自定义工具
scrollContainerRefReact.RefObject<Element | null>- 说吧仅用于容器滚动。引用滚动容器元素

统一安排

设置类型默认说明
asHTMLbooleantrue渲染为 HTML
formatstring'json'格式类型 ('json','yson','raw-json')
compactbooleanfalse使用压缩渲染
escapeWhitespacebooleantrue逃出空白字符
showDecodedbooleantrue显示已解码的值
binaryAsHexbooleantrue以十六进制显示二进制数据
nonBreakingIndentboolean- 说吧使用非破碎空格缩进
escapeYQLStringsboolean- 说吧逃出 YQL 字符串
decodeUTF8boolean- 说吧解码 UTF-8 编码字符串
indentnumber- 说吧缩进大小
breakboolean- 说吧添加换行符
maxListSizenumber- 说吧在列表中显示的最大项目数
maxStringSizenumber- 说吧切换前显示的最大字符串长度
omitStructNullboolean- 说吧结构中的无效值
treatValAsDataboolean- 说吧将值视为数据

版本与发布记录

@gravity-ui/react-unipika 共发布 17 个版本,首次发布于 2025/05/12;过去 12 个月发布了 11 个版本。

版本发布日期距今
0.8.1latest2026/07/044 个月前
0.8.02026/07/024 个月前
0.7.12026/06/095 个月前
0.7.02026/05/295 个月前
0.6.42026/05/225 个月前
0.6.32026/05/146 个月前

关于 @gravity-ui/react-unipika 的常见问题

@gravity-ui/react-unipika 是什么?

该库通过使用已注册的字段类型来帮助创建与窗体的对话框. 也可以用你自己的字段类型来扩展.

如何安装 @gravity-ui/react-unipika?

在项目目录运行 npm install @gravity-ui/react-unipika,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@bem-react/classname(^1.6.0)、@gravity-ui/i18n(^1.0.0)、@gravity-ui/icons(^2.0.0)、@gravity-ui/table(^1.10.1)、@gravity-ui/uikit(^7.1.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gravity-ui/react-unipika 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gravity-ui/react-unipika 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gravity-ui/react-unipika 可以商用吗?

@gravity-ui/react-unipika 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gravity-ui/react-unipika 的下载量有多少?

根据 npm 官方下载统计,@gravity-ui/react-unipika 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,894 次,日均约 163 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gravity-ui/react-unipika 还在维护吗?

最新版本 0.8.1 发布于 2026/07/04(4 个月前);至今共发布 17 个版本,其中过去 12 个月发布了 11 个;首次发布于 2025/05/12。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。