tpaksu / laravel-todobar
一个简单的待办事项列表抽屉,用于开发任务列表
README
TodoBar创建了一个覆盖右侧边栏,以简化您的Laravel项目任务管理。
-
它将任务存储在位于
/resources/todobar
文件夹中的JSON文件中,该文件夹与您存储库中的代码共享,因此您可以在您开发项目的任何平台上获取任务。 -
它支持多个组,您可以使用它来跟踪项目中的不同方面,并且您可以通过单个下拉菜单轻松地在组之间切换。
-
它使用Bootstrap组件作为前端库,并且用于“编辑任务”模态框。
预览
经典模式
安装
您可以通过以下方式使用composer安装此包
composer require tpaksu/laravel-todobar --dev
侧边栏默认启用,但您可以通过添加以下内容来禁用它
TODOBAR_ENABLED=false
到您的环境变量中,并运行php artisan config:cache
来更新配置缓存。
包内容
此包发布了包中使用的视图和配置文件,该文件包含三个设置
-
enabled:通过在您的
.env
文件中设置环境变量(TODOBAR_ENABLED
)或在没有环境值的情况下更改默认值来启用侧边栏。 -
start_visible:定义页面加载时的可见性,如果您将其设置为true,则侧边栏将在页面加载时显示。
-
overlay:定义侧边栏是否将覆盖网页的一部分(覆盖),或者缩小页面并在其旁边显示整个页面。
此包使用和发布的视图
+ resources/views/vendor/tpaksu/todobar
+-- partials
| +-- form.blade.php
| |-- handle.blade.php
| |-- projects.blade.php
| +-- tasks blade.php
+-- todobar.blade.php
扩展
该包包含一个Storage
文件夹,其中包含一个接口DataStorageInterface
,定义数据存储提供程序存储库,以及一个示例JSONStorage
类,用于处理在JSON文件中的数据持久化。如果您想使用除JSON文件之外的其他内容来存储任务,您可以创建一个实现DataStorageInterface
的类,并通过更改配置如下使用该类
"storage" => [ "engine" => \App\TodoBar\CustomStorage::class, "params" => [ "param" => "[ Passed to your class ]", ], ],
贡献
您随时可以向此包发送pull请求。请描述为什么以及代码中发生了什么变化,这样我可以快速批准它们。
安全
如果您发现任何与安全相关的问题,请直接通过电子邮件tpaksu@gmail.com联系,而不是使用问题跟踪器。
许可证
MIT许可证(MIT)。