o-ba / custom_dashboard_widgets
新仪表板模块的自定义小部件集合。让我们开始创建自己的吧!
Requires
- php: >=8.0
- typo3/cms-core: ^12.4
- typo3/cms-dashboard: ^12.4
Requires (Dev)
- roave/security-advisories: dev-master
Suggests
- typo3/cms-extensionmanager: Needed for widget 'localExtensions'
- typo3/cms-scheduler: Needed for widget 'failedSchedulerTasks'
Replaces
- typo3-ter/custom_dashboard_widgets: 1.3.0
README
1. 简介
此扩展为自TYPO3 v10.3以来的新仪表板模块添加了一组小部件。
但是,它仅与TYPO3 v10.4及更高版本一起工作,因为小部件注册在此版本中已被重做。
背景
此扩展是从t3security_news_widget发展而来,该小部件已过时,因为它使用旧方式注册小部件,但它已经被实现为核心小部件,并通过此补丁实现。
2. 安装
使用Composer安装
如果您正在使用基于Composer的TYPO3项目,只需运行composer require o-ba/custom_dashboard_widgets
。
从TER(TYPO3扩展存储库)安装
您可以在扩展管理模块中下载和安装扩展,或者从typo3.org下载ZIP文件,然后在扩展管理模块中上传。
第一步
安装后,切换到仪表板模块。
如果您尚未设置任何仪表板,TYPO3将自动创建两个仪表板,这些仪表板在预置中定义。默认仪表板,由核心提供,以及包含此扩展中所有自定义小部件的自定义仪表板。
如果您已经创建了一些仪表板,只需通过点击仪表板选择标签栏中的+
按钮来创建一个新的仪表板。在向导中选择自定义仪表板
。这将创建前面提到的相同仪表板,包括此扩展的所有小部件。
您还可以将一些自定义小部件添加到现有仪表板中。这在上面的官方文档中有详细说明。
3. 其他注意事项
此扩展旨在作为以下示例扩展:
- 添加自定义小部件(包括自定义模板、自定义样式表等)
- 添加自定义数据提供者
- 添加自定义按钮提供者
- 扩展核心API类
- 添加自定义小部件组
- 添加自定义仪表板预置
- 为后端用户添加TSconfig预置
- 等等...
有关更多信息,请参阅官方文档。
重要
包含的小部件和数据提供者不会评估任何权限!因此,大多数小部件不应为编辑器启用,而应由管理员使用。
包含的小部件
extensionInformation
:使用扩展的按钮提供者自定义模板的简单信息小部件failedSchedulerTasks
:显示失败的任务并使用扩展的按钮提供者链接到模块recentlyCreatedPages
:显示具有编辑链接的已定义数量的最近创建的页面recentlyModifiedContent
:显示具有编辑链接的已定义数量的最近修改的内容localExtensions
:显示安装中第三方扩展的数量typeOfPages
:显示按页面类型划分的页面数量的饼图typeOfContent
: 展示不同内容类型内容元素数量的条形图t3blog
: 来自 typo3.com 的博客文章列表contribute
: 包含如何贡献信息的信息小部件
包含的数据提供者
ExtendedButtonProvider
: 扩展默认按钮提供者以包含图标和链接到模块的可能性FailedSchedulerTasksDataProvider
: 获取失败的任务调度程序任务列表数据提供者ListOfRecordsDataProvider
: 通过给定的表、限制和排序提供记录列表LocalExtensionsDataProvider
: 提供系统中存在的本地扩展数量RecordsByTypeDataProvider
: 提供包含每种记录类型记录数量的图表数据
扩展的API类
WidgetApi
: 增加了更多颜色和随机选项
依赖关系
以下小部件需要通过composer安装此扩展时建议的额外TYPO3包。
failedSchedulerTasks
: 需要typo3/cms-scheduler
localExtensions
: 需要typo3/cms-extensionmanager
所提到的小部件通过 services.php
而不是 services.yaml
进行配置,以确保仅在安装了所需的依赖项时才可用。
屏幕截图
4. 致谢
本存储库中使用的图标由 Freepik 制作,来自 www.flaticon.com