模版配置文件

通过模版配置,可以让用户在系统后台灵活的编辑显示内容。但是,对于模版开发者来说,如果页面中所有的内容都配置成让用户自己在后台编辑,却有着不小的工作量。所以,模版开发者需要自己评估配置多少内容让用户自己在后台编辑。


配置文件使用json文件,需要在manifest.json文件添加配置文件的相对路径。配置文件的demo可以参考系统的默认模版。文档可能说的不是太清楚,后面准备录视频讲解一下。

 

名称 类型 说明
name string 名称
fileName string 文件名称。blade模版去掉后缀,如文件名称index.blade.php,这里就是index
type string 类型:index-首页;article_list-文章列表;article_detail-文章详情;page-单页;layout-布局
description string 描述
layout string 使用的布局文件,如果不需要使用布局文件,可以不配置
blocks object 区块信息。这里定义的区块会在系统后台编辑模版页面的左侧显示
blocks->id string 区块ID,与模版文件中对应的区块id一致。如果这里不设置。在系统后台编辑模版页面的左侧点击模块,中间的预览区域将不能标记出位置
blocks->title string 区块名称。编辑模版页面的左侧模块列表显示的文案
blocks->order int 区块显示排序。预留字段,暂时未使用
blocks->isShow bool 区块是否显示
blocks->configs object 配置信息
blocks->configs->title string 配置名称。编辑模版页面的右侧配置信息会显示对应的文案
blocks->configs->value 可变类型 配置的时候可以统一给空字符串,如果希望编辑模版页面的右侧配置信息有默认值,这里按configs的type给对应值
blocks->configs->type string 配置类型:text-单行文本;textarea-多行文本;richtext-富文本;image-图片;data-单条数据/数据组;dataList-多条数据
blocks->configs->dataType string 数据类型,配置类型为data和dataList的必须要设置。目前支持carousel(轮播图),categoryList(分类列表),navMenuList(导航)
blocks->configs->dataSource object 配置类型为data和dataList的必须要设置。编辑模版页面的右侧配置信息选择数据时需要显示的信息。
blocks->configs->dataSource->api string 检索数据的api,目前全部使用后台的列表方法

幻灯片列表:sys.carousel.getList

导航列表:sys.nav.getList

分类列表:sys.categroy.getList

blocks->configs->dataSource->searchTitle string 检索数据弹窗的标题
blocks->configs->dataSource->autoload bool 检索数据弹窗后,是否自动加载数据
blocks->configs->dataSource->showParamsKey string 检索数据时参数的key,目前全部时search
blocks->configs->dataSource->search array 检索数据搜索相关信息
blocks->configs->dataSource->search->field string 检索数据搜索的字段名称
blocks->configs->dataSource->search->placeholder string 检索数据搜索框的placeholder
blocks->configs->dataSource->search->type string 检索数据搜索框的类型,目前只支持text
blocks->configs->dataSource->showSearchFields array 检索数据搜索列表显示的信息
blocks->configs->dataSource->showSearchFields->field string 字段名称
blocks->configs->dataSource->showSearchFields->title string 显示标题
blocks->configs->dataSource->showSearchFields->width int 列宽度,可以不设置
blocks->configs->dataSource->showFields array 选中的数据显示的信息
blocks->configs->dataSource->showFields->field string 字段名称
blocks->configs->dataSource->showFields->title string 显示标题

 

另外,布局文件要在blocks中设置slot,这样布局文件中的公共配置就不用在每个文件中配置。固定格式如下

"slot":{
	"id":"slot"
}

 

芸签CMS采用PHP7.4+Mysql5.7架构。基于Apache2.0开源协议,完全开源,基于laravel框架,使用redis缓存,提高了系统的吞吐能力。提供免费版本产品,帮助企业快速构建企业网站及其他企业级应用。
联系我们
电话:18998437745
邮箱:cms@yunqiankeji.com
地址:广州市白云区机场路1600号汇创意产业园C2栋202单元
芸签CMS客服
扫一扫添加联系人企业微信
芸签微信公众号
扫一扫了解更多
广州市芸签信息科技有限公司
备案号:粤ICP备20018750号-3