npm - @event-calendar/build - Versions diffs - 3.3.0 → 3.5.0 - Mend

@event-calendar/build 3.3.0 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/README.md CHANGED Viewed

@@ -61,6 +61,7 @@ Inspired by [FullCalendar](https://fullcalendar.io/), implements similar options
   - [eventStartEditable](#eventstarteditable)
   - [eventTextColor](#eventtextcolor)
   - [eventTimeFormat](#eventtimeformat)
+  - [filterEventsWithResources](#filtereventswithresources)
   - [filterResourcesWithEvents](#filterresourceswithevents)
   - [firstDay](#firstday)
   - [flexibleSlotTimeLimits](#flexibleslottimelimits)
@@ -204,8 +205,8 @@ import '@event-calendar/core/index.css';
 ### Pre-built browser ready bundle
 Include the following lines of code in the `<head>` section of your page:
 ```html
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@event-calendar/build@3.3.0/event-calendar.min.css">
-<script src="https://cdn.jsdelivr.net/npm/@event-calendar/build@3.3.0/event-calendar.min.js"></script>
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@event-calendar/build@3.5.0/event-calendar.min.css">
+<script src="https://cdn.jsdelivr.net/npm/@event-calendar/build@3.5.0/event-calendar.min.js"></script>
 ```
 <details>
@@ -668,7 +669,7 @@ Determines whether the events on the calendar can be dragged and resized (both a
 If you don't need both, use the more specific [eventStartEditable](#eventstarteditable) and [eventDurationEditable](#eventdurationeditable) instead.
 ### events
-- Type `Array`
+- Type `array`
 - Default `[]`
 Array of plain objects that will be parsed into [Event](#event-object) objects and displayed on the calendar.
@@ -804,11 +805,11 @@ This is currently an alias for the `eventBackgroundColor`.
 Defines the content that is rendered inside an event’s element.
-This value can be either a [Content](#content) or a function that returns content:
+This value can be either a [Content](#content) or a function that returns content or `undefined`:
 ```js
 function (info) {
-    // return Content
+    // return Content or undefined
 }
 ```
 `info` is an object with the following properties:
@@ -842,6 +843,8 @@ The current [View](#view-object) object
 </tr>
 </table>
+In case the function returns `undefined`, the event will be rendered in the default way.
 ### eventDidMount
 - Type `function`
 - Default `undefined`
@@ -1504,6 +1507,12 @@ Sets the default text color for events on the calendar.
 You can use any of the CSS color formats such `'#f00'`, `'#ff0000'`, `'rgb(255,0,0)'`, or `'red'`.
+### filterEventsWithResources
+- Type `boolean`
+- Default `false`
+Determines whether events that do not belong to the current array of [resources](#resources) should be hidden in `dayGrid`/`timeGrid`/`list` views.
 ### filterResourcesWithEvents
 - Type `boolean`
 - Default `false`
@@ -1614,13 +1623,13 @@ Defines the height of the entire calendar.
 This should be a valid CSS value like `'100%'` or `'600px'`.
 ### hiddenDays
-- Type `Array`
+- Type `array`
 - Default `[]`
 Exclude certain days-of-the-week from being displayed, where Sunday is `0`, Monday is `1`, etc. Saturday is `6`.
 ### highlightedDates
-- Type `Array`
+- Type `array`
 - Default `[]`
 Array of dates that need to be highlighted in the calendar.
@@ -1811,7 +1820,7 @@ Enables a marker indicating the current time in `timeGrid`/`resourceTimeGrid` vi
 Enables mouse cursor pointer in `timeGrid`/`resourceTimeGrid` and other views.
 ### resources
-- Type `Array`
+- Type `array`
 - Default `[]`
 Array of plain objects that will be parsed into [Resource](#resource-object) objects for displaying in the resource view.
@@ -2076,13 +2085,13 @@ This should be a value that can be parsed into a [Duration](#duration-object) ob
 ### slotWidth
 - Type `integer`
-- Default `52`
+- Default `72`
 Defines the time slot width in pixels in `ResourceTimeline` views. When changing the setting, you must additionally override the following CSS styles:
 ```css
 .ec-timeline .ec-time, .ec-timeline .ec-line {
-  width: 52px;  /* override this value */
+  width: 72px;  /* override this value */
 }
 ```
@@ -2531,48 +2540,48 @@ The [eventTextColor](#eventtextcolor) override for this specific event
 <tr>
 <td>
-`extendedProps`
+`classNames`
 </td>
 <td>
-A plain object holding miscellaneous properties specified during parsing in the explicitly given `extendedProps` field
+An array of additional CSS classes for this specific event
 </td>
 </tr>
-</table>
-### Parsing event from a plain object
-When Event Calendar receives an array of plain event’s objects either from the `events` option or as a result of an HTTP request to a URL of an event source, it parses the input objects into proper Event objects.
-Here are all admissible fields for the event’s input object:
-<table>
 <tr>
 <td>
-`id`
+`styles`
 </td>
 <td>
-`string` or `integer` A unique identifier of the event. Default `auto-generated value`
+An array of additional inline styling declarations for this specific event
 </td>
 </tr>
 <tr>
 <td>
-`resourceId`
+`extendedProps`
 </td>
 <td>
-`string` or `integer` An ID of a resource that the event is associated with. This field is not used if `resourceIds` is provided. Default `undefined`
+A plain object holding miscellaneous properties specified during parsing in the explicitly given `extendedProps` field
 </td>
 </tr>
+</table>
+### Parsing event from a plain object
+When Event Calendar receives an array of plain event’s objects either from the `events` option or as a result of an HTTP request to a URL of an event source, it parses the input objects into proper Event objects.
+Here are all admissible fields for the event’s input object:
+<table>
 <tr>
 <td>
-`resourceIds`
+`id`
 </td>
 <td>
-`Array` An array of resource IDs that the event is associated with. This field is used instead of `resourceId`. Default `[]`
+`string` or `integer` A unique identifier of the event. Default `auto-generated value`
 </td>
 </tr>
 <tr>
@@ -2638,6 +2647,26 @@ Here are all admissible fields for the event’s input object:
 <tr>
 <td>
+`durationEditable`
+</td>
+<td>
+`boolean` Overrides the master [eventDurationEditable](#eventdurationeditable) option for this single event. Default `undefined`
+</td>
+</tr>
+<tr>
+<td>
+`resourceIds` or `resourceId`
+</td>
+<td>
+`string`, `integer` or `array`  An ID of a resource or an array of resource IDs that the event is associated with. Default `[]`
+</td>
+</tr>
+<tr>
+<td>
 `display`
 </td>
 <td>
@@ -2678,6 +2707,26 @@ Here are all admissible fields for the event’s input object:
 <tr>
 <td>
+`classNames` or `className`
+</td>
+<td>
+`string` or `array` Sets additional CSS classes for this single event. See [eventClassNames](#eventclassnames). Default `[]`
+</td>
+</tr>
+<tr>
+<td>
+`styles` or `style`
+</td>
+<td>
+`string` or `array` Sets additional inline styling declarations for this single event. This value can be either a string containing styles `'font-size: 24px; border-radius: 4px; ...'` or an array of strings `['font-size: 24px', 'border-radius: 4px', ...]`. Default `[]`
+</td>
+</tr>
+<tr>
+<td>
 `extendedProps`
 </td>
 <td>
@@ -2773,6 +2822,16 @@ The title of the resource. See [Content](#content)
 </td>
 <td>Default text color for this resource's events</td>
 </tr>
+<tr>
+<td>
+`extendedProps`
+</td>
+<td>
+A plain object holding miscellaneous properties specified during parsing in the explicitly given `extendedProps` field
+</td>
+</tr>
 </table>
 ### Parsing resource from a plain object
@@ -2820,6 +2879,16 @@ Here are all admissible fields for the resource’s input object:
 `string` Sets the default text color for this resource's events just like the calendar-wide [eventTextColor](#eventtextcolor) option. Default `undefined`
 </td>
 </tr>
+<tr>
+<td>
+`extendedProps`
+</td>
+<td>
+`object` A plain object with any miscellaneous properties. It will be directly transferred to the `extendedProps` property of the Resource object. Default `{}`
+</td>
+</tr>
 </table>
 ## View object