Canvas Docs

Events Calendar

A month-grid calendar of your events, with previous / next / today controls. Each day links to the events happening on it. It is shown in the block inserter as Events Calendar and registered as canvas-core/events-calendar.

Select the block on a page and its own settings open in the sidebar, in the panels below:

The Events Calendar settings in the block editor sidebar

Settings

Each setting is named exactly as the block editor names it, followed by what it does and what it starts as. Where a setting carries a Shown when line, it stays hidden until that condition is met, which is the usual reason a setting looks missing from the sidebar:

  • Show HeaderDefaultOn

    Shows the bar above the calendar carrying the title, the month and the controls that move between months.

  • TitleDefaultEvents Overview

    The heading in that bar. Leave it empty for a bar carrying only the month and the controls.

    Shown when Show Header is on

  • Title TagDefaultH2

    Which heading level that title uses, so the calendar fits the outline of the page around it.

    ChoicesH1H2H3H4H5H6Shown when Show Header is on

  • Show Month / YearDefaultOn

    The live readout of the month the calendar is showing.

    Shown when Show Header is on

  • Show Month ControlsDefaultOn

    Previous month, next month and back-to-today buttons.

    Shown when Show Header is on

  • Previous IconDefaultfa-solid fa-chevron-left

    The icon on the button that goes back a month.

    Shown when Show Month Controls is on

  • Next IconDefaultfa-solid fa-chevron-right

    The icon on the button that goes forward a month.

    Shown when Show Month Controls is on

  • Today IconDefaultbi-arrow-clockwise

    The icon on the button that returns the calendar to the current month.

    Shown when Show Month Controls is on

  • Previous Button LabelDefaultPrevious month

    Accessible name: the buttons show only an icon.

    Shown when Show Month Controls is on

  • Next Button LabelDefaultNext month

    Read out by assistive technology in place of that icon, since the button carries no wording.

    Shown when Show Month Controls is on

  • Today Button LabelDefaultGo to current date

    Read out by assistive technology in place of that icon, since the button carries no wording.

    Shown when Show Month Controls is on

  • Header Bar TagDefaultH3

    Which element carries the header bar. Choose the plain container where the bar is a set of controls rather than a heading in the page outline.

    ChoicesH2H3H4Div (no heading semantics)Shown when Show Header is on

  • Header Bar ClassesDefaultEmpty

    Style classes on the header bar, usually to spread the title and the controls to opposite ends of it.

    Shown when Show Header is on

  • Group Month and YearDefaultOff

    Wraps the month and year in their own element so they stay together when the bar is a flex row.

    Shown when Show Month / Year is on

  • Month/Year ClassesDefaultEmpty

    Style classes on the month and year readout in the header bar.

    Shown when Show Month / Year is on

  • Nav Button ClassesDefaultEmpty

    Style classes on all three month buttons.

    Shown when Show Month Controls is on

  • Nav Icon ClassesDefaultEmpty

    Style classes on the icons inside those buttons, in addition to the icon chosen for each.

    Shown when Show Month Controls is on

Events

  • Events ShownDefaultAll events

    A calendar normally shows everything, so past months are not empty.

    ChoicesAll eventsUpcoming onlyPast only

  • Maximum EventsDefault100

    How many events are loaded into the calendar data.

  • Span Multi-Day EventsDefaultOn

    Show an event on every day between its start and end date, not just the first.

  • Link Days to EventsDefaultOn

    Off renders each event as plain text instead of a link.

Calendar

  • Week Starts OnDefaultMonday

    Which day the calendar puts in its first column. Set it to the convention your visitors read weeks by.

    ChoicesSundayMondaySaturday

  • Abbreviate WeekdaysDefaultOff

    Show "Mon" instead of "Monday" in the calendar head.

  • Abbreviate MonthDefaultOff

    Show "Jan" instead of "January" in the header readout.

Every Canvas block also carries the Animation, Scroll Effects and Advanced panels, which are described in Controls every Canvas block has.

Other blocks in Events: Conference Programme, Event Archive Grid, Event Categories, Event Content, Event Date, Event Excerpt.

Was this page helpful?