5balloons/livewire-tooltip

使用laravel livewire的动态提示组件

v2.2.0 2024-08-02 09:46 UTC

This package is auto-updated.

Last update: 2024-09-02 09:57:02 UTC


README

为Laravel Livewire提供的一个动态、易于使用的提示组件,允许开发者以最小的努力将交互式提示添加到他们的Laravel应用程序中。

功能

  • 通过Livewire动态加载内容
  • 使用Popper.js自定义提示位置
  • 易于与任何Laravel项目集成
  • 支持HTML内容和异步数据获取

安装

要安装此包,请在终端运行以下命令

composer require 5balloons/livewire-tooltip

用法

要在Livewire视图中使用LivewireTooltip组件,您需要按照以下步骤操作

安装PooperJs

您可以通过npm安装PopperJS,或者简单地将以下CDN文件包含在布局文件的头元素中。

    <script src="https://unpkg.com/@popperjs/core@2"></script>    

在视图中/布局中包含提示组件

将提示组件包含在您想要实现动态提示的视图文件中,或者如果您打算在整个应用程序中使用提示,可以将其包含在布局文件中。

    <livewire:livewire-tooltip />

提示元素

触发提示的链接示例

<a class="tooltip-link" tooltip-method="\App\Http\Controllers\YourController::tooltip">Hover me</a>

要实现动态提示功能,您需要在控制器中定义一个名为tooltip的方法。此方法应返回一个字符串或包含要显示在提示中的内容的视图文件。

以下是在控制器中定义tooltip方法的一个示例

public function tooltip()
{
    // Your code here to generate the tooltip content
    return 'This is the tooltip content';
}

请将'This is the tooltip content'替换为您想要在提示中显示的实际内容。

一旦您定义了tooltip方法,您就可以在视图中使用它,通过在提示链接元素中添加tooltip-method属性,如下所示

<a class="tooltip-link" tooltip-method="\App\Http\Controllers\YourController::tooltip">Hover me</a>

请记住将\App\Http\Controllers\YourController替换为您控制器实际的命名空间和类名。

这就完成了!现在当用户将鼠标悬停在提示链接上时,tooltip方法将被调用,并返回的内容将在提示中显示。

提示方法可以返回字符串或视图文件。提示组件应该能够解析动态变量并在提示内渲染内容

高级用法

对于动态内容加载和自定义定位

<a class="tooltip-link" tooltip-method="\App\Http\Controllers\YourController::tooltip" data-param1="value" data-placement="bottom">Hover for dynamic content</a>

您可以向方法传递参数,并指定如上例所示的提示位置

许可证

此包是开源软件,受MIT许可证许可。