Component

Calendar

Generates a calendar table

Search for usage of this component on GitHub.

How it looks (preview) (preview all)

2018

26 December	Wednesday	Boxing Day
2 January	Tuesday	New Year’s Day (substitute day)

How to call this component

<%= render "components/calendar", {
  caption: "Upcoming bank holidays in England and Wales",
  year: 2018,
  events: [
    {
      title: "Boxing Day",
      date: "2018-12-26 00:00:00 +0000"
    },
    {
      title: "New Year’s Day",
      date: "2018-01-02 00:00:00 +0000",
      notes: "Substitute day"
    }
  ]
} %>

Accessibility acceptance criteria

Caption must contain a complete description of the data contained in the table

Other examples

Standard options

This component uses the component wrapper helper. It accepts the following options and applies them to the parent element of the component. See the component wrapper helper documentation for more detail.

• id - accepts a string for the element ID attribute
• data_attributes - accepts a hash of data attributes
• aria - accepts a hash of aria attributes
• classes - accepts a space separated string of classes, these should not be used for styling and must be prefixed with js-
• margin_bottom - accepts a number from 0 to 9 (0px to 60px) using the GOV.UK Frontend spacing scale
• role - accepts a space separated string of roles
• lang - accepts a language attribute value
• open - accepts an open attribute value (true or false)
• hidden - accepts an empty string, ‘hidden’, or ‘until-found’
• tabindex - accepts an integer. The integer can also be passed as a string
• dir - accepts ‘rtl’, ‘ltr’, or ‘auto’
• type - accepts any valid type attribute e.g. ‘button’, ‘submit’, ‘text’
• rel - accepts any valid rel attribute e.g. ‘nofollow’
• target - accepts a valid target attribute e.g. ‘_blank’
• title - accepts any string
• draggable - accepts a draggable attribute value (“true” or “false”)

With headings (preview)

2018

Date	Day of the week	Name
26 December	Wednesday	Boxing Day
2 January	Tuesday	New Year’s Day (substitute day)

<%= render "components/calendar", {
  caption: "Upcoming bank holidays in England and Wales",
  year: 2018,
  headings: [
    {
      text: "Date"
    },
    {
      text: "Day of the week"
    },
    {
      text: "Name"
    }
  ],
  events: [
    {
      title: "Boxing Day",
      date: "2018-12-26 00:00:00 +0000"
    },
    {
      title: "New Year’s Day",
      date: "2018-01-02 00:00:00 +0000",
      notes: "Substitute day"
    }
  ]
} %>