@devexpress/dx-react-scheduler - npm Package Compare versions

Comparing version 2.0.3 to 2.0.4

dist/dx-react-scheduler.d.ts

@@ -67,2 +67,11 @@ // Dependencies for this module:
 
+/**
+  * A plugin that renders the Scheduler's edit menu.
+  * Should not be used with the `IntegratedEditing` plugin.
+  */
+export const EditRecurrenceMenu: React.ComponentType<EditRecurrenceMenuProps>;
+
+/** A plugin that allows implementing a editing calculation logic. */
+export const IntegratedEditing: React.ComponentType<IntegratedEditingProps>;
+
 export namespace ViewSwitcher {
@@ -500,22 +509,9 @@ /** Describes properties passed to a component that renders the scheduler root layout. */
 
-/** Describes uncommitted changes made to the scheduler data. */
-export interface ChangeSet {
-  /** An array of rows to be created. */
-  added?: {
-    [key: string]: object;
-  };
-  /** An associative array that stores changes made to existing data. Each array item specifies changes made to a row. The item's key specifies the associated row's ID. */
-  changed?: {
-    [key: string]: object;
-  };
-  /** An array of IDs representing rows to be deleted. */
-  deleted?: number | string;
-}
 export interface EditingStateProps {
-  /** The identifier of an appointment being edited. */
-  editingAppointmentId?: number | string;
-  /** The initial value of the editingAppointmentId property in uncontrolled mode. */
-  defaultEditingAppointmentId?: number | string;
-  /** Handles changes to the editingAppointmentId property value. */
-  onEditingAppointmentIdChange?: (editingAppointmentId: number | string) => void;
+  /** The data of an appointment being edited. */
+  editingAppointment?: Partial<AppointmentModel>;
+  /** The initial value of the editingAppointment property in uncontrolled mode. */
+  defaultEditingAppointment?: Partial<AppointmentModel>;
+  /** Handles changes to the editingAppointment property value. */
+  onEditingAppointmentChange?: (editingAppointment: Partial<AppointmentModel>) => void;
   /** A created but not committed appointment. */
@@ -541,2 +537,4 @@ addedAppointment?: object;
   onCommitChanges: (changes: ChangeSet) => void;
+  /** Handles commiting appointment changes. */
+  preCommitChanges?: PreCommitChangesFn;
 }
@@ -680,2 +678,66 @@
 
+export namespace EditRecurrenceMenu {
+  /** Properties passed to a component that renders the edit menu's layout. */
+  interface LayoutProps {
+    /** 'true' if the appointment is being deleted or 'false' if it is being edited. */
+    isDeleting: boolean;
+    /** A component that renders the OK and Cancel buttons. */
+    buttonComponent: React.ComponentType<EditRecurrenceMenu.ButtonProps>;
+    /** A function that closes the menu. */
+    handleClose: () => void;
+    /** A function that commits changes. */
+    commit: () => void;
+    /** A list of available editing operations. */
+    availableOperations: Array<any>;
+    /** A function that returns a message with the specified key. */
+    getMessage: (messageKey: string) => string;
+  }
+  /** Properties passed to a component that renders the overlay window. */
+  interface OverlayProps {
+    /** A React component instance or a DOM element that is used to position the window. */
+    target: React.RefObject<unknown>;
+    /** A flag that specifies whether the overlay window is visible. */
+    visible: boolean;
+    /** A function that is executed when the window is hidden. */
+    onHide: () => void;
+  }
+  /** Properties passed to a component that renders the OK and Cancel buttons. */
+  interface ButtonProps {
+    /** The button's text. */
+    title: string;
+    /** A function to execute when the button is clicked. */
+    onClick: () => void;
+  }
+  /** Localization Messages */
+  interface LocalizationMessages {
+    /** Text for the 'Current appointment' option. */
+    current?: string;
+    /** Text for the 'Current and following appointments' option. */
+    currentAndFollowing?: string;
+    /** Text for the 'All appointments' option. */
+    all?: string;
+    /** The menu's title that should be displayed when an appointment is being edited. */
+    menuEditingTitle?: string;
+    /** The menu's title that should be displayed when an appointment is being deleted. */
+    menuDeletingTitle?: string;
+    /** The Cancel button's text. */
+    cancelButton?: string;
+    /** The OK button's text. */
+    commitButton?: string;
+  }
+}
+export interface EditRecurrenceMenuProps {
+  /** A component that renders the edit menu's layout. */
+  layoutComponent: React.ComponentType<EditRecurrenceMenu.LayoutProps>;
+  /** A component that renders the overlay window. */
+  overlayComponent: React.ComponentType<EditRecurrenceMenu.OverlayProps>;
+  /** A component that renders the OK and Cancel buttons. */
+  buttonComponent: React.ComponentType<EditRecurrenceMenu.ButtonProps>;
+  /** An object that contains localized messages. */
+  messages?: EditRecurrenceMenu.LocalizationMessages;
+}
+
+export interface IntegratedEditingProps {
+}
+
 export namespace DragDropProvider {
@@ -882,2 +944,6 @@ /** Describes properties of the component that renders a container for the appointment being dragged. */
   id?: number | string;
+  /** Specifies the appointment recurrence rule. */
+  rRule?: string | undefined;
+  /** Specifies dates excluded from recurrence. */
+  exDate?: string | undefined;
   /** Any other properties. */
@@ -954,8 +1020,21 @@ [propertyName: string]: any;
 };
-export declare type Changes = {
-  change: AppointmentModel | {};
-};
+export declare type Changes = Partial<AppointmentModel>;
 export declare type EditAppointmentPayload = {
   appointmentId: AppointmentId;
 };
+export declare type RecurrenceEditType = 'all' | 'currentAndFollowing' | 'current';
+export declare type PreCommitChangesFn = (changes: Changes | null, appointmentData: Partial<AppointmentModel>, type: RecurrenceEditType) => ChangeSet;
+/** Describes uncommitted changes made to the scheduler data. */
+export interface ChangeSet {
+  /** An array of rows to be created. */
+  added?: {
+    [key: string]: any;
+  };
+  /** An associative array that stores changes made to existing data. Each array item specifies changes made to a row. The item's key specifies the associated row's ID. */
+  changed?: {
+    [key: string]: any;
+  };
+  /** An array of IDs representing rows to be deleted. */
+  deleted?: number | string;
+}
 
@@ -962,0 +1041,0 @@

package.json

 {
   "name": "@devexpress/dx-react-scheduler",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Composable plugin-based scheduler component for React",
@@ -53,7 +53,7 @@ "author": {
     "@babel/preset-react": "^7.0.0",
-    "@devexpress/dx-core": "2.0.3",
-    "@devexpress/dx-react-core": "2.0.3",
-    "@devexpress/dx-testing": "2.0.3",
+    "@devexpress/dx-core": "2.0.4",
+    "@devexpress/dx-react-core": "2.0.4",
+    "@devexpress/dx-testing": "2.0.4",
     "babel-core": "^7.0.0-bridge.0",
-    "babel-jest": "^24.8.0",
+    "babel-jest": "^24.9.0",
     "core-js": "^3.2.1",
@@ -63,19 +63,19 @@ "enzyme": "3.10.0",
     "enzyme-to-json": "^3.4.0",
-    "jest": "^24.8.0",
+    "jest": "^24.9.0",
     "react": "16.8.6",
     "react-dom": "16.8.6",
     "react-test-renderer": "^16.9.0",
-    "rollup": "^1.19.4",
-    "rollup-plugin-license": "^0.12.0",
+    "rollup": "^1.20.3",
+    "rollup-plugin-license": "^0.12.1",
     "ts-jest": "^24.0.2",
-    "tslint": "^5.18.0",
+    "tslint": "^5.19.0",
     "tslint-config-airbnb": "^5.11.1",
-    "typescript": "^3.5.3"
+    "typescript": "3.5.3"
   },
   "dependencies": {
-    "@devexpress/dx-scheduler-core": "2.0.3"
+    "@devexpress/dx-scheduler-core": "2.0.4"
   },
   "peerDependencies": {
-    "@devexpress/dx-core": "2.0.3",
-    "@devexpress/dx-react-core": "2.0.3",
+    "@devexpress/dx-core": "2.0.4",
+    "@devexpress/dx-react-core": "2.0.4",
     "moment": "^2.24.0",
@@ -85,3 +85,3 @@ "react": ">=16.8.6",
   },
-  "gitHead": "1790d3c1f2654a09c2fddba300d26bd713512301"
+  "gitHead": "7faeea645c9df41556a06e7a47e3e8662fc7228e"
 }

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

584262

increased by7.71%

Lines of code

4252

increased by9.28%

Dependency changes

• + Added@devexpress/dx-core@2.0.4(transitive)

• + Added@devexpress/dx-react-core@2.0.4(transitive)

• + Added@devexpress/dx-scheduler-core@2.0.4(transitive)

• - Removed@devexpress/dx-core@2.0.3(transitive)

• - Removed@devexpress/dx-react-core@2.0.3(transitive)

• - Removed@devexpress/dx-scheduler-core@2.0.3(transitive)

• Updated@devexpress/dx-scheduler-core@2.0.4