@types/react-big-calendar - npm Package Compare versions

Comparing version 0.31.4 to 0.31.5

react-big-calendar/index.d.ts

@@ -60,7 +60,7 @@ // Type definitions for react-big-calendar 0.31
 export type ViewsProps<TEvent extends object = Event, TResource extends object = object> = View[] | {
-    work_week?: boolean | React.ComponentType<any> & ViewStatic,
-    day?: boolean | React.ComponentType<any> & ViewStatic,
-    agenda?: boolean | React.ComponentType<any> & ViewStatic,
-    month?: boolean | React.ComponentType<any> & ViewStatic,
-    week?: boolean | React.ComponentType<any> & ViewStatic
+    work_week?: boolean | React.ComponentType<any> & ViewStatic | undefined,
+    day?: boolean | React.ComponentType<any> & ViewStatic | undefined,
+    agenda?: boolean | React.ComponentType<any> & ViewStatic | undefined,
+    month?: boolean | React.ComponentType<any> & ViewStatic | undefined,
+    week?: boolean | React.ComponentType<any> & ViewStatic | undefined
 };
@@ -76,6 +76,6 @@ export type DayLayoutFunction<TEvent extends object = Event> = (_: {
 export interface Event {
-    allDay?: boolean;
-    title?: string;
-    start?: Date;
-    end?: Date;
+    allDay?: boolean | undefined;
+    title?: string | undefined;
+    start?: Date | undefined;
+    end?: Date | undefined;
     resource?: any;
@@ -97,3 +97,3 @@ }
      */
-    dateFormat?: DateFormat;
+    dateFormat?: DateFormat | undefined;
 
@@ -105,3 +105,3 @@ /**
      */
-    dayFormat?: DateFormat;
+    dayFormat?: DateFormat | undefined;
 
@@ -113,3 +113,3 @@ /**
      */
-    weekdayFormat?: DateFormat;
+    weekdayFormat?: DateFormat | undefined;
 
@@ -119,3 +119,3 @@ /**
      */
-    timeGutterFormat?: DateFormat;
+    timeGutterFormat?: DateFormat | undefined;
 
@@ -126,3 +126,3 @@ /**
      */
-    monthHeaderFormat?: DateFormat;
+    monthHeaderFormat?: DateFormat | undefined;
 
@@ -132,3 +132,3 @@ /**
      */
-    dayRangeHeaderFormat?: DateRangeFormatFunction;
+    dayRangeHeaderFormat?: DateRangeFormatFunction | undefined;
 
@@ -138,3 +138,3 @@ /**
      */
-    dayHeaderFormat?: DateFormat;
+    dayHeaderFormat?: DateFormat | undefined;
 
@@ -144,3 +144,3 @@ /**
      */
-    agendaHeaderFormat?: DateRangeFormatFunction;
+    agendaHeaderFormat?: DateRangeFormatFunction | undefined;
 
@@ -150,7 +150,7 @@ /**
      */
-    selectRangeFormat?: DateRangeFormatFunction;
+    selectRangeFormat?: DateRangeFormatFunction | undefined;
 
-    agendaDateFormat?: DateFormat;
-    agendaTimeFormat?: DateFormat;
-    agendaTimeRangeFormat?: DateRangeFormatFunction;
+    agendaDateFormat?: DateFormat | undefined;
+    agendaTimeFormat?: DateFormat | undefined;
+    agendaTimeRangeFormat?: DateRangeFormatFunction | undefined;
 
@@ -160,3 +160,3 @@ /**
      */
-    eventTimeRangeFormat?: DateRangeFormatFunction;
+    eventTimeRangeFormat?: DateRangeFormatFunction | undefined;
 
@@ -166,3 +166,3 @@ /**
      */
-    eventTimeRangeStartFormat?: DateRangeFormatFunction;
+    eventTimeRangeStartFormat?: DateRangeFormatFunction | undefined;
 
@@ -172,3 +172,3 @@ /**
      */
-    eventTimeRangeEndFormat?: DateRangeFormatFunction;
+    eventTimeRangeEndFormat?: DateRangeFormatFunction | undefined;
 }
@@ -189,38 +189,38 @@
 export interface Components<TEvent extends object = Event, TResource extends object = object> {
-    event?: React.ComponentType<EventProps<TEvent>>;
-    eventWrapper?: React.ComponentType<EventWrapperProps<TEvent>>;
-    eventContainerWrapper?: React.ComponentType;
-    dateCellWrapper?: React.ComponentType;
-    dayColumnWrapper?: React.ComponentType;
-    timeSlotWrapper?: React.ComponentType;
-    timeGutterHeader?: React.ComponentType;
-    timeGutterWrapper?: React.ComponentType;
-    toolbar?: React.ComponentType<ToolbarProps<TEvent, TResource>>;
+    event?: React.ComponentType<EventProps<TEvent>> | undefined;
+    eventWrapper?: React.ComponentType<EventWrapperProps<TEvent>> | undefined;
+    eventContainerWrapper?: React.ComponentType | undefined;
+    dateCellWrapper?: React.ComponentType | undefined;
+    dayColumnWrapper?: React.ComponentType | undefined;
+    timeSlotWrapper?: React.ComponentType | undefined;
+    timeGutterHeader?: React.ComponentType | undefined;
+    timeGutterWrapper?: React.ComponentType | undefined;
+    toolbar?: React.ComponentType<ToolbarProps<TEvent, TResource>> | undefined;
     agenda?: {
-        date?: React.ComponentType;
-        time?: React.ComponentType;
-        event?: React.ComponentType<EventProps<TEvent>>;
-    };
+        date?: React.ComponentType | undefined;
+        time?: React.ComponentType | undefined;
+        event?: React.ComponentType<EventProps<TEvent>> | undefined;
+    } | undefined;
     day?: {
-        header?: React.ComponentType<HeaderProps>;
-        event?: React.ComponentType<EventProps<TEvent>>;
-    };
+        header?: React.ComponentType<HeaderProps> | undefined;
+        event?: React.ComponentType<EventProps<TEvent>> | undefined;
+    } | undefined;
     week?: {
-        header?: React.ComponentType<HeaderProps>;
-        event?: React.ComponentType<EventProps<TEvent>>;
-    };
+        header?: React.ComponentType<HeaderProps> | undefined;
+        event?: React.ComponentType<EventProps<TEvent>> | undefined;
+    } | undefined;
     work_week?: {
-      header?: React.ComponentType<HeaderProps>;
-      event?: React.ComponentType<EventProps<TEvent>>;
-    };
+      header?: React.ComponentType<HeaderProps> | undefined;
+      event?: React.ComponentType<EventProps<TEvent>> | undefined;
+    } | undefined;
     month?: {
-        header?: React.ComponentType;
-        dateHeader?: React.ComponentType;
-        event?: React.ComponentType<EventProps<TEvent>>;
-    };
+        header?: React.ComponentType | undefined;
+        dateHeader?: React.ComponentType | undefined;
+        event?: React.ComponentType<EventProps<TEvent>> | undefined;
+    } | undefined;
     /**
      * component used as a header for each column in the TimeGridHeader
      */
-    header?: React.ComponentType<HeaderProps>;
-    resourceHeader?: React.ComponentType<ResourceHeaderProps>;
+    header?: React.ComponentType<HeaderProps> | undefined;
+    resourceHeader?: React.ComponentType<ResourceHeaderProps> | undefined;
 }
@@ -236,3 +236,3 @@
     onView: (view: View) => void;
-    children?: React.ReactNode;
+    children?: React.ReactNode | undefined;
 }
@@ -247,3 +247,3 @@
     // https://github.com/intljusticemission/react-big-calendar/blob/27a2656b40ac8729634d24376dff8ea781a66d50/src/TimeGridEvent.js#L28
-    style?: React.CSSProperties & { xOffset: number };
+    style?: React.CSSProperties & { xOffset: number } | undefined;
     className: string;
@@ -253,5 +253,5 @@ event: TEvent;
     getters: {
-        eventProp?: EventPropGetter<TEvent>;
-        slotProp?: SlotPropGetter;
-        dayProp?: DayPropGetter;
+        eventProp?: EventPropGetter<TEvent> | undefined;
+        slotProp?: SlotPropGetter | undefined;
+        dayProp?: DayPropGetter | undefined;
     };
@@ -261,6 +261,6 @@ onClick: (e: React.MouseEvent<HTMLElement>) => void;
     accessors: {
-        title?: (event: TEvent) => string;
-        tooltip?: (event: TEvent) => string;
-        end?: (event: TEvent) => Date;
-        start?: (event: TEvent) => Date;
+        title?: ((event: TEvent) => string) | undefined;
+        tooltip?: ((event: TEvent) => string) | undefined;
+        end?: ((event: TEvent) => Date) | undefined;
+        start?: ((event: TEvent) => Date) | undefined;
     };
@@ -274,18 +274,18 @@ selected: boolean;
 export interface Messages {
-    date?: string;
-    time?: string;
-    event?: string;
-    allDay?: string;
-    week?: string;
-    work_week?: string;
-    day?: string;
-    month?: string;
-    previous?: string;
-    next?: string;
-    yesterday?: string;
-    tomorrow?: string;
-    today?: string;
-    agenda?: string;
-    showMore?: (count: number) => string;
-    noEventsInRange?: string;
+    date?: string | undefined;
+    time?: string | undefined;
+    event?: string | undefined;
+    allDay?: string | undefined;
+    week?: string | undefined;
+    work_week?: string | undefined;
+    day?: string | undefined;
+    month?: string | undefined;
+    previous?: string | undefined;
+    next?: string | undefined;
+    yesterday?: string | undefined;
+    tomorrow?: string | undefined;
+    today?: string | undefined;
+    agenda?: string | undefined;
+    showMore?: ((count: number) => string) | undefined;
+    noEventsInRange?: string | undefined;
 }
@@ -307,3 +307,3 @@
     formats: Formats;
-    propType?: Validator<any>;
+    propType?: Validator<any> | undefined;
 }
@@ -325,59 +325,59 @@
 
-    date?: stringOrDate;
-    getNow?: () => Date;
-    view?: View;
-    events?: TEvent[];
-    backgroundEvents?: TEvent[];
-    handleDragStart?: (event: TEvent) => void;
-    onNavigate?: (newDate: Date, view: View, action: NavigateAction) => void;
-    onView?: (view: View) => void;
-    onDrillDown?: (date: Date, view: View) => void;
-    onSelectSlot?: (slotInfo: SlotInfo) => void;
-    onDoubleClickEvent?: (event: TEvent, e: React.SyntheticEvent<HTMLElement>) => void;
-    onSelectEvent?: (event: TEvent, e: React.SyntheticEvent<HTMLElement>) => void;
-    onKeyPressEvent?: (event: TEvent, e: React.SyntheticEvent<HTMLElement>) => void;
-    onSelecting?: (range: { start: stringOrDate; end: stringOrDate }) => boolean | undefined | null;
-    onRangeChange?: (range: Date[] | { start: stringOrDate; end: stringOrDate }, view: View | undefined) => void;
-    showAllEvents?: boolean;
+    date?: stringOrDate | undefined;
+    getNow?: (() => Date) | undefined;
+    view?: View | undefined;
+    events?: TEvent[] | undefined;
+    backgroundEvents?: TEvent[] | undefined;
+    handleDragStart?: ((event: TEvent) => void) | undefined;
+    onNavigate?: ((newDate: Date, view: View, action: NavigateAction) => void) | undefined;
+    onView?: ((view: View) => void) | undefined;
+    onDrillDown?: ((date: Date, view: View) => void) | undefined;
+    onSelectSlot?: ((slotInfo: SlotInfo) => void) | undefined;
+    onDoubleClickEvent?: ((event: TEvent, e: React.SyntheticEvent<HTMLElement>) => void) | undefined;
+    onSelectEvent?: ((event: TEvent, e: React.SyntheticEvent<HTMLElement>) => void) | undefined;
+    onKeyPressEvent?: ((event: TEvent, e: React.SyntheticEvent<HTMLElement>) => void) | undefined;
+    onSelecting?: ((range: { start: stringOrDate; end: stringOrDate }) => boolean | undefined | null) | undefined;
+    onRangeChange?: ((range: Date[] | { start: stringOrDate; end: stringOrDate }, view: View | undefined) => void) | undefined;
+    showAllEvents?: boolean | undefined;
     selected?: any;
-    views?: ViewsProps<TEvent, TResource>;
-    drilldownView?: View | null;
-    getDrilldownView?: ((targetDate: Date, currentViewName: View, configuredViewNames: View[]) => void) | null;
-    length?: number;
-    toolbar?: boolean;
-    popup?: boolean;
-    popupOffset?: number | { x: number; y: number };
-    selectable?: boolean | 'ignoreEvents';
-    longPressThreshold?: number;
-    step?: number;
-    timeslots?: number;
-    rtl?: boolean;
-    eventPropGetter?: EventPropGetter<TEvent>;
-    slotPropGetter?: SlotPropGetter;
-    slotGroupPropGetter?: SlotGroupPropGetter;
-    dayPropGetter?: DayPropGetter;
-    showMultiDayTimes?: boolean;
-    min?: stringOrDate;
-    max?: stringOrDate;
-    scrollToTime?: Date;
-    culture?: string;
-    formats?: Formats;
-    components?: Components<TEvent, TResource>;
-    messages?: Messages;
-    dayLayoutAlgorithm?: DayLayoutAlgorithm | DayLayoutFunction<TEvent>;
-    titleAccessor?: keyof TEvent | ((event: TEvent) => string);
-    tooltipAccessor?: keyof TEvent | ((event: TEvent) => string);
-    allDayAccessor?: keyof TEvent | ((event: TEvent) => boolean);
-    startAccessor?: keyof TEvent | ((event: TEvent) => Date);
-    endAccessor?: keyof TEvent | ((event: TEvent) => Date);
-    resourceAccessor?: keyof TEvent | ((event: TEvent) => any);
-    resources?: TResource[];
-    resourceIdAccessor?: keyof TResource | ((resource: TResource) => any);
-    resourceTitleAccessor?: keyof TResource | ((resource: TResource) => any);
-    defaultView?: View;
-    defaultDate?: Date;
-    className?: string;
-    elementProps?: React.HTMLAttributes<HTMLElement>;
-    style?: React.CSSProperties;
-    onShowMore?: (events: TEvent[], date: Date) => void;
+    views?: ViewsProps<TEvent, TResource> | undefined;
+    drilldownView?: View | null | undefined;
+    getDrilldownView?: ((targetDate: Date, currentViewName: View, configuredViewNames: View[]) => void) | null | undefined;
+    length?: number | undefined;
+    toolbar?: boolean | undefined;
+    popup?: boolean | undefined;
+    popupOffset?: number | { x: number; y: number } | undefined;
+    selectable?: boolean | 'ignoreEvents' | undefined;
+    longPressThreshold?: number | undefined;
+    step?: number | undefined;
+    timeslots?: number | undefined;
+    rtl?: boolean | undefined;
+    eventPropGetter?: EventPropGetter<TEvent> | undefined;
+    slotPropGetter?: SlotPropGetter | undefined;
+    slotGroupPropGetter?: SlotGroupPropGetter | undefined;
+    dayPropGetter?: DayPropGetter | undefined;
+    showMultiDayTimes?: boolean | undefined;
+    min?: stringOrDate | undefined;
+    max?: stringOrDate | undefined;
+    scrollToTime?: Date | undefined;
+    culture?: string | undefined;
+    formats?: Formats | undefined;
+    components?: Components<TEvent, TResource> | undefined;
+    messages?: Messages | undefined;
+    dayLayoutAlgorithm?: DayLayoutAlgorithm | DayLayoutFunction<TEvent> | undefined;
+    titleAccessor?: keyof TEvent | ((event: TEvent) => string) | undefined;
+    tooltipAccessor?: keyof TEvent | ((event: TEvent) => string) | undefined;
+    allDayAccessor?: keyof TEvent | ((event: TEvent) => boolean) | undefined;
+    startAccessor?: keyof TEvent | ((event: TEvent) => Date) | undefined;
+    endAccessor?: keyof TEvent | ((event: TEvent) => Date) | undefined;
+    resourceAccessor?: keyof TEvent | ((event: TEvent) => any) | undefined;
+    resources?: TResource[] | undefined;
+    resourceIdAccessor?: keyof TResource | ((resource: TResource) => any) | undefined;
+    resourceTitleAccessor?: keyof TResource | ((resource: TResource) => any) | undefined;
+    defaultView?: View | undefined;
+    defaultDate?: Date | undefined;
+    className?: string | undefined;
+    elementProps?: React.HTMLAttributes<HTMLElement> | undefined;
+    style?: React.CSSProperties | undefined;
+    onShowMore?: ((events: TEvent[], date: Date) => void) | undefined;
 }
@@ -387,3 +387,3 @@
     formats: DateFormat[];
-    culture?: string;
+    culture?: string | undefined;
     [propName: string]: any;
@@ -432,24 +432,24 @@ }
     eventOffset: number;
-    events?: TEvent[];
-    backgroundEvents?: TEvent[];
-    resources?: TResource[];
-    step?: number;
-    timeslots?: number;
-    range?: any[];
-    min?: stringOrDate;
-    max?: stringOrDate;
-    getNow?: () => Date;
-    scrollToTime?: Date;
-    showMultiDayTimes?: boolean;
-    rtl?: boolean;
-    width?: number;
-    accessors?: object;
-    components?: object;
-    getters?: object;
-    localizer?: object;
-    selected?: object;
-    selectable?: boolean | 'ignoreEvents';
-    longPressThreshold?: number;
-    onNavigate?: (action: NavigateAction) => void;
-    onSelectSlot?: (slotInfo: {
+    events?: TEvent[] | undefined;
+    backgroundEvents?: TEvent[] | undefined;
+    resources?: TResource[] | undefined;
+    step?: number | undefined;
+    timeslots?: number | undefined;
+    range?: any[] | undefined;
+    min?: stringOrDate | undefined;
+    max?: stringOrDate | undefined;
+    getNow?: (() => Date) | undefined;
+    scrollToTime?: Date | undefined;
+    showMultiDayTimes?: boolean | undefined;
+    rtl?: boolean | undefined;
+    width?: number | undefined;
+    accessors?: object | undefined;
+    components?: object | undefined;
+    getters?: object | undefined;
+    localizer?: object | undefined;
+    selected?: object | undefined;
+    selectable?: boolean | 'ignoreEvents' | undefined;
+    longPressThreshold?: number | undefined;
+    onNavigate?: ((action: NavigateAction) => void) | undefined;
+    onSelectSlot?: ((slotInfo: {
         start: stringOrDate;
@@ -459,10 +459,10 @@ end: stringOrDate;
         action: 'select' | 'click' | 'doubleClick';
-    }) => void;
-    onSelectEnd?: (...args: any[]) => any;
-    onSelectStart?: (...args: any[]) => any;
-    onSelectEvent?: (event: TEvent, e: React.SyntheticEvent<HTMLElement>) => void;
-    onDoubleClickEvent?: (event: TEvent, e: React.SyntheticEvent<HTMLElement>) => void;
-    onKeyPressEvent?: (...args: any[]) => any;
-    onDrillDown?: (date: Date, view: View) => void;
-    getDrilldownView?: ((targetDate: Date, currentViewName: View, configuredViewNames: View[]) => void) | null;
+    }) => void) | undefined;
+    onSelectEnd?: ((...args: any[]) => any) | undefined;
+    onSelectStart?: ((...args: any[]) => any) | undefined;
+    onSelectEvent?: ((event: TEvent, e: React.SyntheticEvent<HTMLElement>) => void) | undefined;
+    onDoubleClickEvent?: ((event: TEvent, e: React.SyntheticEvent<HTMLElement>) => void) | undefined;
+    onKeyPressEvent?: ((...args: any[]) => any) | undefined;
+    onDrillDown?: ((date: Date, view: View) => void) | undefined;
+    getDrilldownView?: ((targetDate: Date, currentViewName: View, configuredViewNames: View[]) => void) | null | undefined;
     dayLayoutAlgorithm?: any;
@@ -469,0 +469,0 @@ }

react-big-calendar/lib/addons/dragAndDrop.d.ts

@@ -5,15 +5,15 @@ import { Calendar, CalendarProps, Components, Event, stringOrDate } from '../../index';
 export interface withDragAndDropProps<TEvent extends object = Event, TResource extends object = object> {
-  onEventDrop?: (args: { event: TEvent, start: stringOrDate, end: stringOrDate, isAllDay: boolean }) => void;
-  onEventResize?: (args: { event: TEvent, start: stringOrDate, end: stringOrDate, isAllDay: boolean }) => void;
-  onDragStart?: (args: { event: TEvent, action: 'resize' | 'move', direction: 'UP' | 'DOWN' | 'LEFT' | 'RIGHT' }) => void;
-  onDragOver?: (event: React.DragEvent) => void;
-  onDropFromOutside?: (args: { start: stringOrDate, end: stringOrDate, allDay: boolean}) => void;
-  dragFromOutsideItem?: () => keyof TEvent | ((event: TEvent) => Date);
-  draggableAccessor?: keyof TEvent | ((event: TEvent) => boolean);
-  resizableAccessor?: keyof TEvent | ((event: TEvent) => boolean);
-  selectable?: true | false | 'ignoreEvents';
-  resizable?: boolean;
-  components?: Components<TEvent, TResource>;
-  elementProps?: React.HTMLAttributes<HTMLElement>;
-  step?: number;
+  onEventDrop?: ((args: { event: TEvent, start: stringOrDate, end: stringOrDate, isAllDay: boolean }) => void) | undefined;
+  onEventResize?: ((args: { event: TEvent, start: stringOrDate, end: stringOrDate, isAllDay: boolean }) => void) | undefined;
+  onDragStart?: ((args: { event: TEvent, action: 'resize' | 'move', direction: 'UP' | 'DOWN' | 'LEFT' | 'RIGHT' }) => void) | undefined;
+  onDragOver?: ((event: React.DragEvent) => void) | undefined;
+  onDropFromOutside?: ((args: { start: stringOrDate, end: stringOrDate, allDay: boolean}) => void) | undefined;
+  dragFromOutsideItem?: (() => keyof TEvent | ((event: TEvent) => Date)) | undefined;
+  draggableAccessor?: keyof TEvent | ((event: TEvent) => boolean) | undefined;
+  resizableAccessor?: keyof TEvent | ((event: TEvent) => boolean) | undefined;
+  selectable?: true | false | 'ignoreEvents' | undefined;
+  resizable?: boolean | undefined;
+  components?: Components<TEvent, TResource> | undefined;
+  elementProps?: React.HTMLAttributes<HTMLElement> | undefined;
+  step?: number | undefined;
 }
@@ -20,0 +20,0 @@

react-big-calendar/package.json

 {
     "name": "@types/react-big-calendar",
-    "version": "0.31.4",
+    "version": "0.31.5",
     "description": "TypeScript definitions for react-big-calendar",
@@ -111,4 +111,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-big-calendar",
     },
-    "typesPublisherContentHash": "ea923e9b7fd53fd095f63b30b64565382e32eb24a441febe6c38350504e408e2",
+    "typesPublisherContentHash": "3cfc2f379f2ff2d2644fdd833b7a0065e277dcc365bbedcd2b3cd108f553cb71",
     "typeScriptVersion": "3.6"
 }

react-big-calendar/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Mon, 05 Jul 2021 09:01:19 GMT
+ * Last updated: Wed, 07 Jul 2021 17:02:55 GMT
  * Dependencies: [@types/prop-types](https://npmjs.com/package/@types/prop-types), [@types/react](https://npmjs.com/package/@types/react)
@@ -14,0 +14,0 @@ * Global values: none

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26347

increased by9.06%

No dependency changes