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属性。

示例

<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

变更日志

请参阅变更日志了解最近的变化信息。

贡献

请参阅贡献指南了解详细信息。

安全

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

鸣谢

许可

MIT 许可（MIT）。请参阅许可文件了解更多信息。

ionutrusen / livewire-calendar

维护者

详情