A calendar component. The calendar is run in controlled mode to allow for the today button to work.

Parameters:
NameTypeDescription
propsobject

Component props.

Properties
NameTypeDescription
calendarAttributesobject

Custom attributes for the calendar.

calendarClassesstring | Array | object

Custom classes for the calendar.

customAttributesobject

Custom attributes for the component.

customClassesstring | Array | object

Custom classes for the component.

onTodayClickfunction

The click event handler for the today button.

showTodayButtonboolean

Whether to show the today button or not.

spacingstring | number | Array | object

The spacing for the component, as a string, number, array, or object.

triggerActiveboolean

Whether the trigger is active or not.

triggerAttributesobject

Custom attributes for the trigger button.

triggerClassesstring | Array | object

Custom classes for the trigger button.

withTriggerboolean

Whether to show the trigger button or not.

Since
  • 4.4.0
Returns:

The Calendar component.

Type: 
object
Example
import Calendar from '@gravityforms/components/react/admin/modules/Calendar';

return <Calendar />;