diff --git a/docs/src/guide/base/concept.md b/docs/src/guide/base/concept.md index 44fd39cbc..413f6da04 100644 --- a/docs/src/guide/base/concept.md +++ b/docs/src/guide/base/concept.md @@ -1,44 +1,59 @@ # 相关概念 -为了更好描述低代码的工作过程,需要了解以下概念。 +为了更清晰地描述低代码平台的工作机制,需要理解以下核心概念: - **协议** - —— 指低代码开发平台组件、页面的描述约定。 + —— 指低代码开发平台中组件和页面的描述规范,定义了组件的属性、事件、插槽等元数据格式。 -- **DSL** - —— 领域特定语言,指根据协议对低代码页面的描述,是JSON格式的数据。 +- **DSL (Domain Specific Language)** + —— 领域特定语言,基于协议生成的JSON结构数据,用于描述页面布局、组件关系及配置。示例结构: + + ```json + { + "component": "Page", + "props": {...}, + "children": [...] + } + ``` - **页面** - —— 指使用设计器创建的vue单文件组件,带有路由,发布后可通过路由 `/page/页面ID` 访问。 + —— 通过设计器创建的Vue单文件组件(.vue),具有独立路由,发布后可通过 `/page/[页面ID]` 路径访问。 - **区块** - —— 指使用设计器创建可复用的vue单文件组件,不包含路由,可被页面或其他区块引用。 + —— 可复用的Vue单文件组件,不含路由配置,可被页面或其他区块引用组合。 - **物料** - —— 指带有低代码协议描述的vue组件 + —— 符合低代码协议的Vue组件,包含组件元数据描述,可在设计器中拖拽使用。 ## 工作数据流 ![](../../assets/newpearl/13.png) -设计器的作用是通过可视化的方式把低代码物料生成DSL。 +设计器通过可视化操作将低代码物料转换为DSL,主要流程: + +1. 从物料库拖拽组件到画布 +2. 在属性面板配置组件参数 +3. 生成描述页面结构的DSL +4. 通过渲染引擎将DSL转换为可运行代码 ## 入口链接 -启动低代码开发环境,在页面的右下角右编辑的图标,点击可进入到设计器并打开当前页面的设计模式 +启动低代码开发环境后,在页面右下角会出现编辑图标,点击该图标可进入设计器并打开当前页面的设计模式。 ![](../../assets/newpearl/3.png) ## 功能分区 -低代码设计器采用骨架分区的方式构建,功能有以下区域, 没个区域下内置了响应的功能组件`Widget` +低代码设计器采用模块化分区架构,每个区域内置相应的功能组件(Widget): ![](../../assets/newpearl/5.png) -- **品牌区:** 包含品牌Logo、显示当前打开的项目和正在编辑组件,点击链接可返回当前页面组件的源码预览模式。 -- **工具区:** 模拟器视图切换、当前编辑文件的操作历史记录导航。 -- **操作区:** 文件预览、页面刷新、页面设置、发布。 -- **应用区:** 页面管理、区块管理、物料组件库、当前编辑的页面大纲树结构、当前文件编辑历史记录、API管理、数据配置管理、依赖管理、项目配置。 -- **工作区:** 当前文件的设计视图、DSL视图、源码视图、帮助文档、物料市场。 -- **设置区:** 页面设置(状态数据、计算属性、组件方法、生命周期、watch、css、数据源、组件定义),节点设置(属性、样式、事件、指令)。 -- **状态区:** 当前正在设置的节点信息、错误报告。 +- **品牌区:** 显示平台Logo、当前项目名称及正在编辑的组件。点击项目名称可返回源码预览模式。 +- **工具区:** 提供模拟器视图切换(PC/移动)、操作历史导航(撤销/重做)。 +- **操作区:** 包含页面预览、刷新、设置及发布功能。 +- **应用区:** 管理页面、区块、物料库、组件树结构、编辑历史、API接口、数据源、依赖和项目配置。 +- **工作区:** 核心设计区域,支持设计视图、DSL代码视图、源码视图、帮助文档及物料市场。 +- **设置区:** + - 页面级设置:状态数据、计算属性、方法、生命周期、监听器、CSS样式、数据源、组件定义 + - 组件级设置:属性配置、样式调整、事件绑定、指令添加 +- **状态区:** 显示当前选中节点的详细信息及错误报告。 diff --git a/docs/src/guide/base/todo.md b/docs/src/guide/base/todo.md index 555010db1..243cacee0 100644 --- a/docs/src/guide/base/todo.md +++ b/docs/src/guide/base/todo.md @@ -1,27 +1,28 @@ # 创建一个低代码应用( Todo ) - - ## 先导 + 在实现 Todo 待办事项这个功能之前, 先对页面布局信息进行个大概的了解。页面分为`四个区域`,从左到右分别为`应用栏(1)`,`应用管理栏(2)`,`设计视图(3)`和`配置栏(4)`。 在页面上面的5号区域是页面的`视图转换`,可以切换页面成PC/H5/IPad。而6号区域是`页面的配置`。分别是页面的预览、刷新、设置和发布。 ![页面了解](../../assets/todo/know.png)。 - ### 应用栏 - 页面最左边的应用栏。从上到下分别是 `页面管理`、`区块管理`、`组件库`、`大纲树`、`历史记录`、`API管理`、`依赖管理`、`项目配置`。 + +页面最左边的应用栏。从上到下分别是 `页面管理`、`区块管理`、`组件库`、`大纲树`、`历史记录`、`API管理`、`依赖管理`、`项目配置`。 + - `页面管理` 相当于 Views, 新建页面也就是相当于 在 Views 创建一个 .vue 文件 - `区块管理` 相当于 Components 和公共组件库一样。 -- `大纲树` 可以看到页面的 布局结构。 -- `历史记录` 记录着 所有页面的记录,可以进行回退。可以看作 git -- `API管理` 配置请求的处理。 -- `依赖管理` 在应用开发中所需的依赖 -- `项目管理` 管理着应用的信息 +- `大纲树` 可以看到页面的 布局结构。 +- `历史记录` 记录着 所有页面的记录,可以进行回退。可以看作 git +- `API管理` 配置请求的处理。 +- `依赖管理` 在应用开发中所需的依赖 +- `项目管理` 管理着应用的信息 ### 配置栏 -配置栏 中 的展示分为 两种。 -1. 页面的配置 +配置栏 中 的展示分为 两种。 + +1. 页面的配置 2. 组件的配置 #### 页面配置 @@ -30,34 +31,35 @@ ![页面配置](../../assets/todo/pageConfig.png) -- *设置页* 是进行页面的数据管理。 +- _设置页_ 是进行页面的数据管理。 1. `状态数据(state)`相当于 vue2 中 的 `data`; - 2. `计算属性`,相当于 vue2 中 `computed`; - 3. `组件方法`相当于 `methods`; - 4. `侦听器` 相当于 `watch`; + 2. `计算属性`,相当于 vue2 中 `computed`; + 3. `组件方法`相当于 `methods`; + 4. `侦听器` 相当于 `watch`; 5. `生命周期` 相当于 vue 中的生命周期。 -- *CSS* 相当于 style - ```vue - - ``` -- *数据源* 就是请求接口返回来的数据。 -- *定义* - 1. 定义属性 - 2. 定义事件 - 3. 定义插槽 - 4. 注入 `inject` 数据 +- _CSS_ 相当于 style + ```vue + + ``` +- _数据源_ 就是请求接口返回来的数据。 +- _定义_ + 1. 定义属性 + 2. 定义事件 + 3. 定义插槽 + 4. 注入 `inject` 数据 - > 定义属性、定义事件 常用于 `区块`。 类似下面的代码。 - ```vue -