derekderaps / kalaponents
Requires
- drupal/allowed_formats: ^1.0
- drupal/core: ~8.3
- drupal/options: ~8.0
- drupal/paragraphs: ~1.0
This package is not auto-updated.
Last update: 2022-02-01 13:06:46 UTC
README
Kalagraphs旨在通过提供工具,让前端开发者能够维护一个可供Drupal站点编辑使用的组件库。它通过使组件易于创建和管理来实现这一点。不再需要具备出色的PHP开发技能和对Features模块的深入了解,才能将组件添加到CMS页面。让组件名称具体,让标记做它的事情,而无需创建大量难以管理的段落类型!
在实践中,Kalagraphs通过从风格指南(例如,kalastatic、kss或Pattern Lab)到实现(通过段落实现Drupal)来促进组件的快速开发。
目录
理由
优势
-
通过移除创建新段落类型的需求,减少将新组件“CMS化”所需的时间和努力。
-
通过精简编辑表单(较少的段落类型)并添加标志/图标来帮助编辑器识别每种类型(计划中),提高编辑用户体验。
-
能够在不丢失数据/无需重新输入字段数据的情况下在组件类型之间切换。
没有Kalagraphs的生活
-
可能没问题,但可能会很痛苦。
-
需要后端开发资源,并且需要深入了解Drupal 8主题层。
禁忌症
不要尝试将Kalagraphs强行应用于非常复杂的组件;只需创建一个新、自定义的段落捆绑包以适应数据模型。这个模块的一个好处是:Kalagraphs不会干扰标准的段落工作流程,因此希望继续使用熟悉工具的开发者可以毫无麻烦地继续使用。此外,他们甚至可以利用一些Kalagraphs的实用功能,与其他段落捆绑包或完全不同的实体类型一起使用。
例如,通常需要在页面上以组件的形式输出节点摘要,例如在列表中。通过调整摘要视图模式的字段显示格式化程序以使用Kalagraphs版本,开发人员可以利用所有Kalagraphs启用组件上模板变量通知的相同字段处理魔法。
使用方法
入门指南
- 安装模块(待补充:添加指向Drupal文档中安装模块的链接)。
- @todo 在此处填写更多步骤。
字段格式化
要使用各种原子组件渲染单个字段,请为每个Twig文件手动创建主题钩子。然后,在src/Plugin/Field/FieldFormatters
中扩展每个Kalagraphs字段格式化器,并覆盖viewValue()
以将适当的主题钩子分配给$value
渲染数组。本节将提供更多文档和链接。