Download the PHP package marshmallow/nova-calendar without Composer
On this page you can find all versions of the php package marshmallow/nova-calendar. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download marshmallow/nova-calendar
More information about marshmallow/nova-calendar
Files in marshmallow/nova-calendar
Package nova-calendar
Short Description A powerful event calendar Tool for Laravel's Nova 5.
License AGPL-3.0-or-later proprietary
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package nova-calendar
Event calendar for Laravel Nova 5
An event calendar that displays Nova resources or other time-related data in your Nova 5 project on a monthly calendar view that adapts nicely to clear and dark mode.
[!important] This package was originally forked from wdelfuego/nova-calendar. Since we were making many opinionated changes, we decided to continue development in our own version rather than submitting pull requests that might not benefit all users of the original package. You're welcome to use this package, we're actively maintaining it. If you encounter any issues, please don't hesitate to reach out.
What can it do?
This calendar tool for Nova 5 shows existing Nova resources and, if you want, dynamically generated events, but comes without database migrations or Eloquent models itself. This is considered a feature. Your project is expected to already contain certain Nova resources for Eloquent models with DateTime fields or some other source of time-related data that can be used to generate the calendar events displayed to the end user.
The following features are supported:
- Automatically display Nova resources on a monthly calendar view
- Mix multiple types of Nova resources on the same calendar
- Display events that are not related to Nova resources
- Use event filters to limit the amount of events shown on the calendar
- Add badges to events and calendar days to indicate status or attract attention
- Customize visual style and content of each individual event
- Laravel policies are respected to exclude events from the calendar automatically
- Allows end users to navigate through the calendar with hotkeys
- Allows end users to navigate to the resources' Detail or Edit views by clicking events
Requirements
- PHP
^8.2 - Laravel Nova
^5.0 illuminate/support^10,^11,^12or^13
Installation
Install the package through Composer:
The package registers its ToolServiceProvider automatically through Laravel's package discovery, so no manual provider registration is needed.
Publish the config file:
This creates config/nova-calendar.php with a working starting configuration.
Getting started
Adding a calendar to Nova takes a few steps. The full walkthrough lives in the documentation; the short version is below.
1. Create a data provider
A data provider supplies the events for a calendar. Generate the default one:
This creates App\Providers\CalendarDataProvider, a subclass of Marshmallow\NovaCalendar\DataProvider\AbstractCalendarDataProvider. Implement novaResources() to map Nova resources to the DateTime attribute(s) that define when each event starts and, optionally, ends:
Any attribute named here must be cast to a DateTime by the underlying Eloquent model. Returning an empty array yields a working but empty calendar.
2. Register the calendar tool
Add the calendar to the tools() method of your App\Providers\NovaServiceProvider, passing the calendar key from the config file:
If you build your Nova main menu manually, link to the calendar with NovaCalendar::pathToCalendar():
Configuration
Most calendar configuration is done at runtime from your data provider, but each calendar instance needs an entry in config/nova-calendar.php, keyed by a unique calendar key. Each entry supports the following options:
| Option | Required | Description |
|---|---|---|
dataProvider |
yes | The data provider class that supplies the event data for this calendar. |
uri |
yes | URI the calendar is served under, appended to the Nova path. With my-calendar and Nova on /nova, the calendar lives at /nova/my-calendar. Must be unique. |
windowTitle |
no | Fixed browser tab title. If omitted or empty, the dynamic title generated by the data provider is used instead. |
Multiple calendars are configured by adding more keyed entries:
See Adding more calendar views for details.
Documentation
Full documentation — including event filters, badges, event visibility, custom event generators, customizing events and the calendar, and the upgrade guide — is available at marshmallow-packages.github.io/nova-calendar and in the docs/ directory.
License summary
Anyone can use and modify this package in any way they want, including commercially, as long as the commercial use is a) creating implemented calendar views and/or b) using the implemented calendar views. Basically the only condition is that you can't sublicense the package or embed it in a framework (unless you do so under the AGPLv3 license). Usage in Nova is not compatible with the AGPLv3 license. More details in LICENSE.md.
Contributing
Contributions are welcome. Please see the issue tracker.
Security
If you discover a security vulnerability, please email [email protected] rather than using the public issue tracker.
Credits
- Marshmallow
- wdelfuego — original author of the package this was forked from
- All contributors
