hevinci / mockup-bundle
用于创建和导出模拟的工具包
Requires
- php: >=5.4.1
- claroline/distribution: >=7.0
This package is not auto-updated.
Last update: 2024-09-14 16:39:49 UTC
README
composer require hevinci/mockup-bundle dev-master
用法
- 在您的工具包的 Resource/views 目录中创建一个 mockup 目录。或者,您也可以在应用程序的 app 目录中执行相同操作
app Resources MyVendorMyBundle views mockup
-
在此目录中创建一些模拟。模拟基本上是twig模板,如果需要,可以借助提供的库(见下文)。
-
使用带有 path 查询参数的 mockup 路由来渲染特定的模拟。例如,渲染模板
FooBarBundle::mockup/test.html.twig
的url将是 http://localhost/myproject/mockup?path=foobar/test.html。请注意- 路径必须以短名称的包名作为前缀
- mockup 路径段必须省略
- .twig 扩展名必须省略
-
使用
hevinci:mockup:export
命令来生成您模拟的独立版本。该命令将生成包含静态html文件和所有所需资源的包。目前此命令接受作为参数的包名(例如FooBarBundle
)或模板引用(例如FooBarBundle::mockup/test.html.twig
)
映射
默认情况下,hevinci:mockup:export
命令导出找到的所有模板,并在生成的包根目录中的 index.html 文件中引用它们。如果您只想导出一部分模拟或希望以特定顺序对模拟进行排序,您可以在 mockup 目录中放置一个 map.yml
#FooBarBundle/Resources/views/mockup/map.yml - mockup-y.html.twig - mockup-x.html.twig - baz/mockup-z.html.twig
库
claroline/layout.html.twig
提供claroline页面的基本结构,包括以下块
- 标题
- 侧边栏
- 导航栏
- 面板内容
- 面板标题
- 面板剩余部分
- 模态框
claroline/tool.html.twig
提供工具布局。使用专用变量自动渲染页面的一些部分。例如,以下模板
{% extends 'HeVinciMockupBundle::library/claroline/tool.html.twig' %} {% set toolName = 'My tool' %} {% set toolSection = 'Administration' %} {% set toolPage = ['Users', 'Management'] %}
将被渲染为“我的工具”管理工具的“用户/管理”页面。
可用变量的完整列表
- toolName:工具的名称
- toolSection:平台部分(“管理”、“办公室”或“活动空间”)
- toolIcon:工具的字体图标简短名称
- toolPage:工具当前页面的路径(导航栏)
- toolWorkspace:工具的工作区名称(仅限工作区部分)
claroline/modal.html.twig
提供具有以下块的模态对话框基本结构
- 标题
- 主体
- 页脚
主布局模板及其所有子模板中已存在一个模态插槽。您可以使用 embed
标签包含模态框
{% extends "HevinciMockupBundle::library/claroline/tool.html.twig" %} {% block modal %} {% embed "HeVinciMockupBundle::library/claroline/modal.html.twig" %} {% block title %}Titre de la modale...{% endblock %} {% block body %} <form action="#" method="POST"> ... </form> {% endblock %} {% endembed %} {% endblock %}
claroline/resourceManager.html.twig
提供具有一个块的资源管理器布局
- 资源
此模板是 tool.html.twig 的子模板,因此可以与其关联的变量(见上文)一起使用
{% extends 'HeVinciMockupBundle::library/claroline/resourceManager.html.twig' %} {% set toolSection = 'Espaces d\activités' %} {% set toolWorkspace = 'Mon espace' %} {% block resources %} ... {% endblock %}
模板包括一个用于创建缩略图的宏,称为 resource
。此宏接受一个选项哈希表
- name(资源名称)
- icon(缩略图资产的路径)
- customActions(资源菜单中的附加操作列表)
示例
{% extends 'HeVinciMockupBundle::library/claroline/resourceManager.html.twig' %} {% import 'HeVinciMockupBundle::library/claroline/resourceManager.html.twig' as macros %} {% block resources %} {{ macros.resource({ "name": "Nouvelle ressource", "icon": "bundles/foobar/images/res_new.png", "customActions": ["Partager", "Exporter"] }) }} {% endblock %}
待办事项
- 允许导出特定的模拟目录
- 扩展库