Calendar Documentation

Learn the basics, and get to know Calendar inside and out.

Calendar 1.x Docs

Installation

Requirements #

Solspace Calendar mostly meets the same requirements as listed on the Craft Requirements page.

  • Craft 3.0.0 or later
  • PHP 7.0+
  • MySQL 5.5+ (with InnoDB) or PostgreSQL 9.5+
  • Windows and OS X browsers:
    • Chrome 29 or later
    • Firefox 28 or later
    • Safari 9.0 or later
    • Internet Explorer 11 or later
    • Microsoft Edge

Installing Instructions #

To install Calendar, simply:

  1. Go to the Plugin Store area inside your Craft control panel and search for Calendar.
  2. Choose to install Calendar by clicking on it.
  3. Click on the Try button to install a trial copy of Calendar.
  4. Try things out and if Calendar is right for your site, purchase a copy of if through the Plugin Store when you're ready!

Installation

Calendar can also be installed manually through Composer:

  1. Open your terminal and go to your Craft project: cd /path/to/project
  2. Then tell Composer to require the plugin: composer require solspace/craft3-calendar
  3. In the Craft control panel, go to Settings → Plugins and click the Install button for Calendar.

Quick Setup #

Follow the steps below to quickly get Solspace Calendar setup in minutes.

Settings #

To customize and configure Solspace Calendar settings, visit the Settings page (Calendar > Settings).

Permissions #

Solspace Calendar ties into regular Craft User Group Permissions. Simply visit the permissions page for the applicable user group(s) (Settings > Users > User Groups) to grant/edit/remove permissions to Solspace Calendar.

  • General
    • Access Calendar - required for users to access Solspace Calendar at all.
  • Calendar
    • Administrate Calendars - access to Calendars list page.
      • Create Calendars
      • Edit Calendars
      • Delete Calendars
        • WARNING: Deleting calendar(s) deletes ALL events associated with that calendar as well, so be careful which users have access to this permission.
    • Manage events in - must be checked to have access to managing events
      • All calendars - access to create/edit/delete events for ALL existing and future calendars, regardless of which ones are checked off below.
      • "MY CALENDAR NAME" calendar - access to create/edit/delete events for that specific calendar.
    • Settings - access to settings area for Calendar and Demo Templates install page.

Permissions

Demo Templates #

Install the Demo Templates (Calendar > Settings > Demo Templates) to get Calendar up and running on the front end with just a couple clicks!