-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Options
LucileDT edited this page Jul 2, 2017
·
7 revisions
Option | Type | Description | Default value |
---|---|---|---|
day |
Date | The initial date for the calendar. Can be now or YYY-mm-dd format. |
'now' |
first_day |
Integer | First day of the week. 1 for monday. Otherwise, sunday is first day. |
2 |
view |
String | Initial view for the calendar. Can be 'year' , 'month' , 'week' or 'day'
|
'month' |
width |
String | Width of the calendar. | '100%' |
tooltip_container |
String | Tooltip container option from Bootstrap. For more information: Tooltips | 'body' |
weekbox |
Boolean | Enable the weekbox on month view. | true |
display_week_number |
Boolean | Enable the week number on weekbox. | true |
week_numbers_iso_8601 |
Boolean | Enable the ISO 8601 for week number. | false |
events_source |
Array or Function or String | Source of the calendar events. TODO: add link to Events page | null |
events_cache |
Boolean | Enable the event cache. Useful for example if the response do not depend of dates. | false |
Option | Type | Description | Default value |
---|---|---|---|
format12 |
Boolean | Set time format to 12 hours on views. | false |
am_suffix |
String | Set a suffix for AM hours if format12 is enabled. |
'AM' |
pm_suffix |
String | Set a suffix for PM hours if format12 is enabled. |
'PM' |
time_start |
String | Set the first time that is showed on week day. | '06:00' |
time_end |
String | Set the last time that is showed on day view. | '22:00' |
time_split |
Integer | Set the minutes split on day view. | 30 |
-
tmpl_path
: String. Path to the public templates. Should end with/
. Default:tmpls/
-
tmpl_cache
: Boolean. Enable or disable the templates cache. Default:true
-
views
: Array. Enables or disable diferents views. Default:
views: {
year: {
slide_events: 1,
enable: 1
},
month: {
slide_events: 1,
enable: 1
},
week: {
enable: 1
},
day: {
enable: 1
}
}
-
classes
: Array. Class attribute for diferent elements. Default:
classes: {
months: {
inmonth: 'cal-day-inmonth',
outmonth: 'cal-day-outmonth',
saturday: 'cal-day-weekend',
sunday: 'cal-day-weekend',
holidays: 'cal-day-holiday',
today: 'cal-day-today'
},
week: {
workday: 'cal-day-workday',
saturday: 'cal-day-weekend',
sunday: 'cal-day-weekend',
holidays: 'cal-day-holiday',
today: 'cal-day-today'
}
}
-
modal
: String or null. ID of the element of modal window. If set, events URLs will be opened in modal windows. Default:null
-
modal_type
: String. Modal handling type. Can beiframe
,ajax
ortemplate
. Default:'iframe'
-
modal_title
: Function. Function to set the modal title. Will be passed with event as a parameter. Default:null
-
merge_holidays
: Boolean. Enables or disable the holidays. Default:false
-
holidays
: Array. Set the different holidays. Defaults: depend of the language file
holidays: {
// January 1
'01-01': "New Year's Day",
// Third (+3*) Monday (1) in January (01)
'01+3*1': "Birthday of Dr. Martin Luther King, Jr.",
// Third (+3*) Monday (1) in February (02)
'02+3*1': "Washington's Birthday",
// Last (-1*) Monday (1) in May (05)
'05-1*1': "Memorial Day",
// July 4
'04-07': "Independence Day",
// First (+1*) Monday (1) in September (09)
'09+1*1': "Labor Day",
// Second (+2*) Monday (1) in October (10)
'10+2*1': "Columbus Day",
// November 11
'11-11': "Veterans Day",
// Fourth (+4*) Thursday (4) in November (11)
'11+4*4': "Thanksgiving Day",
// December 25
'25-12': "Christmas"
}