diff --git a/docs/api/api_overview.md b/docs/api/api_overview.md index 855d4bd..d88a43d 100644 --- a/docs/api/api_overview.md +++ b/docs/api/api_overview.md @@ -10,7 +10,7 @@ description: You can explore an API overview in the documentation of the DHTMLX ~~~jsx {} new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); ~~~ diff --git a/docs/api/config/js_eventcalendar_calendars_config.md b/docs/api/config/js_eventcalendar_calendars_config.md index 2951137..c76ecc9 100644 --- a/docs/api/config/js_eventcalendar_calendars_config.md +++ b/docs/api/config/js_eventcalendar_calendars_config.md @@ -18,17 +18,17 @@ A **calendar** is a set of parameters you can apply to the events to group them ~~~jsx {} calendars?: [ - { - id: string | number, - label: string, - readonly: boolean, - active: boolean, - color?: { - background?: string, - border?: string, - textColor?: string - } - }, {...} + { + id: string | number, + label: string, + readonly: boolean, + active: boolean, + color?: { + background?: string, + border?: string, + textColor?: string + } + }, {...} ]; ~~~ @@ -41,9 +41,9 @@ For each **calendar** (*event type*) you can specify the following parameters (d - `active` - (required) shows/hides events of the current calendar - `readonly` - (optional) enables/disables an ability to edit and delete the current calendar - `color` - (optional) an object with the style parameters, applied to the events of current calendar. Here you can specify the following parameters (styles): - - `background` - (optional) a HEX code of the event background color related to the current calendar - - `border` - (optional) a HEX code of the event border color related to the current calendar - - `textColor` - (optional) a HEX code of the event text color related to the current calendar + - `background` - (optional) a HEX code of the event background color related to the current calendar + - `border` - (optional) a HEX code of the event border color related to the current calendar + - `textColor` - (optional) a HEX code of the event text color related to the current calendar ### Default config @@ -53,46 +53,46 @@ You can export the default config using the `eventCalendar.defaultCalendars` exp ~~~jsx {} const defaultCalendars = [ - { - id: "work", - label: "Work", - readonly: false, - active: true, - color: { - background: "#d5eaf7", - border: "#098CDC" - } - }, - { - id: "meeting", - label: "Meeting", - readonly: false, - active: true, - color: { - background: "#E6E5EC", - border: "#7A67EB" - } - }, - { - id: "rest", - label: "Rest", - readonly: false, - active: true, - color: { - background: "#EDD1EC", - border: "#AD44AB" - } - }, - { - id: "movie", - label: "Movie", - readonly: false, - active: true, - color: { - background: "#CEEDC3", - border: "#77D257" - } - } + { + id: "work", + label: "Work", + readonly: false, + active: true, + color: { + background: "#d5eaf7", + border: "#098CDC" + } + }, + { + id: "meeting", + label: "Meeting", + readonly: false, + active: true, + color: { + background: "#E6E5EC", + border: "#7A67EB" + } + }, + { + id: "rest", + label: "Rest", + readonly: false, + active: true, + color: { + background: "#EDD1EC", + border: "#AD44AB" + } + }, + { + id: "movie", + label: "Movie", + readonly: false, + active: true, + color: { + background: "#CEEDC3", + border: "#77D257" + } + } ]; ~~~ @@ -107,32 +107,32 @@ To set the **calendars** config dynamically, you can use the // custom calendars const calendars = [ { - id: "rest", - label: "Custom Rest", - readonly: true, - active: true, - color: { - background: "#EDD1EC", - border: "#AD44AB", + id: "rest", + label: "Custom Rest", + readonly: true, + active: true, + color: { + background: "#EDD1EC", + border: "#AD44AB", textColor: "#3e98db" - } - }, - { - id: "movie", - label: "Custom Movie", - readonly: false, - active: false, - color: { - background: "#CEEDC3", - border: "#77D257", + } + }, + { + id: "movie", + label: "Custom Movie", + readonly: false, + active: false, + color: { + background: "#CEEDC3", + border: "#77D257", textColor: "#3e98db" - } - } + } + } ]; // create Event Calendar new eventCalendar.EventCalendar("#root", { calendars - // other configuration parameters + // other configuration parameters }); ~~~ diff --git a/docs/api/config/js_eventcalendar_colors_config.md b/docs/api/config/js_eventcalendar_colors_config.md index dd13415..74d8269 100644 --- a/docs/api/config/js_eventcalendar_colors_config.md +++ b/docs/api/config/js_eventcalendar_colors_config.md @@ -95,7 +95,7 @@ new eventCalendar.EventCalendar("#root", { colorpicker: "border" } ], - // other configuration parameters + // other configuration parameters }); ~~~ diff --git a/docs/api/config/js_eventcalendar_config_config.md b/docs/api/config/js_eventcalendar_config_config.md index 1a96235..0b18c00 100644 --- a/docs/api/config/js_eventcalendar_config_config.md +++ b/docs/api/config/js_eventcalendar_config_config.md @@ -257,39 +257,39 @@ sections: [ ~~~jsx {} const defaultWeekConfig = { - eventHorizontalSpace: 3, - columnPadding: "8px", + eventHorizontalSpace: 3, + columnPadding: "8px", }; const defaultMonthConfig = { - maxEventsPerCell: 4, + maxEventsPerCell: 4, }; const defaultTimelineConfig = { - colsCount: 90, - minEventWidth: 50, - colsWidth: 90, - minSectionHeight: 100, - sectionWidth: 158, - step: [1, "day"], - key: "section", - header: [ - { unit: "month", step: 1, format: "MMM" }, - { unit: "day", step: 1, format: "d MMM" }, - ], - sections: [ - { id: "1", label: "Section 1" }, - { id: "2", label: "Section 2" }, - { id: "3", label: "Section 3" }, - { id: "4", label: "Section 4" }, - { id: "5", label: "Section 5" }, - { id: "6", label: "Section 6" }, - { id: "7", label: "Section 7" }, - { id: "8", label: "Section 8" }, - { id: "9", label: "Section 9" }, - ], - unassignedCol: false, + colsCount: 90, + minEventWidth: 50, + colsWidth: 90, + minSectionHeight: 100, + sectionWidth: 158, + step: [1, "day"], + key: "section", + header: [ + { unit: "month", step: 1, format: "MMM" }, + { unit: "day", step: 1, format: "d MMM" }, + ], + sections: [ + { id: "1", label: "Section 1" }, + { id: "2", label: "Section 2" }, + { id: "3", label: "Section 3" }, + { id: "4", label: "Section 4" }, + { id: "5", label: "Section 5" }, + { id: "6", label: "Section 6" }, + { id: "7", label: "Section 7" }, + { id: "8", label: "Section 8" }, + { id: "9", label: "Section 9" }, + ], + unassignedCol: false, }; const defaultConfig = { @@ -316,27 +316,27 @@ const defaultConfig = { viewControl: "auto", views: [ - { - id: "week", - label: "Week", - config: defaultWeekConfig, - layout: "week" - }, - { + { + id: "week", + label: "Week", + config: defaultWeekConfig, + layout: "week" + }, + { id: "day", label: "Day", config: defaultWeekConfig, layout: "day" }, - { - id: "month", - label: "Month", - config: defaultMonthConfig, - layout: "month" - }, - { id: "year", label: "Year", layout: "year" }, - { id: "agenda", label: "Agenda", layout: "agenda" }, - ], + { + id: "month", + label: "Month", + config: defaultMonthConfig, + layout: "month" + }, + { id: "year", label: "Year", layout: "year" }, + { id: "agenda", label: "Agenda", layout: "agenda" }, + ], }; ~~~ @@ -360,29 +360,29 @@ new eventCalendar.EventCalendar("#root", { eventVerticalSpace: 8, dateTitle: (date, [start, end]) => `${format(start, "do")} - ${format(end, "do")} ${format(date, "LLL")}`, views: [ - { - id: "timeline", - label: "Timeline", - layout: "timeline", - config: { - unassignedCol: true, - sections: [ - { - label: "Andy Warh", - id: "1", - img: "../src/data/common/img/01/avatar_01.jpg", - }, - { - label: "Nataly Tamer", - id: "2", - img: "../src/data/common/img/02/avatar_02.jpg", - }, - // other sections config - ], - }, - }, + { + id: "timeline", + label: "Timeline", + layout: "timeline", + config: { + unassignedCol: true, + sections: [ + { + label: "Andy Warh", + id: "1", + img: "../src/data/common/img/01/avatar_01.jpg", + }, + { + label: "Nataly Tamer", + id: "2", + img: "../src/data/common/img/02/avatar_02.jpg", + }, + // other sections config + ], + }, + }, // other custom views config - ], + ], }, // other configuration parameters }); diff --git a/docs/api/config/js_eventcalendar_editorshape_config.md b/docs/api/config/js_eventcalendar_editorshape_config.md index 1dd3fe2..801fc1d 100644 --- a/docs/api/config/js_eventcalendar_editorshape_config.md +++ b/docs/api/config/js_eventcalendar_editorshape_config.md @@ -14,76 +14,76 @@ description: You can learn about the editorShape config in the documentation of ~~~jsx {3,8,18,32,41,57,60,63} editorShape?: [ - { - // common settings - type: string, - key: string, - label?: string, - - // for "text" and "textarea" types - config?: { - readonly?: boolean, - focus?: boolean, - disabled?: boolean, - placeholder?: string, - type?: string, - inputStyle?: string - }, - - // for "combo" and "multiselect" types only - template?: (option) => string, - options?: [ - { - id: any, - label: string, - }, - {...} // other options - ], - config?: { - placeholder?: string, - disabled?: boolean - }, - - // for a "radio" type only - options?: [ - { - id: any, - label?: string, - }, - {...} // other options - ], - - // for "color" and "colorSchema" types - colors?: [], // for a "color" type only - colors?: [ // for a "colorSchema" type only - { - background?: string, - border?: string, - textColor? string, - colorpicker? string - }, - {...} - ], - config?: { - placeholder?: string, - clear?: boolean - }, - - // for a "checkbox" type only - text?: string, - - // for a "date" type only - time?: boolean, - - // for a "files" type only - uploadURL?: string, - config?: { - accept?: string, - disabled?: boolean, - multiple?: boolean, - folder?: boolean - } - }, {...} + { + // common settings + type: string, + key: string, + label?: string, + + // for "text" and "textarea" types + config?: { + readonly?: boolean, + focus?: boolean, + disabled?: boolean, + placeholder?: string, + type?: string, + inputStyle?: string + }, + + // for "combo" and "multiselect" types only + template?: (option) => string, + options?: [ + { + id: any, + label: string, + }, + {...} // other options + ], + config?: { + placeholder?: string, + disabled?: boolean + }, + + // for a "radio" type only + options?: [ + { + id: any, + label?: string, + }, + {...} // other options + ], + + // for "color" and "colorSchema" types + colors?: [], // for a "color" type only + colors?: [ // for a "colorSchema" type only + { + background?: string, + border?: string, + textColor? string, + colorpicker? string + }, + {...} + ], + config?: { + placeholder?: string, + clear?: boolean + }, + + // for a "checkbox" type only + text?: string, + + // for a "date" type only + time?: boolean, + + // for a "files" type only + uploadURL?: string, + config?: { + accept?: string, + disabled?: boolean, + multiple?: boolean, + folder?: boolean + } + }, {...} ]; ~~~ @@ -104,27 +104,27 @@ The **recurring** type of editor doesn't require a key to bind to events! ~~~js {4-5,12,20} // event data const events = [ - { - text: "Current event", - start_date: new Date("2021-05-24T00:00:00") - }, {...} + { + text: "Current event", + start_date: new Date("2021-05-24T00:00:00") + }, {...} ]; // editor settings const editorShape = [ - { - type: "text", - key: "text", - label: "Event name", - config: { - placeholder: "New event" - } - }, - { - type: "date", - key: "start_date", - label: "Start date", - time: true - } + { + type: "text", + key: "text", + label: "Event name", + config: { + placeholder: "New event" + } + }, + { + type: "date", + key: "start_date", + label: "Start date", + time: true + } ]; ~~~ @@ -133,28 +133,28 @@ const editorShape = [ #### - Parameters for "text" and "textarea" types - `config` - (optional) a configuration object of the **"text"** and **"textarea"** fields. Here you can specify the following parameters: - - `readonly` - (optional) enables/disables a readonly mode - - `focus` - (optional) enables/disables a focus - - `disabled` - (optional) enables/disables a field state - - `placeholder` - (optional) a placeholder value - - `type` - (optional) a type of the input field (only for **text** type). Here you can specify only the **password**, **number**, and **text** values) - - `inputStyle` - (optional) a custom css style + - `readonly` - (optional) enables/disables a readonly mode + - `focus` - (optional) enables/disables a focus + - `disabled` - (optional) enables/disables a field state + - `placeholder` - (optional) a placeholder value + - `type` - (optional) a type of the input field (only for **text** type). Here you can specify only the **password**, **number**, and **text** values) + - `inputStyle` - (optional) a custom css style #### - Parameters for "combo" and "multiselect" types - `template` - (optional) a function that needs to return a custom template of the drop-down options - `options` - (optional) an array of objects containing the dropdown options data. Here you can specify the following parameters: - - `id` - (required) an option **ID** - - `label` - (required) an option label + - `id` - (required) an option **ID** + - `label` - (required) an option label - `config` - (optional) a configuration object of the **"combo"** field. Here you can specify the following parameters: - - `placeholder` - (optional) a placeholder value - - `disabled` - (optional) enables/disables a field state + - `placeholder` - (optional) a placeholder value + - `disabled` - (optional) enables/disables a field state #### - Parameters for a "radio" type - `options` - (optional) an array of objects containing the radio button data. Here you can specify the following parameters: - - `value` - (required) a radio button value - - `label` - (optional) an option label + - `value` - (required) a radio button value + - `label` - (optional) an option label #### - Parameters for "color" and "colorSchema" types @@ -166,15 +166,15 @@ For a **color** type only :::note For a **colorSchema** type only. Unless you specify *colors* for the **colorSchema** type, the colorpicker will use a set of parameters specified via the [`colors`](../js_eventcalendar_colors_config) property - `colors` - (optional) an array of objects containing the parameters of colors used in colorpicker. For each set of colors you can specify the following parameters: - - `background` - (optional) a HEX code of the event background color - - `border` - (optional) a HEX code of the event border color - - `textColor` - (optional) a HEX code of the event text color - - `colorpicker` - (optional) a value (color) used in colorpicker. The possible values are *"background"* and *"border"* + - `background` - (optional) a HEX code of the event background color + - `border` - (optional) a HEX code of the event border color + - `textColor` - (optional) a HEX code of the event text color + - `colorpicker` - (optional) a value (color) used in colorpicker. The possible values are *"background"* and *"border"* ::: - `config` - (optional) a configuration object of the **"color"** and **"colorSchema"** fields. Here you can specify the following parameters: - - `placeholder` - (optional) a placeholder value - - `clear` - (optional) shows/hides a "clear" icon + - `placeholder` - (optional) a placeholder value + - `clear` - (optional) shows/hides a "clear" icon #### - Parameters for a "checkbox" type @@ -188,10 +188,10 @@ For a **colorSchema** type only. Unless you specify *colors* for the **colorSche - `uploadURL` - (optional) an URL of the editor uploader - `config` - (optional) a configuration object of the **"files"** field. Here you can specify the following parameters: - - `accept` - (optional) a file type to be uploaded (***"image/\*", "video/\*", "audio/\*"*** *and other*) - - `disabled` - (optional) enables/disables uploading *files* - - `multiple` - (optional) enables/disables uploading *multiple files* - - `folder` - (optional) enables/disables uploading *folders* + - `accept` - (optional) a file type to be uploaded (***"image/\*", "video/\*", "audio/\*"*** *and other*) + - `disabled` - (optional) enables/disables uploading *files* + - `multiple` - (optional) enables/disables uploading *multiple files* + - `folder` - (optional) enables/disables uploading *folders* :::info Unless you specify the editor settings via the **editorShape** property, the widget will apply the **defaultEditorShape** set of parameters! @@ -205,48 +205,48 @@ You can export the default config using the `eventCalendar.defaultEditorShape` e ~~~jsx {} const defaultEditorShape = [ - { - key: "text", - type: "text", - label: "Event name", - config: { - placeholder: "New Event" - } - }, - { - type: "date", - key: "start_date", - label: "Start date", - time: true - }, - { - type: "date", - key: "end_date", - label: "End date", - time: true - }, - { - type: "checkbox", - key: "allDay", - text: "All day" - }, - { - type: "combo", - key: "type", - label: "Type" - }, - { - key: "details", - type: "textarea", - label: "Description", - config: { - placeholder: "Add description" - } - }, - { - type: "recurring", - label: "Repeat event" - } + { + key: "text", + type: "text", + label: "Event name", + config: { + placeholder: "New Event" + } + }, + { + type: "date", + key: "start_date", + label: "Start date", + time: true + }, + { + type: "date", + key: "end_date", + label: "End date", + time: true + }, + { + type: "checkbox", + key: "allDay", + text: "All day" + }, + { + type: "combo", + key: "type", + label: "Type" + }, + { + key: "details", + type: "textarea", + label: "Description", + config: { + placeholder: "Add description" + } + }, + { + type: "recurring", + label: "Repeat event" + } ]; ~~~ @@ -266,18 +266,18 @@ const priorities = [ ]; // editor settings const editorShape = [ - ...eventCalendar.defaultEditorShape, // include the default settings - { // add custom radio field - type: "radio", - key: "priority", - label: "Priority", - options: priorities - } + ...eventCalendar.defaultEditorShape, // include the default settings + { // add custom radio field + type: "radio", + key: "priority", + label: "Priority", + options: priorities + } ]; // create Event Calendar new eventCalendar.EventCalendar("#root", { - editorShape - // other configuration parameters + editorShape + // other configuration parameters }); ~~~ diff --git a/docs/api/config/js_eventcalendar_editorvalidation_config.md b/docs/api/config/js_eventcalendar_editorvalidation_config.md index 143b348..971892a 100644 --- a/docs/api/config/js_eventcalendar_editorvalidation_config.md +++ b/docs/api/config/js_eventcalendar_editorvalidation_config.md @@ -30,7 +30,7 @@ new eventCalendar.EventCalendar("#root", { editorValidation: event => { if (!event.text) return "Text is required"; } - // other configuration parameters + // other configuration parameters }); ~~~ diff --git a/docs/api/config/js_eventcalendar_events_config.md b/docs/api/config/js_eventcalendar_events_config.md index 1f01ed9..a07e520 100644 --- a/docs/api/config/js_eventcalendar_events_config.md +++ b/docs/api/config/js_eventcalendar_events_config.md @@ -113,7 +113,7 @@ new eventCalendar.EventCalendar("#root", { }, // other events data ] - // other configuration parameters + // other configuration parameters }); ~~~ diff --git a/docs/api/config/js_eventcalendar_locale_config.md b/docs/api/config/js_eventcalendar_locale_config.md index edf9313..ed540ba 100644 --- a/docs/api/config/js_eventcalendar_locale_config.md +++ b/docs/api/config/js_eventcalendar_locale_config.md @@ -33,8 +33,8 @@ To change the current locale dynamically, you can use the [`setLocale()`](../../ ~~~jsx {3} // create Event Calendar new eventCalendar.EventCalendar("#root", { - locale: eventСalendar.de // apply the "de" locale - // other configuration parameters + locale: eventСalendar.de // apply the "de" locale + // other configuration parameters }); ~~~ diff --git a/docs/api/config/js_eventcalendar_mode_config.md b/docs/api/config/js_eventcalendar_mode_config.md index 88e0a00..fe885e1 100644 --- a/docs/api/config/js_eventcalendar_mode_config.md +++ b/docs/api/config/js_eventcalendar_mode_config.md @@ -40,7 +40,7 @@ To set the view mode dynamically, you can use the // create Event Calendar new eventCalendar.EventCalendar("#root", { mode: "timeline" - // other configuration parameters + // other configuration parameters }); ~~~ diff --git a/docs/api/config/js_eventcalendar_templates_config.md b/docs/api/config/js_eventcalendar_templates_config.md index 4198f0e..1028e59 100644 --- a/docs/api/config/js_eventcalendar_templates_config.md +++ b/docs/api/config/js_eventcalendar_templates_config.md @@ -74,7 +74,7 @@ new eventCalendar.EventCalendar("#root", { // create Event Calendar return `
${event.text}
-
${start_date} - ${end_date}
+
${start_date} - ${end_date}
${event.img ? `` : ""}
`; }, @@ -161,7 +161,7 @@ new eventCalendar.EventCalendar("#root", { // create Event Calendar `; } }, - // other configuration parameters + // other configuration parameters }); ~~~ diff --git a/docs/api/config/js_eventcalendar_theme_config.md b/docs/api/config/js_eventcalendar_theme_config.md index 42993ca..48bcc0b 100644 --- a/docs/api/config/js_eventcalendar_theme_config.md +++ b/docs/api/config/js_eventcalendar_theme_config.md @@ -37,7 +37,7 @@ To set a theme dynamically, you can use the new eventCalendar.EventCalendar("#root", { events, theme: "willowDark" - // other configuration parameters + // other configuration parameters }); ~~~ diff --git a/docs/api/events/js_eventcalendar_addcalendar_event.md b/docs/api/events/js_eventcalendar_addcalendar_event.md index e41d642..9ce20ca 100644 --- a/docs/api/events/js_eventcalendar_addcalendar_event.md +++ b/docs/api/events/js_eventcalendar_addcalendar_event.md @@ -31,10 +31,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "add-calendar" event calendar.api.on("add-calendar", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_addevent_event.md b/docs/api/events/js_eventcalendar_addevent_event.md index 2c1b865..2aad430 100644 --- a/docs/api/events/js_eventcalendar_addevent_event.md +++ b/docs/api/events/js_eventcalendar_addevent_event.md @@ -31,10 +31,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "add-event" event calendar.api.on("add-event", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_closeeventinfo_event.md b/docs/api/events/js_eventcalendar_closeeventinfo_event.md index 69228b4..9503aca 100644 --- a/docs/api/events/js_eventcalendar_closeeventinfo_event.md +++ b/docs/api/events/js_eventcalendar_closeeventinfo_event.md @@ -29,10 +29,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "close-event-info" event calendar.api.on("close-event-info", () => { - console.log("The event info popup is closed!"); + console.log("The event info popup is closed!"); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_deletecalendar_event.md b/docs/api/events/js_eventcalendar_deletecalendar_event.md index 0fd4a2a..e58a682 100644 --- a/docs/api/events/js_eventcalendar_deletecalendar_event.md +++ b/docs/api/events/js_eventcalendar_deletecalendar_event.md @@ -31,10 +31,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "delete-calendar" event calendar.api.on("delete-calendar", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_deleteevent_event.md b/docs/api/events/js_eventcalendar_deleteevent_event.md index ed62383..00eb5fa 100644 --- a/docs/api/events/js_eventcalendar_deleteevent_event.md +++ b/docs/api/events/js_eventcalendar_deleteevent_event.md @@ -31,10 +31,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "delete-event" event calendar.api.on("delete-event", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_editevent_event.md b/docs/api/events/js_eventcalendar_editevent_event.md index c54e822..91170dd 100644 --- a/docs/api/events/js_eventcalendar_editevent_event.md +++ b/docs/api/events/js_eventcalendar_editevent_event.md @@ -14,8 +14,8 @@ description: You can learn about the edit-event event in the documentation of th ~~~jsx {} "edit-event": ({ - id?: string | number, - add?: boolean | object + id?: string | number, + add?: boolean | object }) => void; ~~~ @@ -25,8 +25,8 @@ The callback of the **edit-event** event can take an object with the following p - `id` - (optional) an ID of the event to be edited - `add` - (optional) an ability to add new event. This parameter takes one of 2 available options: - - **true** / **false** - enables/disables an ability to add new event - - **object** - an object of new event + - **true** / **false** - enables/disables an ability to add new event + - **object** - an object of new event Depending on the passed parameters, you can perform the following operations: @@ -35,7 +35,7 @@ Depending on the passed parameters, you can perform the following operations: ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // open the editor for the event with the "1" ID calendar.api.exec("edit-event", { id: "1" }); @@ -49,14 +49,14 @@ calendar.api.exec("edit-event", { add: true }); // open the editor for the new event with the initial data calendar.api.exec("edit-event", { - add: { - id: "44", - type: "meeting", - start_date: new Date("2023-09-16T15:00:00"), - end_date: new Date("2023-09-16T16:00:00"), - text: "Custom event", - details: "Rome, Italy", - } + add: { + id: "44", + type: "meeting", + start_date: new Date("2023-09-16T15:00:00"), + end_date: new Date("2023-09-16T16:00:00"), + text: "Custom event", + details: "Rome, Italy", + } }); ~~~ @@ -76,11 +76,11 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {7-9} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "edit-event" event calendar.api.on("edit-event", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_selectevent_event.md b/docs/api/events/js_eventcalendar_selectevent_event.md index 4bf28e6..e0fd394 100644 --- a/docs/api/events/js_eventcalendar_selectevent_event.md +++ b/docs/api/events/js_eventcalendar_selectevent_event.md @@ -14,8 +14,8 @@ description: You can learn about the select-event event in the documentation of ~~~jsx {} "select-event": ({ - id: string | number, - popup?: boolean + id: string | number, + popup?: boolean }) => void; ~~~ @@ -35,10 +35,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "select-event" event calendar.api.on("select-event", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_setbound_event.md b/docs/api/events/js_eventcalendar_setbound_event.md index fb410f8..6ead540 100644 --- a/docs/api/events/js_eventcalendar_setbound_event.md +++ b/docs/api/events/js_eventcalendar_setbound_event.md @@ -31,10 +31,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "set-bound" event calendar.api.on("set-bound", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_setdate_event.md b/docs/api/events/js_eventcalendar_setdate_event.md index b525774..689ce5d 100644 --- a/docs/api/events/js_eventcalendar_setdate_event.md +++ b/docs/api/events/js_eventcalendar_setdate_event.md @@ -31,10 +31,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "set-date" event calendar.api.on("set-date", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_setmode_event.md b/docs/api/events/js_eventcalendar_setmode_event.md index 82521a6..15abf10 100644 --- a/docs/api/events/js_eventcalendar_setmode_event.md +++ b/docs/api/events/js_eventcalendar_setmode_event.md @@ -31,10 +31,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "set-mode" event calendar.api.on("set-mode", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_togglesidebar_event.md b/docs/api/events/js_eventcalendar_togglesidebar_event.md index be49650..6a37888 100644 --- a/docs/api/events/js_eventcalendar_togglesidebar_event.md +++ b/docs/api/events/js_eventcalendar_togglesidebar_event.md @@ -31,10 +31,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "toggle-sidebar" event calendar.api.on("toggle-sidebar", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_updatecalendar_event.md b/docs/api/events/js_eventcalendar_updatecalendar_event.md index 3b16c8e..ecd591c 100644 --- a/docs/api/events/js_eventcalendar_updatecalendar_event.md +++ b/docs/api/events/js_eventcalendar_updatecalendar_event.md @@ -14,8 +14,8 @@ description: You can learn about the update-calendar event in the documentation ~~~jsx {} "update-calendar": ({ - calendar: object, - id: string | number + calendar: object, + id: string | number }) => void; ~~~ @@ -35,10 +35,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "update-calendar" event calendar.api.on("update-calendar", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/events/js_eventcalendar_updateevent_event.md b/docs/api/events/js_eventcalendar_updateevent_event.md index a24e546..296f4da 100644 --- a/docs/api/events/js_eventcalendar_updateevent_event.md +++ b/docs/api/events/js_eventcalendar_updateevent_event.md @@ -14,8 +14,8 @@ description: You can learn about the update-event event in the documentation of ~~~jsx {} "update-event": ({ - event: object, - id: string | number + event: object, + id: string | number }) => void; ~~~ @@ -35,10 +35,10 @@ For handling the inner events of Event Calendar you can use the [**Event Bus met ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // subscribe on the "update-event" event calendar.api.on("update-event", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/internal/js_eventcalendar_exec_method.md b/docs/api/internal/js_eventcalendar_exec_method.md index 2932e8b..3b33b8e 100644 --- a/docs/api/internal/js_eventcalendar_exec_method.md +++ b/docs/api/internal/js_eventcalendar_exec_method.md @@ -14,8 +14,8 @@ description: You can learn about the exec method in the documentation of the DHT ~~~jsx {} api.exec( - event: string, - config: object + event: string, + config: object ): void; ~~~ @@ -35,7 +35,7 @@ The full list of the Event Calendar internal events can be found [**here**](api/ ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration properties + // configuration properties }); // set "day" mode calendar.api.exec("set-mode", { mode: "day" }); diff --git a/docs/api/internal/js_eventcalendar_getreactivestate_method.md b/docs/api/internal/js_eventcalendar_getreactivestate_method.md index 4b7373f..5008682 100644 --- a/docs/api/internal/js_eventcalendar_getreactivestate_method.md +++ b/docs/api/internal/js_eventcalendar_getreactivestate_method.md @@ -22,22 +22,22 @@ The method returns an object with the following properties: ~~~jsx {} { - bounds: object, - calendars: object, - colors: object, - config: object, - date: object, - datepicker: object, - dateRange: object, - edit: object, - editorShape: object, - events: object, - mode: object, - popupInfo: object, - selected: object, - sidebar: object, - viewData: object, - viewModel: object + bounds: object, + calendars: object, + colors: object, + config: object, + date: object, + datepicker: object, + dateRange: object, + edit: object, + editorShape: object, + events: object, + mode: object, + popupInfo: object, + selected: object, + sidebar: object, + viewData: object, + viewModel: object } ~~~ @@ -46,7 +46,7 @@ The method returns an object with the following properties: ~~~jsx {6-44} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration properties + // configuration properties }); // get reactive state @@ -54,28 +54,28 @@ const state = calendar.api.getReactiveState(); // subscribe on the calendars changes and output the calendars data state.calendars.subscribe((data) => { - console.log(data); + console.log(data); }); // subscribe on the events changes and output the events data state.events.subscribe((data) => { - console.log(data); + console.log(data); }); // subscribe on the event selection and output the data of the selected event state.selected.subscribe((data) => { - console.log(data); - // other actions + console.log(data); + // other actions }); // subscribe on the date changes and output the selected date state.date.subscribe((date) => { - console.log(date); + console.log(date); }); // subscribe on the modes changes and output the selected mode state.mode.subscribe((mode) => { - console.log(mode); + console.log(mode); }); // set new mode @@ -83,8 +83,8 @@ state.mode.set("day"); // update mode state.mode.update((mode) => { - if(mode === "day"){ - return "week"; - } + if(mode === "day"){ + return "week"; + } }); ~~~ diff --git a/docs/api/internal/js_eventcalendar_getstate_method.md b/docs/api/internal/js_eventcalendar_getstate_method.md index c3228f3..5d55984 100644 --- a/docs/api/internal/js_eventcalendar_getstate_method.md +++ b/docs/api/internal/js_eventcalendar_getstate_method.md @@ -22,20 +22,20 @@ The **getState()** method returns an object with the following properties: ~~~jsx {} { - bounds: array, - config: object, - events: array, - date: Date, - dateRange: array, - datepicker: object, - edit: boolean, - editorShape: array, - calendars: array, - mode: string, - popupInfo: object, - selected: string, - viewData: array, - viewModel: object + bounds: array, + config: object, + events: array, + date: Date, + dateRange: array, + datepicker: object, + edit: boolean, + editorShape: array, + calendars: array, + mode: string, + popupInfo: object, + selected: string, + viewData: array, + viewModel: object } ~~~ @@ -44,7 +44,7 @@ The **getState()** method returns an object with the following properties: ~~~jsx {5-13} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // get the state of Event Calendar const state = calendar.api.getState(); diff --git a/docs/api/internal/js_eventcalendar_getstores_method.md b/docs/api/internal/js_eventcalendar_getstores_method.md index becde47..892751b 100644 --- a/docs/api/internal/js_eventcalendar_getstores_method.md +++ b/docs/api/internal/js_eventcalendar_getstores_method.md @@ -22,7 +22,7 @@ The method returns an object with **DataStore**: ~~~jsx {} { - state: DataStore // ( object ) + state: DataStore // ( object ) } ~~~ @@ -31,7 +31,7 @@ The method returns an object with **DataStore**: ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration properties + // configuration properties }); // get the DataStore object of Event Calendar const stores = calendar.api.getStores(); diff --git a/docs/api/internal/js_eventcalendar_intercept_method.md b/docs/api/internal/js_eventcalendar_intercept_method.md index 2c7dc02..c0c26bb 100644 --- a/docs/api/internal/js_eventcalendar_intercept_method.md +++ b/docs/api/internal/js_eventcalendar_intercept_method.md @@ -14,8 +14,8 @@ description: You can learn about the intercept method in the documentation of th ~~~jsx {} api.intercept( - event: string, - callback: function + event: string, + callback: function ): void; ~~~ @@ -35,13 +35,13 @@ The full list of the Event Calendar internal events can be found [**here**](api/ ~~~jsx {6-11} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration properties + // configuration properties }); // prevent the "select-event" inner event calendar.api.intercept("select-event", (obj) => { - if(obj.id == 1){ - console.log("ID is " + obj.id); - return false; - } + if(obj.id == 1){ + console.log("ID is " + obj.id); + return false; + } }); ~~~ diff --git a/docs/api/internal/js_eventcalendar_on_method.md b/docs/api/internal/js_eventcalendar_on_method.md index 1f97c80..26d1bfc 100644 --- a/docs/api/internal/js_eventcalendar_on_method.md +++ b/docs/api/internal/js_eventcalendar_on_method.md @@ -14,8 +14,8 @@ description: You can learn about the on method in the documentation of the DHTML ~~~jsx {} api.on( - event: string, - handler: function + event: string, + handler: function ): void; ~~~ @@ -35,10 +35,10 @@ The full list of the Event Calendar internal events can be found [**here**](api/ ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration properties + // configuration properties }); // output the event data in console when its deleting calendar.api.on("delete-event", (obj) => { - console.log(obj); + console.log(obj); }); ~~~ diff --git a/docs/api/internal/js_eventcalendar_setnext_method.md b/docs/api/internal/js_eventcalendar_setnext_method.md index bbe073c..9a9dd18 100644 --- a/docs/api/internal/js_eventcalendar_setnext_method.md +++ b/docs/api/internal/js_eventcalendar_setnext_method.md @@ -27,14 +27,14 @@ const url = "https://some_backend_url"; const restProvider = new eventCalendar.RestDataProvider(url); Promise.all([ - restProvider.getEvents(), - restProvider.getCalendars() + restProvider.getEvents(), + restProvider.getCalendars() ]).then(([events, calendars]) => { - const calendar = new eventCalendar.EventCalendar("#root", { - events, - calendars - }); - calendar.api.setNext(restProvider); + const calendar = new eventCalendar.EventCalendar("#root", { + events, + calendars + }); + calendar.api.setNext(restProvider); }); ~~~ diff --git a/docs/api/methods/js_eventcalendar_addcalendar_method.md b/docs/api/methods/js_eventcalendar_addcalendar_method.md index ff3ee4e..e702059 100644 --- a/docs/api/methods/js_eventcalendar_addcalendar_method.md +++ b/docs/api/methods/js_eventcalendar_addcalendar_method.md @@ -29,17 +29,17 @@ The full list of the **calendar** parameters can be found [**here**](api/config/ ~~~jsx {6-14,16} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // calendar data const new_calendar_data = { - id: "new_calendar", - active: true, - label: "New calendar", - color: { - background: "#d5eaf7", - border: "#098CDC" - } + id: "new_calendar", + active: true, + label: "New calendar", + color: { + background: "#d5eaf7", + border: "#098CDC" + } }; // add new calendar calendar.addCalendar({ calendar: new_calendar_data }); diff --git a/docs/api/methods/js_eventcalendar_addevent_method.md b/docs/api/methods/js_eventcalendar_addevent_method.md index 87ecc19..6555fce 100644 --- a/docs/api/methods/js_eventcalendar_addevent_method.md +++ b/docs/api/methods/js_eventcalendar_addevent_method.md @@ -29,16 +29,16 @@ The full list of the **event** parameters can be found [**here**](api/config/js_ ~~~jsx {15} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // event data const new_event_data = { - id: "1.1", - type: "Work", - start_date: new Date("2021-05-24 00:00:00"), - end_date: new Date("2021-06-08 00:00:00"), - text: "New Event", - details: "Philippe-Chatrier Court\n Paris, FRA" + id: "1.1", + type: "Work", + start_date: new Date("2021-05-24 00:00:00"), + end_date: new Date("2021-06-08 00:00:00"), + text: "New Event", + details: "Philippe-Chatrier Court\n Paris, FRA" }; // add new event calendar.addEvent({ event: new_event_data }); diff --git a/docs/api/methods/js_eventcalendar_closeeditor_method.md b/docs/api/methods/js_eventcalendar_closeeditor_method.md index 4a9e33e..d5679ba 100644 --- a/docs/api/methods/js_eventcalendar_closeeditor_method.md +++ b/docs/api/methods/js_eventcalendar_closeeditor_method.md @@ -21,7 +21,7 @@ closeEditor(): void; ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // close an editor calendar.closeEditor(); diff --git a/docs/api/methods/js_eventcalendar_createevent_method.md b/docs/api/methods/js_eventcalendar_createevent_method.md index 87670a7..71c056e 100644 --- a/docs/api/methods/js_eventcalendar_createevent_method.md +++ b/docs/api/methods/js_eventcalendar_createevent_method.md @@ -29,17 +29,17 @@ The full list of the **event** parameters can be found [**here**](api/config/js_ ~~~jsx {6-15} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // create new event calendar.createEvent({ event: { - id: "44", - type: "meeting", - start_date: new Date("2023-09-16T15:00:00"), - end_date: new Date("2023-09-16T16:00:00"), - text: "Custom event", - details: "Rome, Italy", + id: "44", + type: "meeting", + start_date: new Date("2023-09-16T15:00:00"), + end_date: new Date("2023-09-16T16:00:00"), + text: "Custom event", + details: "Rome, Italy", } }); ~~~ diff --git a/docs/api/methods/js_eventcalendar_deletecalendar_method.md b/docs/api/methods/js_eventcalendar_deletecalendar_method.md index 5553e93..ab9a2ac 100644 --- a/docs/api/methods/js_eventcalendar_deletecalendar_method.md +++ b/docs/api/methods/js_eventcalendar_deletecalendar_method.md @@ -25,10 +25,10 @@ deleteCalendar({ id: string | number }): void; ~~~jsx {6-8} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // delete calendar with the "work" ID calendar.deleteCalendar({ - id: "work" + id: "work" }); ~~~ diff --git a/docs/api/methods/js_eventcalendar_deleteevent_method.md b/docs/api/methods/js_eventcalendar_deleteevent_method.md index f7fcf11..7b5746b 100644 --- a/docs/api/methods/js_eventcalendar_deleteevent_method.md +++ b/docs/api/methods/js_eventcalendar_deleteevent_method.md @@ -25,7 +25,7 @@ deleteEvent({ id: string | number }): void; ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // delete an event with the "1" ID calendar.deleteEvent({ id: "1" }); diff --git a/docs/api/methods/js_eventcalendar_destructor_method.md b/docs/api/methods/js_eventcalendar_destructor_method.md index 4aec850..88eb58d 100644 --- a/docs/api/methods/js_eventcalendar_destructor_method.md +++ b/docs/api/methods/js_eventcalendar_destructor_method.md @@ -21,7 +21,7 @@ destructor(): void; ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - //configuration parameters + //configuration parameters }); // delete Event Calendar calendar.destructor(); diff --git a/docs/api/methods/js_eventcalendar_getcalendar_method.md b/docs/api/methods/js_eventcalendar_getcalendar_method.md index 0ff6c6b..cbc845a 100644 --- a/docs/api/methods/js_eventcalendar_getcalendar_method.md +++ b/docs/api/methods/js_eventcalendar_getcalendar_method.md @@ -31,7 +31,7 @@ The `getCalendar()` method returns an object of the calendar data by the specifi ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // get a calendar data with the "work" ID const calendar_data = calendar.getCalendar({ id: "work" }); diff --git a/docs/api/methods/js_eventcalendar_getevent_method.md b/docs/api/methods/js_eventcalendar_getevent_method.md index 5655a71..69c3953 100644 --- a/docs/api/methods/js_eventcalendar_getevent_method.md +++ b/docs/api/methods/js_eventcalendar_getevent_method.md @@ -31,7 +31,7 @@ The `getEvent()` method returns an object of the event data by the specified ID. ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // get an event data with the "1" ID const event_data = calendar.getEvent({ id: "1" }); diff --git a/docs/api/methods/js_eventcalendar_hideeventinfo_method.md b/docs/api/methods/js_eventcalendar_hideeventinfo_method.md index ec65b65..97b1a81 100644 --- a/docs/api/methods/js_eventcalendar_hideeventinfo_method.md +++ b/docs/api/methods/js_eventcalendar_hideeventinfo_method.md @@ -21,7 +21,7 @@ hideEventInfo(): void; ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // hide an info popup calendar.hideEventInfo(); diff --git a/docs/api/methods/js_eventcalendar_openeditor_method.md b/docs/api/methods/js_eventcalendar_openeditor_method.md index 366c709..0f5e18f 100644 --- a/docs/api/methods/js_eventcalendar_openeditor_method.md +++ b/docs/api/methods/js_eventcalendar_openeditor_method.md @@ -25,7 +25,7 @@ openEditor({ id: string | number }): void; ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // open editor for the event with the "1" ID calendar.openEditor({ id: 1 }); diff --git a/docs/api/methods/js_eventcalendar_parse_method.md b/docs/api/methods/js_eventcalendar_parse_method.md index 6c068aa..d9b2a65 100644 --- a/docs/api/methods/js_eventcalendar_parse_method.md +++ b/docs/api/methods/js_eventcalendar_parse_method.md @@ -25,8 +25,8 @@ To load data for **events** only, pass the following parameter: To load data for **events** and **calendars**, pass the following parameters: - `data` - (required) an object of the events and calendars data: - - `events` - an array of objects of the events data - - `calendars` - an array of objects of the calendars data + - `events` - an array of objects of the events data + - `calendars` - an array of objects of the calendars data :::info For details, see the [`events`](../../config/js_eventcalendar_events_config) and [`calendars`](../../config/js_eventcalendar_calendars_config) properties of Event Calendar @@ -37,26 +37,26 @@ For details, see the [`events`](../../config/js_eventcalendar_events_config) and ~~~jsx {6-23,25-48,50} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // events data const events = [ - { - id: "1", - type: "work", - start_date: new Date("2021-05-24T00:00:00"), - end_date: new Date("2021-06-08T00:00:00"), - text: "French Open", - details: "Philippe-Chatrier Court\n Paris, FRA", - }, - { - id: "2", - type: "work", - start_date: new Date("2021-06-07T00:00:00"), - end_date: new Date("2021-06-13T00:00:00"), - text: "French Open", - details: "Philippe-Chatrier Court\n Paris, FRA", - }, ... + { + id: "1", + type: "work", + start_date: new Date("2021-05-24T00:00:00"), + end_date: new Date("2021-06-08T00:00:00"), + text: "French Open", + details: "Philippe-Chatrier Court\n Paris, FRA", + }, + { + id: "2", + type: "work", + start_date: new Date("2021-06-07T00:00:00"), + end_date: new Date("2021-06-13T00:00:00"), + text: "French Open", + details: "Philippe-Chatrier Court\n Paris, FRA", + }, ... ]; // calendars data const calendars = [ diff --git a/docs/api/methods/js_eventcalendar_serialize_method.md b/docs/api/methods/js_eventcalendar_serialize_method.md index c1ed775..d0dae77 100644 --- a/docs/api/methods/js_eventcalendar_serialize_method.md +++ b/docs/api/methods/js_eventcalendar_serialize_method.md @@ -22,8 +22,8 @@ The method returns an object of Event Calendar data (events and calendars) ~~~jsx {} { - events: [{...}, {...}, ...], - calendars: [{...}, {...}, ...] + events: [{...}, {...}, ...], + calendars: [{...}, {...}, ...] } ~~~ @@ -32,7 +32,7 @@ The method returns an object of Event Calendar data (events and calendars) ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // get an object of the Event Calendar data (events and calendars) const serialized_data = calendar.serialize(); diff --git a/docs/api/methods/js_eventcalendar_setconfig_method.md b/docs/api/methods/js_eventcalendar_setconfig_method.md index 1445752..d3f127f 100644 --- a/docs/api/methods/js_eventcalendar_setconfig_method.md +++ b/docs/api/methods/js_eventcalendar_setconfig_method.md @@ -29,19 +29,19 @@ Using this method, you can set the configuration parameters of the Event Calenda ~~~jsx {6-17} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // set the configuration parameters of Event Calendar calendar.setConfig({ - config: { - dragCreate: true, - eventInfoOnClick: true, - eventsOverlay: true, - autoSave: true, - dragResize: true, - dragMove: true - }, - locale: eventCalendar.ru, - mode: "month" + config: { + dragCreate: true, + eventInfoOnClick: true, + eventsOverlay: true, + autoSave: true, + dragResize: true, + dragMove: true + }, + locale: eventCalendar.ru, + mode: "month" }); ~~~ diff --git a/docs/api/methods/js_eventcalendar_setdate_method.md b/docs/api/methods/js_eventcalendar_setdate_method.md index 3fa5001..f459d81 100644 --- a/docs/api/methods/js_eventcalendar_setdate_method.md +++ b/docs/api/methods/js_eventcalendar_setdate_method.md @@ -25,7 +25,7 @@ setDate({ value: Date }): void; ~~~jsx {6-7} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); //set current date const date = new Date("2021-05-24 00:00:00"); diff --git a/docs/api/methods/js_eventcalendar_setlocale_method.md b/docs/api/methods/js_eventcalendar_setlocale_method.md index eea0b6f..19fff66 100644 --- a/docs/api/methods/js_eventcalendar_setlocale_method.md +++ b/docs/api/methods/js_eventcalendar_setlocale_method.md @@ -30,7 +30,7 @@ Using this method, you can apply a new locale to Event Calendar. To reset widget ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - locale: eventcalendar.en // the "en" locale is set by default + locale: eventcalendar.en // the "en" locale is set by default }); // apply "de" locale calendar.setLocale(eventCalendar.de); diff --git a/docs/api/methods/js_eventcalendar_setmode_method.md b/docs/api/methods/js_eventcalendar_setmode_method.md index b0bfe3f..e06a4a1 100644 --- a/docs/api/methods/js_eventcalendar_setmode_method.md +++ b/docs/api/methods/js_eventcalendar_setmode_method.md @@ -29,7 +29,7 @@ You can set the **value** parameter to the *"day"*, *"week"*, *"month"*, *"year" ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // initial configuration parameters + // initial configuration parameters }); // set the "timeline" mode calendar.setMode({ value: "timeline" }); diff --git a/docs/api/methods/js_eventcalendar_settheme_method.md b/docs/api/methods/js_eventcalendar_settheme_method.md index 450c7c4..9081256 100644 --- a/docs/api/methods/js_eventcalendar_settheme_method.md +++ b/docs/api/methods/js_eventcalendar_settheme_method.md @@ -19,16 +19,16 @@ setTheme(theme?: string): void; ### Parameters - `theme` - (optional) a theme to be applied to Event Calendar. There are 3 available themes: - - "material" - - "willow" - - "willowDark" + - "material" + - "willow" + - "willowDark" ### Example ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // initial configuration parameters + // initial configuration parameters }); // set the "willow" theme calendar.setTheme( "willow" ); diff --git a/docs/api/methods/js_eventcalendar_showeventinfo_method.md b/docs/api/methods/js_eventcalendar_showeventinfo_method.md index a03ce0b..8baf284 100644 --- a/docs/api/methods/js_eventcalendar_showeventinfo_method.md +++ b/docs/api/methods/js_eventcalendar_showeventinfo_method.md @@ -25,7 +25,7 @@ showEventInfo({ id: string | number }): void; ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // initial configuration parameters + // initial configuration parameters }); // open info popup for the event with the "1" ID calendar.showEventInfo({ id: "1" }); diff --git a/docs/api/methods/js_eventcalendar_togglesidebar_method.md b/docs/api/methods/js_eventcalendar_togglesidebar_method.md index c0c3cac..add762a 100644 --- a/docs/api/methods/js_eventcalendar_togglesidebar_method.md +++ b/docs/api/methods/js_eventcalendar_togglesidebar_method.md @@ -25,7 +25,7 @@ toggleSidebar({ show?: boolean }): void; ~~~jsx {6} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); // hide sidebar calendar.toggleSidebar({ show: false }); diff --git a/docs/api/methods/js_eventcalendar_updatecalendar_method.md b/docs/api/methods/js_eventcalendar_updatecalendar_method.md index af46c17..410b281 100644 --- a/docs/api/methods/js_eventcalendar_updatecalendar_method.md +++ b/docs/api/methods/js_eventcalendar_updatecalendar_method.md @@ -14,8 +14,8 @@ description: You can learn about the updateCalendar method in the documentation ~~~jsx {} updateCalendar({ - calendar: object, - id: string | number + calendar: object, + id: string | number }): void; ~~~ @@ -33,21 +33,21 @@ Note, the **ID** of the calendar to be updated is required. Other calendar param ~~~jsx {6-14,16-19} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); const new_calendar_data = { - id: "movie", - active: true, - label: "New Calendar", - color: { - background: "#CEEDC3", - border: "#77D257" - } + id: "movie", + active: true, + label: "New Calendar", + color: { + background: "#CEEDC3", + border: "#77D257" + } }; // update data of the calendar with the "Movie" ID calendar.updateCalendar({ - calendar: new_calendar_data, - id: "movie" + calendar: new_calendar_data, + id: "movie" }); ~~~ diff --git a/docs/api/methods/js_eventcalendar_updateevent_method.md b/docs/api/methods/js_eventcalendar_updateevent_method.md index 92769d7..b1f8dc5 100644 --- a/docs/api/methods/js_eventcalendar_updateevent_method.md +++ b/docs/api/methods/js_eventcalendar_updateevent_method.md @@ -14,8 +14,8 @@ description: You can learn about the updateEvent method in the documentation of ~~~jsx {} updateEvent({ - event: object, - id: string | number + event: object, + id: string | number }): void; ~~~ @@ -33,20 +33,20 @@ Note, the **ID** of the event to be updated is required. Other event parameters ~~~jsx {6-13,15-18} // create Event Calendar const calendar = new eventCalendar.EventCalendar("#root", { - // configuration parameters + // configuration parameters }); const new_event_data = { - id: "1.1", - type: "Work", - start_date: new Date("2021-05-24 00:00:00"), - end_date: new Date("2021-06-08 00:00:00"), - text: "Updated Event", - details: "Philippe-Chatrier Court\n Paris, FRA" + id: "1.1", + type: "Work", + start_date: new Date("2021-05-24 00:00:00"), + end_date: new Date("2021-06-08 00:00:00"), + text: "Updated Event", + details: "Philippe-Chatrier Court\n Paris, FRA" }; // update data of the event with the 1 ID calendar.updateEvent({ - event: new_event_data, - id: "1" + event: new_event_data, + id: "1" }); ~~~ diff --git a/docs/api/provider/rest_methods/js_eventcalendar_getcalendars_method.md b/docs/api/provider/rest_methods/js_eventcalendar_getcalendars_method.md index 0a76a83..f60ec93 100644 --- a/docs/api/provider/rest_methods/js_eventcalendar_getcalendars_method.md +++ b/docs/api/provider/rest_methods/js_eventcalendar_getcalendars_method.md @@ -31,14 +31,14 @@ const url = "https://some_backend_url"; const restProvider = new eventCalendar.RestDataProvider(url); Promise.all([ - restProvider.getEvents(), - restProvider.getCalendars() + restProvider.getEvents(), + restProvider.getCalendars() ]).then(([events, calendars]) => { - const calendar = new eventCalendar("#root", { - events, - calendars - }); - calendar.api.setNext(restProvider); + const calendar = new eventCalendar("#root", { + events, + calendars + }); + calendar.api.setNext(restProvider); }); ~~~ diff --git a/docs/api/provider/rest_methods/js_eventcalendar_getevents_method.md b/docs/api/provider/rest_methods/js_eventcalendar_getevents_method.md index 2846772..72de7ff 100644 --- a/docs/api/provider/rest_methods/js_eventcalendar_getevents_method.md +++ b/docs/api/provider/rest_methods/js_eventcalendar_getevents_method.md @@ -31,14 +31,14 @@ const url = "https://some_backend_url"; const restProvider = new eventCalendar.RestDataProvider(url); Promise.all([ - restProvider.getEvents(), - restProvider.getCalendars() + restProvider.getEvents(), + restProvider.getCalendars() ]).then(([events, calendars]) => { - const calendar = new eventCalendar("#root", { - events, - calendars - }); - calendar.api.setNext(restProvider); + const calendar = new eventCalendar("#root", { + events, + calendars + }); + calendar.api.setNext(restProvider); }); ~~~ diff --git a/docs/guides/configuration.md b/docs/guides/configuration.md index 5429017..0a9098a 100644 --- a/docs/guides/configuration.md +++ b/docs/guides/configuration.md @@ -388,13 +388,13 @@ new eventCalendar.EventCalendar("#root", { type: "files", key: "attached", // the "attached" key is used when providing the event data via the "events" property label: "Attachment", - uploadURL: url + "/uploads", - config: { - accept: "image/*", // "video/*", "audio/*" - disabled: false, - multiple: true, - folder: false - } + uploadURL: url + "/uploads", + config: { + accept: "image/*", // "video/*", "audio/*" + disabled: false, + multiple: true, + folder: false + } }, // settings of other fields ] @@ -493,7 +493,7 @@ new eventCalendar.EventCalendar("#root", { editorValidation: event => { if (!event.text) return "Text is required"; } - // other configuration parameters + // other configuration parameters }); ~~~ diff --git a/docs/guides/localization.md b/docs/guides/localization.md index 4f2c4fc..e2b9632 100644 --- a/docs/guides/localization.md +++ b/docs/guides/localization.md @@ -17,68 +17,68 @@ const en = { dateFnsLocale: dateFnsLocaleEn, eventCalendar: { // translations of the Event Calendar labels "New Event": "New Event", - "Add description": "Add description", - "Create event": "Create event", - "Edit event": "Edit event", - "Delete event": "Delete event", - "Event name": "Event name", - "Start date": "Start date", - "End date": "End date", - "All day": "All day", - "No events": "No events", - Type: "Type", - Description: "Description", - Today: "Today", - Day: "Day", - Week: "Week", - Month: "Month", - Timeline: "Timeline", - Calendars: "Calendars", - hourFormat: "H", - minuteFormat: "mm", - monthFormat: "EEE", - dateFormat: "EEE, d", - agendaDateFormat: "MMMM d EEEE", - unassignFormat: "d MMM yyyy", - Color: "Color", - Delete: "Delete", - Edit: "Edit", - Calendar: "Calendar", - New: "New", - Name: "Name", - Save: "Save", - Add: "Add", - Event: "Event", - confirmDelete: "Are you sure you want to delete {item}?", - confirmUnsaved: - "You have unsaved changes! Do you want to discard them?", - "Repeat event": "Repeat event", - viewAll: "+{count} more", - Never: "Never", - Every: "Every", - Workdays: "On work days", - Year: "Year", - Custom: "Custom", - Ends: "Ends", - After: "After", - "On date": "On date", - events: "events", - "recurring event": "recurring event", - all: "All events", - future: "This and following events", - only: "This event", + "Add description": "Add description", + "Create event": "Create event", + "Edit event": "Edit event", + "Delete event": "Delete event", + "Event name": "Event name", + "Start date": "Start date", + "End date": "End date", + "All day": "All day", + "No events": "No events", + Type: "Type", + Description: "Description", + Today: "Today", + Day: "Day", + Week: "Week", + Month: "Month", + Timeline: "Timeline", + Calendars: "Calendars", + hourFormat: "H", + minuteFormat: "mm", + monthFormat: "EEE", + dateFormat: "EEE, d", + agendaDateFormat: "MMMM d EEEE", + unassignFormat: "d MMM yyyy", + Color: "Color", + Delete: "Delete", + Edit: "Edit", + Calendar: "Calendar", + New: "New", + Name: "Name", + Save: "Save", + Add: "Add", + Event: "Event", + confirmDelete: "Are you sure you want to delete {item}?", + confirmUnsaved: + "You have unsaved changes! Do you want to discard them?", + "Repeat event": "Repeat event", + viewAll: "+{count} more", + Never: "Never", + Every: "Every", + Workdays: "On work days", + Year: "Year", + Custom: "Custom", + Ends: "Ends", + After: "After", + "On date": "On date", + events: "events", + "recurring event": "recurring event", + all: "All events", + future: "This and following events", + only: "This event", - recurringActionError: - "Start date cannot be after recurrent expiry date", + recurringActionError: + "Start date cannot be after recurrent expiry date", - Assignees: "Assignees", - "Recurring events": "Recurring events", - "Single events": "Single events", + Assignees: "Assignees", + "Recurring events": "Recurring events", + "Single events": "Single events", - recurringEveryMonthDay: "Every {date}", - recurringEveryMonthPos: "Every {pos} {weekDay}", - recurringEveryYearDay: "Every {date} of {month}", - recurringEveryYearPos: "Every {pos} {weekDay} of {month}" + recurringEveryMonthDay: "Every {date}", + recurringEveryMonthPos: "Every {pos} {weekDay}", + recurringEveryYearDay: "Every {date} of {month}", + recurringEveryYearPos: "Every {pos} {weekDay} of {month}" }, calendar: { // translations and settings of the calendar monthFull: [ @@ -144,68 +144,68 @@ Besides the ***en*** locale, Event Calendar also includes the built-in ***de*** const de = { dateFnsLocale: dateFnsLocaleDe, eventCalendar: { // translations of the Event Calendar labels - "New Event": "Neuer Eintrag", - "Add description": "Beschreibung", - "Create event": "Neuer Eintrag", - "Edit event": "Ändern", - "Delete event": "Löschen", - "Event name": "Name", - "Start date": "Start", - "End date": "Ende", - "All day": "Den ganzen Tag", - "No events": "Keine Ereignisse", - Type: "Typ", - Description: "Beschreibung", - Today: "Heute", - Day: "Tag", - Week: "Woche", - Month: "Monat", - Year: "Jahr", - Timeline: "Zeitleiste", - Agenda: "Agenda", - Calendars: "Kalender", - hourFormat: "H", - minuteFormat: "mm", - monthFormat: "EEE", - dateFormat: "EEE, d", - agendaDateFormat: "MMMM d EEEE", - unassignFormat: "d MMM yyyy", - Color: "Farbe", - Delete: "Löschen", - Edit: "Ändern", - Calendar: "Kalender", - New: "Neuer", - Name: "Name", - Save: "Speichern", - Add: "Hinzufügen", - Event: "Eintrag", - confirmDelete: "Möchten Sie {item} wirklich löschen?", - confirmUnsaved: - "Du hast nicht gespeicherte Änderungen! Möchten Sie sie verwerfen?", - "Repeat event": "Ereignis wiederholen", - viewAll: "+{count} mehr", - Never: "Niemals", - Every: "Jeden", - Workdays: "An Werktagen", - After: "Nach", - "On date": "Am tag", - events: "veranstaltungen", - "recurring event": "wiederkehrendes ereignis", - all: "Alle ereignis", - future: "Diese und folgende ereignis", - only: "Diese ereigni", + "New Event": "Neuer Eintrag", + "Add description": "Beschreibung", + "Create event": "Neuer Eintrag", + "Edit event": "Ändern", + "Delete event": "Löschen", + "Event name": "Name", + "Start date": "Start", + "End date": "Ende", + "All day": "Den ganzen Tag", + "No events": "Keine Ereignisse", + Type: "Typ", + Description: "Beschreibung", + Today: "Heute", + Day: "Tag", + Week: "Woche", + Month: "Monat", + Year: "Jahr", + Timeline: "Zeitleiste", + Agenda: "Agenda", + Calendars: "Kalender", + hourFormat: "H", + minuteFormat: "mm", + monthFormat: "EEE", + dateFormat: "EEE, d", + agendaDateFormat: "MMMM d EEEE", + unassignFormat: "d MMM yyyy", + Color: "Farbe", + Delete: "Löschen", + Edit: "Ändern", + Calendar: "Kalender", + New: "Neuer", + Name: "Name", + Save: "Speichern", + Add: "Hinzufügen", + Event: "Eintrag", + confirmDelete: "Möchten Sie {item} wirklich löschen?", + confirmUnsaved: + "Du hast nicht gespeicherte Änderungen! Möchten Sie sie verwerfen?", + "Repeat event": "Ereignis wiederholen", + viewAll: "+{count} mehr", + Never: "Niemals", + Every: "Jeden", + Workdays: "An Werktagen", + After: "Nach", + "On date": "Am tag", + events: "veranstaltungen", + "recurring event": "wiederkehrendes ereignis", + all: "Alle ereignis", + future: "Diese und folgende ereignis", + only: "Diese ereigni", - recurringActionError: - "Das Startdatum darf nicht nach dem wiederkehrenden Ablaufdatum liegen", + recurringActionError: + "Das Startdatum darf nicht nach dem wiederkehrenden Ablaufdatum liegen", - Assignees: "Abtretungsempfänger", - "Recurring events": "Wiederkehrende ereignisse", - "Single events": "Einzelereignisse", - recurringEveryMonthDay: "Jedes {date}", - recurringEveryMonthPos: "Jeden {pos} {weekDay}", - recurringEveryYearDay: "Jedes {date} von {month}", - recurringEveryYearPos: "Jeden {pos} {weekDay} von {month}", - }, + Assignees: "Abtretungsempfänger", + "Recurring events": "Wiederkehrende ereignisse", + "Single events": "Einzelereignisse", + recurringEveryMonthDay: "Jedes {date}", + recurringEveryMonthPos: "Jeden {pos} {weekDay}", + recurringEveryYearDay: "Jedes {date} von {month}", + recurringEveryYearPos: "Jeden {pos} {weekDay} von {month}", + }, calendar: { // translations and settings of the calendar monthFull:[ "Januar", "Februar", "März", "April", diff --git a/docs/guides/working_with_data.md b/docs/guides/working_with_data.md index 849bde8..c733971 100644 --- a/docs/guides/working_with_data.md +++ b/docs/guides/working_with_data.md @@ -96,9 +96,9 @@ const colors = [ // data for colors used in colorpicker // initialize Event Calendar with the initial data for events, calendars and colors new eventCalendar.EventCalendar("#root", { - events, - calendars, - colors + events, + calendars, + colors }); ~~~ diff --git a/docs/how_to_start.md b/docs/how_to_start.md index 9cb95a0..31fc4b3 100644 --- a/docs/how_to_start.md +++ b/docs/how_to_start.md @@ -20,16 +20,16 @@ There are two necessary files: ~~~html {5-6} title="index.html" - - How to Start with Event Calendar - - - - - - + + How to Start with Event Calendar + + + + + + ~~~ @@ -65,52 +65,52 @@ The constructor takes an ID of HTML container where Event Calendar will be place ~~~html {9,11-46} title="index.html" - - How to Start with Event Calendar - - - - -
- - + + How to Start with Event Calendar + + + + +
+ + ~~~ @@ -128,17 +128,17 @@ Next you can specify the configuration properties you want the Event Calendar co ~~~jsx {2-12} new eventCalendar.EventCalendar("#root", { - calendars, - colors, - config, - date, - editorShape, - events, - locale, - mode, - sidebar, - templates, - theme + calendars, + colors, + config, + date, + editorShape, + events, + locale, + mode, + sidebar, + templates, + theme }); ~~~ diff --git a/docs/news/whats_new.md b/docs/news/whats_new.md index fc82c16..a6e7813 100644 --- a/docs/news/whats_new.md +++ b/docs/news/whats_new.md @@ -68,7 +68,7 @@ Released on October 31, 2023 - #### Properties - - [`editorValidation`](../../api/config/js_eventcalendar_editorvalidation_config) + - [`editorValidation`](../../api/config/js_eventcalendar_editorvalidation_config) ### Fixes diff --git a/sidebars.js b/sidebars.js index 74f400c..a2b1275 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,326 +1,326 @@ module.exports = { - docs: [ - { - type: "doc", - id: "index" - }, - { - type: "doc", - id: "how_to_start" - }, - { - type: "category", - label: "What's new and migration", - collapsible: true, - collapsed: true, - link: { - type: 'generated-index', - title: "What's new and migration", - keywords: ['news'], - image: '/img/docusaurus.png', - }, - items: [ - "news/whats_new", - "news/migration" - ] - }, - { - type: "category", - label: "API", - collapsible: true, - collapsed: false, - link: { - type: 'doc', - id: "api/api_overview" - }, - items: [ - //"api/api_overview", - // Event Calendar methods - { - type: "category", - label: "Event Calendar methods", - collapsible: true, - collapsed: true, - link: { - type: 'doc', - id: "api/overview/methods_overview" - }, - items: [ - "api/methods/js_eventcalendar_addcalendar_method", - "api/methods/js_eventcalendar_addevent_method", - "api/methods/js_eventcalendar_closeeditor_method", - "api/methods/js_eventcalendar_createevent_method", - "api/methods/js_eventcalendar_deletecalendar_method", - "api/methods/js_eventcalendar_deleteevent_method", - "api/methods/js_eventcalendar_destructor_method", - "api/methods/js_eventcalendar_getcalendar_method", - "api/methods/js_eventcalendar_getevent_method", - "api/methods/js_eventcalendar_hideeventinfo_method", - "api/methods/js_eventcalendar_openeditor_method", - "api/methods/js_eventcalendar_parse_method", - "api/methods/js_eventcalendar_serialize_method", - "api/methods/js_eventcalendar_setconfig_method", - "api/methods/js_eventcalendar_setdate_method", - "api/methods/js_eventcalendar_setlocale_method", - "api/methods/js_eventcalendar_setmode_method", - "api/methods/js_eventcalendar_settheme_method", - "api/methods/js_eventcalendar_showeventinfo_method", - "api/methods/js_eventcalendar_togglesidebar_method", - "api/methods/js_eventcalendar_updatecalendar_method", - "api/methods/js_eventcalendar_updateevent_method", - // other methods - ] - }, - // Event Calendar internal methods - { - type: "category", - label: "Event Calendar internal API", - collapsible: true, - collapsed: true, - link: { - type: 'generated-index', - title: 'Internal API overview', - keywords: ['internal api'], - image: '/img/docusaurus.png' - }, - items: [ - { - type: "category", - label: "Event Bus methods", - collapsible: true, - collapsed: true, - link: { - type: 'doc', - id: "api/overview/internal_eventbus_overview" - }, - items: [ - "api/internal/js_eventcalendar_exec_method", - "api/internal/js_eventcalendar_intercept_method", - "api/internal/js_eventcalendar_on_method", - "api/internal/js_eventcalendar_setnext_method" - ] - }, - { - type: "category", - label: "State methods", - collapsible: true, - collapsed: true, - link: { - type: 'doc', - id: "api/overview/internal_state_overview" - }, - items: [ - "api/internal/js_eventcalendar_getreactivestate_method", - "api/internal/js_eventcalendar_getstate_method", - "api/internal/js_eventcalendar_getstores_method" - ] - }, - - ] - }, - { - type: "category", - label: "Event Calendar events", - collapsible: true, - collapsed: true, - link: { - type: 'doc', - id: "api/overview/events_overview" - }, - items: [ - // Event Calendar events - "api/events/js_eventcalendar_addcalendar_event", - "api/events/js_eventcalendar_addevent_event", - "api/events/js_eventcalendar_closeeventinfo_event", - "api/events/js_eventcalendar_deletecalendar_event", - "api/events/js_eventcalendar_deleteevent_event", - "api/events/js_eventcalendar_editevent_event", - "api/events/js_eventcalendar_selectevent_event", - "api/events/js_eventcalendar_setbound_event", - "api/events/js_eventcalendar_setdate_event", - "api/events/js_eventcalendar_setmode_event", - "api/events/js_eventcalendar_togglesidebar_event", - "api/events/js_eventcalendar_updatecalendar_event", - "api/events/js_eventcalendar_updateevent_event", - - ] - }, - { - type: "category", - label: "Event Calendar properties", - collapsible: true, - collapsed: true, - link: { - type: 'doc', - id: "api/overview/properties_overview" - }, - items: [ - // Event Calendar properties - "api/config/js_eventcalendar_calendars_config", - "api/config/js_eventcalendar_colors_config", - "api/config/js_eventcalendar_config_config", - "api/config/js_eventcalendar_date_config", - "api/config/js_eventcalendar_editorshape_config", - "api/config/js_eventcalendar_editorvalidation_config", - "api/config/js_eventcalendar_events_config", - "api/config/js_eventcalendar_locale_config", - "api/config/js_eventcalendar_mode_config", - "api/config/js_eventcalendar_sidebar_config", - "api/config/js_eventcalendar_templates_config", - "api/config/js_eventcalendar_theme_config" - ] - }, - // RestDataProvider api - { - type: "category", - label: "RestDataProvider API", - collapsible: true, - collapsed: true, - link: { - type: 'generated-index', - title: "RestDataProvider API", - keywords: ['rest api'], - image: '/img/docusaurus.png' - }, - items: [ - { - type: "category", - label: "REST methods", - collapsed: true, - link: { - type: 'doc', - id: "api/overview/rest_methods_overview" - }, - items: [ - "api/provider/rest_methods/js_eventcalendar_getevents_method", - "api/provider/rest_methods/js_eventcalendar_getcalendars_method", - "api/provider/rest_methods/js_eventcalendar_send_method", - ] - - }, - { - type: "category", - label: "REST routes", - collapsed: true, - link: { - type: 'doc', - id: "api/overview/rest_routes_overview" - }, - items: [ - { - type: "category", - label: "GET routes", - collapsed: true, - link: { - type: 'generated-index', - title: "GET routes", - keywords: ['routes'], - image: '/img/docusaurus.png' - }, - items: [ - "api/provider/rest_routes/get_routes/js_eventcalendar_getevents_route", - "api/provider/rest_routes/get_routes/js_eventcalendar_getcalendars_route", - "api/provider/rest_routes/get_routes/js_eventcalendar_getuploads_route", - ] - }, - { - type: "category", - label: "POST routes", - collapsed: true, - link: { - type: 'generated-index', - title: "POST routes", - keywords: ['routes'], - image: '/img/docusaurus.png' - }, - items: [ - "api/provider/rest_routes/post_routes/js_eventcalendar_postevent_route", - "api/provider/rest_routes/post_routes/js_eventcalendar_postcalendar_route", - "api/provider/rest_routes/post_routes/js_eventcalendar_postupload_route", - ] - }, - { - type: "category", - label: "PUT routes", - collapsed: true, - link: { - type: 'generated-index', - title: "PUT routes", - keywords: ['routes'], - image: '/img/docusaurus.png' - }, - items: [ - "api/provider/rest_routes/put_routes/js_eventcalendar_putevent_route", - "api/provider/rest_routes/put_routes/js_eventcalendar_putcalendar_route", - ] - }, - { - type: "category", - label: "DELETE routes", - collapsed: true, - link: { - type: 'generated-index', - title: "DELETE routes", - keywords: ['routes'], - image: '/img/docusaurus.png' - }, - items: [ - "api/provider/rest_routes/delete_routes/js_eventcalendar_deleteevent_route", - "api/provider/rest_routes/delete_routes/js_eventcalendar_deletecalendar_route", - ] - } - ] - } - ] - }, - ] - }, + docs: [ + { + type: "doc", + id: "index" + }, + { + type: "doc", + id: "how_to_start" + }, + { + type: "category", + label: "What's new and migration", + collapsible: true, + collapsed: true, + link: { + type: 'generated-index', + title: "What's new and migration", + keywords: ['news'], + image: '/img/docusaurus.png', + }, + items: [ + "news/whats_new", + "news/migration" + ] + }, + { + type: "category", + label: "API", + collapsible: true, + collapsed: false, + link: { + type: 'doc', + id: "api/api_overview" + }, + items: [ + //"api/api_overview", + // Event Calendar methods + { + type: "category", + label: "Event Calendar methods", + collapsible: true, + collapsed: true, + link: { + type: 'doc', + id: "api/overview/methods_overview" + }, + items: [ + "api/methods/js_eventcalendar_addcalendar_method", + "api/methods/js_eventcalendar_addevent_method", + "api/methods/js_eventcalendar_closeeditor_method", + "api/methods/js_eventcalendar_createevent_method", + "api/methods/js_eventcalendar_deletecalendar_method", + "api/methods/js_eventcalendar_deleteevent_method", + "api/methods/js_eventcalendar_destructor_method", + "api/methods/js_eventcalendar_getcalendar_method", + "api/methods/js_eventcalendar_getevent_method", + "api/methods/js_eventcalendar_hideeventinfo_method", + "api/methods/js_eventcalendar_openeditor_method", + "api/methods/js_eventcalendar_parse_method", + "api/methods/js_eventcalendar_serialize_method", + "api/methods/js_eventcalendar_setconfig_method", + "api/methods/js_eventcalendar_setdate_method", + "api/methods/js_eventcalendar_setlocale_method", + "api/methods/js_eventcalendar_setmode_method", + "api/methods/js_eventcalendar_settheme_method", + "api/methods/js_eventcalendar_showeventinfo_method", + "api/methods/js_eventcalendar_togglesidebar_method", + "api/methods/js_eventcalendar_updatecalendar_method", + "api/methods/js_eventcalendar_updateevent_method", + // other methods + ] + }, + // Event Calendar internal methods + { + type: "category", + label: "Event Calendar internal API", + collapsible: true, + collapsed: true, + link: { + type: 'generated-index', + title: 'Internal API overview', + keywords: ['internal api'], + image: '/img/docusaurus.png' + }, + items: [ + { + type: "category", + label: "Event Bus methods", + collapsible: true, + collapsed: true, + link: { + type: 'doc', + id: "api/overview/internal_eventbus_overview" + }, + items: [ + "api/internal/js_eventcalendar_exec_method", + "api/internal/js_eventcalendar_intercept_method", + "api/internal/js_eventcalendar_on_method", + "api/internal/js_eventcalendar_setnext_method" + ] + }, + { + type: "category", + label: "State methods", + collapsible: true, + collapsed: true, + link: { + type: 'doc', + id: "api/overview/internal_state_overview" + }, + items: [ + "api/internal/js_eventcalendar_getreactivestate_method", + "api/internal/js_eventcalendar_getstate_method", + "api/internal/js_eventcalendar_getstores_method" + ] + }, + + ] + }, + { + type: "category", + label: "Event Calendar events", + collapsible: true, + collapsed: true, + link: { + type: 'doc', + id: "api/overview/events_overview" + }, + items: [ + // Event Calendar events + "api/events/js_eventcalendar_addcalendar_event", + "api/events/js_eventcalendar_addevent_event", + "api/events/js_eventcalendar_closeeventinfo_event", + "api/events/js_eventcalendar_deletecalendar_event", + "api/events/js_eventcalendar_deleteevent_event", + "api/events/js_eventcalendar_editevent_event", + "api/events/js_eventcalendar_selectevent_event", + "api/events/js_eventcalendar_setbound_event", + "api/events/js_eventcalendar_setdate_event", + "api/events/js_eventcalendar_setmode_event", + "api/events/js_eventcalendar_togglesidebar_event", + "api/events/js_eventcalendar_updatecalendar_event", + "api/events/js_eventcalendar_updateevent_event", + + ] + }, + { + type: "category", + label: "Event Calendar properties", + collapsible: true, + collapsed: true, + link: { + type: 'doc', + id: "api/overview/properties_overview" + }, + items: [ + // Event Calendar properties + "api/config/js_eventcalendar_calendars_config", + "api/config/js_eventcalendar_colors_config", + "api/config/js_eventcalendar_config_config", + "api/config/js_eventcalendar_date_config", + "api/config/js_eventcalendar_editorshape_config", + "api/config/js_eventcalendar_editorvalidation_config", + "api/config/js_eventcalendar_events_config", + "api/config/js_eventcalendar_locale_config", + "api/config/js_eventcalendar_mode_config", + "api/config/js_eventcalendar_sidebar_config", + "api/config/js_eventcalendar_templates_config", + "api/config/js_eventcalendar_theme_config" + ] + }, + // RestDataProvider api + { + type: "category", + label: "RestDataProvider API", + collapsible: true, + collapsed: true, + link: { + type: 'generated-index', + title: "RestDataProvider API", + keywords: ['rest api'], + image: '/img/docusaurus.png' + }, + items: [ + { + type: "category", + label: "REST methods", + collapsed: true, + link: { + type: 'doc', + id: "api/overview/rest_methods_overview" + }, + items: [ + "api/provider/rest_methods/js_eventcalendar_getevents_method", + "api/provider/rest_methods/js_eventcalendar_getcalendars_method", + "api/provider/rest_methods/js_eventcalendar_send_method", + ] + + }, + { + type: "category", + label: "REST routes", + collapsed: true, + link: { + type: 'doc', + id: "api/overview/rest_routes_overview" + }, + items: [ + { + type: "category", + label: "GET routes", + collapsed: true, + link: { + type: 'generated-index', + title: "GET routes", + keywords: ['routes'], + image: '/img/docusaurus.png' + }, + items: [ + "api/provider/rest_routes/get_routes/js_eventcalendar_getevents_route", + "api/provider/rest_routes/get_routes/js_eventcalendar_getcalendars_route", + "api/provider/rest_routes/get_routes/js_eventcalendar_getuploads_route", + ] + }, + { + type: "category", + label: "POST routes", + collapsed: true, + link: { + type: 'generated-index', + title: "POST routes", + keywords: ['routes'], + image: '/img/docusaurus.png' + }, + items: [ + "api/provider/rest_routes/post_routes/js_eventcalendar_postevent_route", + "api/provider/rest_routes/post_routes/js_eventcalendar_postcalendar_route", + "api/provider/rest_routes/post_routes/js_eventcalendar_postupload_route", + ] + }, + { + type: "category", + label: "PUT routes", + collapsed: true, + link: { + type: 'generated-index', + title: "PUT routes", + keywords: ['routes'], + image: '/img/docusaurus.png' + }, + items: [ + "api/provider/rest_routes/put_routes/js_eventcalendar_putevent_route", + "api/provider/rest_routes/put_routes/js_eventcalendar_putcalendar_route", + ] + }, + { + type: "category", + label: "DELETE routes", + collapsed: true, + link: { + type: 'generated-index', + title: "DELETE routes", + keywords: ['routes'], + image: '/img/docusaurus.png' + }, + items: [ + "api/provider/rest_routes/delete_routes/js_eventcalendar_deleteevent_route", + "api/provider/rest_routes/delete_routes/js_eventcalendar_deletecalendar_route", + ] + } + ] + } + ] + }, + ] + }, - //start Backend and frameworks integration - { - type: "category", - label: "Backend and frameworks integration", - link: { - type: 'generated-index', - title: "Backend and frameworks integration", - keywords: ['backend and frameworks integration'], - image: '/img/docusaurus.png' - }, - items: [ - "guides/working_with_server", - "guides/integration_with_angular", - "guides/integration_with_react", - "guides/integration_with_vue", - "guides/integration_with_svelte", - ], - }, - // end Backend and frameworks integration + //start Backend and frameworks integration + { + type: "category", + label: "Backend and frameworks integration", + link: { + type: 'generated-index', + title: "Backend and frameworks integration", + keywords: ['backend and frameworks integration'], + image: '/img/docusaurus.png' + }, + items: [ + "guides/working_with_server", + "guides/integration_with_angular", + "guides/integration_with_react", + "guides/integration_with_vue", + "guides/integration_with_svelte", + ], + }, + // end Backend and frameworks integration - { - type: "category", - label: "Guides", - collapsible: true, - collapsed: true, - link: { - type: 'generated-index', - title: 'Guides', - keywords: ['guides'], - image: '/img/docusaurus.png', - }, - items: [ - "guides/initialization", - "guides/configuration", - "guides/customization", - "guides/stylization", - "guides/localization", - "guides/working_with_data", - //"guides/working_with_server", - "guides/typescript_support" - ] - }, - { - type: "doc", - id: "howtos" - } - ] + { + type: "category", + label: "Guides", + collapsible: true, + collapsed: true, + link: { + type: 'generated-index', + title: 'Guides', + keywords: ['guides'], + image: '/img/docusaurus.png', + }, + items: [ + "guides/initialization", + "guides/configuration", + "guides/customization", + "guides/stylization", + "guides/localization", + "guides/working_with_data", + //"guides/working_with_server", + "guides/typescript_support" + ] + }, + { + type: "doc", + id: "howtos" + } + ] };