它会做什么

• 创建和编辑页面、分类及其块树,并进行操作,例如 CreatePage, (中文(简体) ), AddBlock, (中文(简体) ), ConfigureBlock, (中文(简体) ), MoveBlock 财务报告和审定财务报表 SetPageBlocks。 。 。 .
• 生成资源, 每个 a Table页:1 DataController 和模范,并编辑他们的字段.
• 将查询模板编成模型方法和页面路由,因此一卡获得一个没有手写代码的数字.
• 报告每个区块类型和构建者可以写的DataType,并附有其选项的计划(GetCatalog) (中文(简体) ).
• 返回每个变异为 OpResult。它持有在成功时更改的文件,否则会输入错误.

每个行动都是 InterfaceFunction 路由到 @antelopejs/dms-builder。该模块对工程进行解析,将编辑应用为 AST 重写,只有在工程仍然进行打字检查时才写.

安装

在调用构建器的模块中添加接口.

pnpm add @antelopejs/interface-dms-builder

快开始

以下代码创建一页并在上面放入了KPI卡.

import { AddBlock, CreatePage } from "@antelopejs/interface-dms-builder";

const page = await CreatePage({
  name: "revenue",
  displayName: "Revenue",
  category: "pages",
  icon: "i-ph-chart-line",
});
if (!page.ok) {
  throw new Error(`could not create the page: ${page.error.code}`);
}

const block = await AddBlock({
  page: page.data.ref,
  name: "total",
  type: "KpiCard",
  config: { title: "Total revenue", icon: "i-ph-currency-eur" },
});
if (!block.ok) {
  throw new Error(`could not add the block: ${block.error.code}`);
}

兼容性

界面宣布此对等依赖 :

这个 @antelopejs/dms-builder 模块执行此接口。 这个 @antelopejs/interface-dms-builder 相容区块中的行 模块读取器 给出每个模块的释放工具的接口范围。 执行不是接口软件包的同伴依赖。 它只在发展中运行,除非它 api.enabled 选项打开.

文档

• 扩展构建者 覆盖接口和HTTP API.
• 界面参考 是犬科合同。 它带着这个包装船,并发表在 /docs/模块/建设者/参考。 。 。 .
• 没有代码的图表 从选择一个计量到重新打开的页面都遵循一个图表.

捐款

这个包裹住在 AntelopeJS/dms-builder pnpm 工作空间,位于执行它的模块旁边. 读取 捐款额 编辑 仓库读取器 用于开发命令。 在模块执行之前释放此软件包 .

许可证

阿帕奇 - 2.0