Merge branch 'ravichandran-blog-v2-dev' into v2-dev

Author: AJIXuMuK

docs/documentation/docs/controls/DynamicForm.md

@@ -8,7 +8,7 @@ This control can dynamically generate SharePoint list or SharePoint document lib
 - Import the following modules to your component:
 
 ```TypeScript
-import { DynamicForm } from "fx-controls-react/lib/DynamicForm";
+import { DynamicForm } from "@pnp/spfx-controls-react/lib/DynamicForm";
 ```
 
 - Use the DynamicForm control in your code as follows:
@@ -38,6 +38,7 @@ The `DynamicForm` can be configured with the following properties:
 | contentTypeId | string | no | content type ID |
 | disabled | boolean | no | Option allow to be enable or disable. Default value is `false`|
 | onBeforeSubmit | (listItemData: any) => Promise<boolean> | no | Before submit handler. Allows to modify the object to be submitted or cancel the submission. |
-| onSubmitted | (listItem: any) => void | no | Method that returns listItem data JSON object. |
+| onSubmitted | (listItemData: any, listItem?: IItem) => void | no | Method that returns listItem data JSON object and PnPJS list item instance (`IItem`). |
 | onSubmitError | (listItemData: any, error: Error) => void | no | Handler of submission error. |
 | onCancelled | () => void | no | Handler when form has been cancelled. |
+| returnListItemInstanceOnSubmit | boolean | no | Specifies if `onSubmitted` event should pass PnPJS list item (`IItem`) as a second parameter. Default - `true` |

src/controls/dynamicForm/DynamicForm.tsx

@@ -189,7 +189,7 @@ export class DynamicForm extends React.Component<IDynamicFormProps, IDynamicForm
         try {
           const iur = await sp.web.lists.getById(listId).items.getById(listItemId).update(objects);
           if (onSubmitted) {
-            onSubmitted(iur.data);
+            onSubmitted(iur.data, this.props.returnListItemInstanceOnSubmit !== false ? iur.item : undefined);
           }
         }
         catch (error) {
@@ -204,7 +204,7 @@ export class DynamicForm extends React.Component<IDynamicFormProps, IDynamicForm
         try {
           const iar = await sp.web.lists.getById(listId).items.add(objects);
           if (onSubmitted) {
-            onSubmitted(iar.data);
+            onSubmitted(iar.data, this.props.returnListItemInstanceOnSubmit !== false ? iar.item : undefined);
           }
         }
         catch (error) {

src/controls/dynamicForm/IDynamicFormProps.ts

@@ -1,5 +1,6 @@
 import { ExtensionContext } from '@microsoft/sp-extension-base';
 import { WebPartContext } from '@microsoft/sp-webpart-base';
+import { IItem } from '@pnp/sp/items';
 
 export interface IDynamicFormProps {
   /**
@@ -22,7 +23,7 @@ export interface IDynamicFormProps {
   /**
    * Handler for form submitted event
    */
-  onSubmitted?: (listItemData: any) => void;
+  onSubmitted?: (listItemData: any, listItem?: IItem) => void;
   /**
    * Handler of submission error
    */
@@ -39,6 +40,12 @@ export interface IDynamicFormProps {
    * Content type id of the item
    */
   contentTypeId?: string;
+
+  /**
+   * Specifies if onSubmitted event should pass PnPJS list item (IItem) as a second parameter. Default - true
+   */
+  returnListItemInstanceOnSubmit?: boolean;
+
   /**
  * Used to execute WebSearch. If not provided SearchTab will not be available.
  */