Skip to main content
Version: 2.x

API Reference > @next-core/brick-types > BrickConf

BrickConf interface

构件配置。

Signature:

export interface BrickConf

Properties

PropertyTypeDescription
bgboolean是否将构件放置到一个不可见的背景容器中,它们通常为 Provider 构件。
brickstring构件名。
contextContextConf[]上下文配置列表。
eventsBrickEventsMap构件的事件配置表。
ifstring | boolean | ResolveConf条件渲染配置,根据 if 的计算结果来决定是否渲染该构件。
iidstring构件编排 ID
lifeCycleBrickLifeCycle构件生命周期配置。
paramsRecord<string, unknown>(老)模板的参数表。
permissionsPreCheckstring[]预校验的动态权限列表,在编排中可以通过 <% PERMISSIONS.check("your-action") %>来校验权限点。 当被校验的权限点为已知字符串,则框架会扫描收集统一校验,不需要在此处声明; 当被校验的权限点需要动态获得,例如通过 QUERY,PATH,CTX 等参数动态计算得到,则需要在 permissionsPreCheck 中提前声明。 如果某个权限点需要在接口中获得,也只需要在 Context 中通过异步 Resolve 提前赋值给 Context 即可。
portalboolean标记 portal: true 的构件将被放置到一个“传送门”容器中,它们通常为 *Modal**Drawer* 等弹窗容器类型的构件。
propertiesRecord<string, unknown>构件属性。
slotsSlotsConf插槽配置表。
templatestring(老)模板。