northwestern-sysdev/dynamic-forms-directory-search

西北目录搜索组件,用于动态表单


README

这是一个Laravel的Dynamic Forms组件,用于在西北目录中进行查找。

它提供了表单构建器/展示UI以及用于查找的控制器。

安装

您应该已经在使用Dynamic Forms for Laravel。这些说明假设您已经设置好了。

您需要一个具有访问目录搜索-基础权限的应用程序。您可以在API服务注册表中请求访问权限。您的API密钥应存在于.env文件中。

DIRECTORY_SEARCH_API_KEY=

# This defaults to prod when it is not specified.
DIRECTORY_SEARCH_URL=https://northwestern-prod.apigee.net/directory-search

准备好后,您可以通过Composer安装组件

composer require northwestern-sysdev/dynamic-forms-directory-search
php artisan dynamic-forms:directory:install

您需要做两项进一步更改

  1. 在现有的Dynamic Forms路由组内添加新的控制器路由

    Route::get('directory/{search}', Controllers\DynamicFormsDirectoryController::class)->name('directory');
  2. 在您的resources/js/formio/index.js文件中将UI组件注册到Formiojs库中

    import NuDirectoryLookup from "../directory-search";
    import NuDirectoryEditForm from "../directory-search/form";
    
    // . . . skip some lines, look for this comment & add the code below it:
    
    // -------------------------------------------------------------------------
    // If you want to load custom code (like additional components), do it here!
    // -------------------------------------------------------------------------
    Formio.use(NuDirectoryLookup);
    Formio.Components.components.nuDirectoryLookup.editForm = NuDirectoryEditForm;

    然后运行Laravel Mix以使用新组件重建

组件将在表单构建器的高级部分显示。您可以根据需要将其在菜单中重新排列,就像其他组件一样。

贡献

欢迎西北社区成员的拉取请求!