README

此软件包允许您构建一个 Livewire 每月日历网格，显示每一天的事件。事件可以从组件内部加载，并根据事件的日期在每一天显示。

预览

安装

您可以通过 composer 安装此软件包

composer require asantibanez/livewire-calendar

需求

此软件包底层使用 livewire/livewire (https://laravel-livewire.com/)。

它还使用 TailwindCSS (https://tailwind.org.cn/) 进行基本样式化。

请在使用此组件之前确保包含这两个依赖项。

用法

为了使用此组件，您必须创建一个新的 Livewire 组件，该组件从 LivewireCalendar 扩展

您可以使用 make:livewire 创建一个新的组件。例如。

php artisan make:livewire AppointmentsCalendar

在 AppointmentsCalendar 类中，不要从基本的 Component Livewire 类扩展，而是从 LivewireCalendar 扩展。同时，删除 render 方法。您将有一个类似于以下片段的类。

class AppointmentsCalendar extends LivewireCalendar
{
    //
}

在此类中，您必须重写以下方法

public function events() : Collection
{
    // must return a Laravel collection
}

在 events() 方法中，返回一个包含将在日历上显示的事件的集合。事件必须是包含至少以下键的键数组：id、title、description、date（《date》必须是 Carbon\Carbon 实例）。

示例

public function events() : Collection
{
    return collect([
        [
            'id' => 1,
            'title' => 'Breakfast',
            'description' => 'Pancakes! 🥞',
            'date' => Carbon::today(),
        ],
        [
            'id' => 2,
            'title' => 'Meeting with Pamela',
            'description' => 'Work stuff',
            'date' => Carbon::tomorrow(),
        ],
    ]);
}

date 值将用于确定事件属于哪一天。要在 events() 方法中加载值，您可以使用以下组件属性来过滤事件。

startsAt：月份的开始日期
endsAt：月份的结束日期
gridStartsAt：日历网格的开始日期。可以是上个月的一个日期。
endingStartsAt：日历网格的结束日期。可以是下个月的一个日期。

示例

public function events(): Collection
{
    return Model::query()
        ->whereDate('scheduled_at', '>=', $this->gridStartsAt)
        ->whereDate('scheduled_at', '<=', $this->gridEndsAt)
        ->get()
        ->map(function (Model $model) {
            return [
                'id' => $model->id,
                'title' => $model->title,
                'description' => $model->notes,
                'date' => $model->scheduled_at,
            ];
        });
}

现在，我们可以在任何视图中包含我们的组件。

示例

<livewire:appointments-calendar/>

这将渲染一个日历网格。

默认情况下，组件将渲染当前月份。如果您想更改开始月份，可以设置 year 和 month props。

示例

<livewire:appointments-calendar
   year="2019"
   month="12"
/>

您应包含 @livewireCalendarScripts 脚本来启用拖放功能，该功能默认开启。您必须在 @livewireScripts 之后包含它们

@livewireScripts
@livewireCalendarScripts

该组件有 3 个公共方法，可以帮助在月份之间导航

goToPreviousMonth
goToNextMonth
goToCurrentMonth

您可以在下文解释的 before-calendar-view 或 after-calendar-view 的额外视图中使用这些方法。

高级用法

UI 定制

当在视图中渲染时，您可以使用以下属性来自定义组件的行为

week-starts-at 可以是一个从 0 到 6 的数字，根据 Carbon 星期几来指示日历应该从周几开始渲染。
event-view 可以是任何用于渲染事件卡的 blade.php 视图。此视图将注入一个包含其数据的 $event 变量。
before-calendar-view 和 after-calendar-view 可以是任何在日历本身之前或之后渲染的 blade.php 视图。这些可以用于使用 Livewire 添加组件的额外功能。
drag-and-drop-classes 可以是任何用于在日历中拖动事件到每一天时渲染悬停效果的 CSS 类。默认情况下，此值为 border border-blue-400 border-4
day-of-week-view 可以是任何用于渲染日历每一天标题的 blade.php 视图。此视图将注入 day 属性，它是一周中某天的 Carbon 实例。

<livewire:appointments-grid
    week-starts-at="0, 1, 2, 3, 4, 5 or 6. 0 stands for Sunday"
    event-view="path/to/view/starting/from/views/folder"
    day-of-week-view="path/to/view/starting/from/views/folder"
    before-calendar-view="path/to/view/starting/from/views/folder"
    after-calendar-view="path/to/view/starting/from/views/folder"
    drag-and-drop-classes="css classes"
/>

高级 UI 定制

(应使用基于组件默认视图的 blade 视图使用这些选项)

要使用这些选项，建议发布组件使用的基 blade 视图，并扩展它们的行为和样式以满足您的需求。为此，运行 php artisan vendor:publish 并导出 livewire-calendar 标签。

calendar-view 可以是任何渲染整个组件的 blade.php 视图。建议您用修改后的基 calendar-view 的副本覆盖此视图，例如添加一个视图到组件旁边。
day-view 可以是任何用于渲染每个月每一天的 blade.php 视图。此视图将注入以下属性：componentId（Livewire 组件的 id）, day（月份中的某天，作为 Carbon 实例）, dayInMonth（如果该天是月份的一部分），isToday（如果该天是今天的日期）, events（与该天对应的事件集合）

示例

<livewire:appointments-grid
    calendar-view="path/to/view/starting/from/views/folder"
    day-view="path/to/view/starting/from/views/folder"
/>

交互定制

您可以通过覆盖以下方法来为组件添加交互性

public function onDayClick($year, $month, $day)
{
    // This event is triggered when a day is clicked
    // You will be given the $year, $month and $day for that day
}

public function onEventClick($eventId)
{
    // This event is triggered when an event card is clicked
    // You will be given the event id that was clicked 
}

public function onEventDropped($eventId, $year, $month, $day)
{
    // This event will fire when an event is dragged and dropped into another calendar day
    // You will get the event id, year, month and day where it was dragged to
}

自动轮询

如果需要，您还可以使用 pollMillis 参数添加自动轮询。您可以将它与 pollAction 结合使用，以便在所需的轮询间隔调用组件中的特定操作。

禁用交互

默认情况下，启用点击和拖放事件。要禁用它们，您可以在渲染组件时使用以下参数

<livewire:appointments-grid
    :day-click-enabled="false"
    :event-click-enabled="false"
    :drag-and-drop-enabled="false"
/>

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全

如果您发现任何与安全相关的问题，请通过电子邮件发送到 santibanez.andres@gmail.com，而不是使用问题跟踪器。

鸣谢

许可

MIT 许可证 (MIT)。请参阅许可文件了解更多信息。

christianatmoney / livewire-calendar

维护者

详细信息