derekderaps/kalagraphs

Kalagraphs 提供了一种灵活的段落类型，允许编辑器选择使用哪个 Twig 模板来渲染它。

维护者

详细信息

github.com/kalamuna/kalagraphs

主页

源代码

问题

安装次数: 4,451

依赖关系: 0

建议者: 0

安全性: 0

星标: 6

关注者: 27

分支: 2

开放问题: 7

类型:drupal-module

8.1.0-rc3 2017-08-08 23:23 UTC

Requires

  • drupal/allowed_formats: ^1.0
  • drupal/core: ~8.3
  • drupal/options: ~8.0
  • drupal/paragraphs: ~1.0

GPL-2.0+ d5cf974e5e7609900cf02eff6372a13ceada70cc

drupal

This package is not auto-updated.

Last update: 2024-09-15 02:32:34 UTC

README

Kalagraphs 致力于为前端开发者提供工具，帮助他们维护一个可供 Drupal 网站编辑使用的组件库。它通过使组件创建和管理变得简单和低成本来实现这一目标。您不再需要具备牛逼的 PHP 开发技能和 Features 模块的深入知识，仅为了在 CMS 页面上添加组件。让组件名称明确，让标记做它的工作，所有这一切都不需要创建大量的段落类型！

在实际应用中，Kalagraphs 从样式指南（例如，kalastatic、kss 或 Pattern Lab）到实现（通过段落在 Drupal 中）快速开发组件。

目录

理由

优点

  1. 通过去除创建新段落类型的需要，减少将新组件“CMS 化”所需的时间和精力。

  2. 通过精简编辑表单（更少的段落类型）并添加标志/图标来帮助编辑器识别每种类型（计划中），改进编辑用户体验。

  3. 使您能够在不丢失数据/重新输入字段数据的情况下在组件类型之间切换。

没有 Kalagraphs 的生活

  1. 可能还好，但可能会很痛苦。

  2. 需要后端开发资源的可用性，并且对 Drupal 8 主题层有深入的了解。

禁忌

不要尝试将 Kalagraphs 应用于非常复杂的组件；只需创建一个新的自定义段落捆绑包来适应数据模型。这个模块的一个优点是：Kalagraphs 不会干扰标准的段落工作流程，因此希望使用的开发者可以继续使用他们熟悉的工具而不会遇到任何问题。此外，他们甚至可以利用 Kalagraphs 的一些实用功能来处理其他段落捆绑包或完全不同的实体类型。

例如，通常需要在页面上输出组件摘要作为列表中的组件。通过调整摘要视图模式的字段显示格式化程序以使用 Kalagraphs 版本，开发者可以利用所有 Kalagraphs 启用的组件中模板变量所使用的相同的字段处理魔法。

使用方法

入门

  1. 安装模块（@todo 在此处添加指向 Drupal 文档中安装模块的链接）。
  2. @todo 在此处填写更多步骤。

字段格式化

为了使用各种原子组件渲染单个字段，手动为每个 Twig 文件创建主题钩子。然后，扩展 src/Plugin/Field/FieldFormatters 中的每个 Kalagraphs 字段格式化程序，并覆盖 viewValue() 以将适当的主题钩子分配给 $value 渲染数组。更多文档和链接即将提供到本节。