简短说明
目的 @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 | 类型 | 默认 | 说明 |
|---|---|---|---|
value | any | 所需经费 | 将提供的数据 |
settings | UnipikaSettings | 见下文 | Unipika 格式化设置 |
inline | boolean | false | 内嵌模式中的渲染 |
children | React.ReactNode | - 说吧 | 儿童反应节点 |
extraTools | React.ReactNode | - 说吧 | 工具的额外反应节点 |
virtualized | boolean | true | 启用虚拟化,以便用大数据改进性能 |
className | string | - 说吧 | 自定义 CSS 类名称 |
customLayout | (args: {toolbar: React.ReactNode; content: React.ReactNode}) => React.ReactNode | - 说吧 | 自定义布局的函数 |
toolbarStickyTop | number | 0 | 粘性工具栏在像素中的最高位置 |
renderToolbar | (props: ToolbarProps) => React.ReactNode | - 说吧 | 自定义工具栏渲染器功能 |
collapseIconType | CollapseIconType | - 说吧 | 要使用的崩溃/扩展图标类型 |
showContainerSize | boolean | - 说吧 | 显示容器大小(对象/阵列) |
initiallyCollapsed | boolean | - 说吧 | 是否使树初倒塌 |
caseInsensitiveSearch | boolean | - 说吧 | 启用不区分大小写搜索 |
renderError | (error: unknown) => React.ReactNode | - 说吧 | 自定义错误渲染器功能 |
renderRowExtraTools | (params: RenderRowExtraToolsParams) => React.ReactNode | - 说吧 | 每个行的自定义工具 |
scrollContainerRef | React.RefObject<Element | null> | - 说吧 | 仅用于容器滚动。引用滚动容器元素 |
统一安排
| 设置 | 类型 | 默认 | 说明 |
|---|---|---|---|
asHTML | boolean | true | 渲染为 HTML |
format | string | 'json' | 格式类型 ('json','yson','raw-json') |
compact | boolean | false | 使用压缩渲染 |
escapeWhitespace | boolean | true | 逃出空白字符 |
showDecoded | boolean | true | 显示已解码的值 |
binaryAsHex | boolean | true | 以十六进制显示二进制数据 |
nonBreakingIndent | boolean | - 说吧 | 使用非破碎空格缩进 |
escapeYQLStrings | boolean | - 说吧 | 逃出 YQL 字符串 |
decodeUTF8 | boolean | - 说吧 | 解码 UTF-8 编码字符串 |
indent | number | - 说吧 | 缩进大小 |
break | boolean | - 说吧 | 添加换行符 |
maxListSize | number | - 说吧 | 在列表中显示的最大项目数 |
maxStringSize | number | - 说吧 | 切换前显示的最大字符串长度 |
omitStructNull | boolean | - 说吧 | 结构中的无效值 |
treatValAsData | boolean | - 说吧 | 将值视为数据 |