mtrdesign/krait

Krait提供了一种简单创建Ajax Datatables的方法。


README

image

Total Downloads Latest Stable Version

Krait是一个功能强大的Laravel包,简化了Ajax动态Datatables的创建。它通过简单的CLI命令自动化前端和后端资源的初始结构开发。

Krait包单一代码库

为了确保版本一致性并增强核心前端组件的开发,除了我们引入的PHP包外,我们还引入了一个专门的前端库,称为krait-ui。因此,最终的包由两部分组成,包含在这个单一代码库中

  • /krait-ui:基于VueJS的DataTable UI工具包,包含所有前端组件。
  • /krait:包含所有后端功能的主要Laravel包。

官方文档

有关该包的更多信息,请参阅Krait文档网站

快速入门

Krait的安装过程很简单,您可以遵循此指南快速配置所有内容,然后查看详细的官方文档。

安装

您可以通过运行以下命令来安装该包:

composer require mtrdesign/krait

然后,您应该通过运行以下命令来完成安装:

php artisan krait:install

就这么简单!现在您已安装并配置了所有JS和PHP依赖。

最后一步...

为了成功运行前端库,您应该告诉Vue使用krait-ui插件。

// Importing the Krait Vue plugin
import Krait from "@mtrdesign/krait-ui";

// Importing the autogenerataed tables module
import tables from './components/tables'

/**
 * ... Here you initialise your VueApp ...
 * 
 * const app = Vue.createApp({});
 */

app.use(Krait, {
    tables: tables
});

使用

要创建您的第一个表格,请运行以下命令

php artisan krait:table MyFirstTable

此命令将创建三个资源

  • /app/Tables/MyFirstTable.php - 表格类定义(表名、列、回调等)
  • /app/Http/Controllers/Tables/MyFirstTableController.php - 获取表格内容的控制器
  • /resources/js/components/tables/MyFirstTable.vue - 代表数据的VueJS前端组件

重要:为了保持一致性,app/Tables中的所有表格类都应该以Table结尾,以正确注册。

有关安装和使用方面的更多详细信息,请参阅官方文档

贡献

不要犹豫,提出问题和提出改进意见!任何帮助都是受欢迎的!

您可以在单一代码库项目中找到有关包开发过程的更多信息

  • /krait-ui - 用于前端功能
  • /krait - 用于后端功能

更多贡献细节可以在官方贡献部分中找到。

许可

Krait是开源软件,根据MIT许可授权。