edit doc


Defines custom buttons that can be used in the headerToolbar/footerToolbar.


Specify a hash of custom buttons. Then reference them from the headerToolbar setting. Like this:

var calendar = new Calendar(calendarEl, {
  customButtons: {
    myCustomButton: {
      text: 'custom!',
      click: function() {
        alert('clicked the custom button!');
  headerToolbar: {
    left: 'prev,next today myCustomButton',
    center: 'title',
    right: 'dayGridMonth,timeGridWeek,timeGridDay'

Each customButton entry accepts the following properties:

  • text - the text to be display on the button itself
  • click - a callback function that is called when the button is clicked. Accepts two arguments: ( mouseEvent, htmlElement ).
  • icon - see buttonIcons. optional
  • bootstrapFontAwesome - see bootstrapFontAwesome. optional

See a demo of customButtons.