UI 概览
@univerjs-pro/bases-ui 是 Univer Bases 的授权浏览器工作台。它负责渲染表和视图导航、网格、看板、日历、甘特图和画廊视图,以及字段编辑器、记录详情面板、菜单和选区状态。
注册工作台
许可证和公式引擎都需要在 Bases 插件之前注册。公式字段使用 @univerjs-pro/engine-formula,不需要 Sheets 应用。
UniverLicensePlugin
licensestring客户端许可证文件的内容。
UniverUIPlugin
containerstring | HTMLElement编辑器挂载的元素,或该元素的 DOM ID。
TypeScript
univer.registerPlugin(UniverLicensePlugin, { license: process.env.CLIENT_LICENSE_TEXT,})univer.registerPlugin(UniverProFormulaEnginePlugin)univer.registerPlugin(UniverRenderEnginePlugin)univer.registerPlugin(UniverUIPlugin, { container: 'app' })univer.registerPlugin(UniverBasesPlugin)univer.registerPlugin(UniverBasesUIPlugin)导入、样式和语言包数据见安装和基本使用。
配置初始布局
IUniverBaseUIConfig 控制工作台显示哪些区域,以及启动时打开哪张表和哪个视图。
UniverBasesUIPlugin
disableEditboolean关闭工作台中的编辑控件。initialStateobject启动时打开的表和视图。tableIdstring | null启动时优先显示的表。viewIdstring | null启动时优先显示的视图。
workbenchobject工作台的布局选项。headerboolean默认值:true显示顶部栏。headerMenuboolean默认值:true显示顶部菜单。contentboolean默认值:true显示主内容区。leftSidebarboolean默认值:true显示左侧栏。rightSidebarboolean默认值:false显示右侧栏。rightPanelMode'dock' | 'overlay'默认值:'dock'右侧面板嵌入布局中,或覆盖在编辑器上方。
TypeScript
univer.registerPlugin(UniverBasesUIPlugin, { workbench: { header: true, headerMenu: true, content: true, leftSidebar: true, rightSidebar: false, rightPanelMode: 'dock', }, initialState: { tableId: 'tasks', viewId: 'kanban', },})设置 disableEdit 可构建只读工作台。只应在对应的 Base 字段需要宿主应用提供值时,传入 attachment、personOptions 或 groupOptions。
你觉得这篇文档如何?