README

为 Laravel 项目添加导游/帮助的 Laravel 包。

这是一个简单的包，帮助开发者为产品中的页面添加导游。

例如：定义或解释 UI 中任何组件（如按钮/标签）的用法。

该包为开发者提供了一个丰富的 UI 来创建/编辑/删除/更新应用中定义的路由的导游。

此包包括

迁移 - 跟踪哪些视图使用哪些导游文件
资源文件 - 用于导游的 UI
views/Controller/Model - 用于导游 CRUD 操作

该包使用 https://github.com/LinkedInAttic/hopscotch 来显示导游。

安装

composer require zusamarehan/tourify

将 ServiceProvider 添加到 config/app.php 中的 providers 数组

  Zusamarehan\Tourify\TourifyServiceProvider::class

注意：提供者使用 App\Providers\RouteServiceProvider::class，因此需要添加在应用程序服务提供者之后。

然后您需要使用以下命令发布一些资源

php artisan vendor:publish

一旦公开成功，您需要在主布局文件中导入样式表和 js 文件，如下所示

    <link rel="stylesheet" href="{{ asset('/vendor/zusamarehan/tourify/css/hopscotch.css') }}">
    <script rel="stylesheet" src="{{ asset('/vendor/zusamarehan/tourify/js/hopscotch.js') }}"></script>

同时运行迁移。

使用方法

可用的端点是

/productTour/create
- 用于创建新的导游
/productTour/list
- 用于列出创建的导游进行修改/删除

安装成功后，转到 /productTour/create，它将显示在 web.php 文件中指定的可用路由名称。

您可以选择名称并点击添加导游。在这里，您需要指定要针对或显示帮助/导游的 div ID。在组件中必须有 ID。

一旦您对导游数据满意，您可以保存它。它将在您的存储中创建一个文件。您不应手动编辑或删除它。

最后一步是在视图文件的末尾添加一个自定义 blade 指令

@tour

以便能够在页面加载时运行导游。

注意

要将导游添加到您的页面，需要路由名称。
为了能够定位 UI 组件，需要一个 ID，以便包能够识别。
由包创建的表数据和文件不应由开发者手动删除。

zusamarehan / tourify

维护者

详细信息

README

此包包括

安装

使用方法

注意