Send and receive values between two SPFx webparts

This article provide steps to send and receive values between two webparts in the SharePoint Framework (SPFx), we achieving this using @microsoft/sp-dynamic-data, using the dynamic data capability, you can connect SharePoint Framework client-side web parts and extensions to each other and exchange information between the components. This allows you to build rich experiences and compelling end-user solutions.

Create a new web part project

Open power shell and run following comment to create a new web part by running the Yeoman SharePoint Generator

yo @microsoft/sharepoint

When prompted:

Enter the webpart name as your solution name, and then select Enter.
Select Create a subfolder with solution name for where to place the files.
Select Y to allow the solution to be deployed to all sites immediately.
Select N on the question if solution contains unique permissions.
Select WebPart as the client-side component type to be created.

The next set of prompts ask for specific information about your web part:

Enter your first web part name, and then select Enter.
Enter your web part description, and then select Enter.
Select React framework as the framework you would like to use, and then select Enter.

Once everything is done, run the “yo @microsoft/sharepoint” again and create another web part. so we can use one to send another for receiving the property values.

Start Visual Studio Code (or your favorite code editor) within the context of the newly created project folder.

cd .\web part name\
code .

Install the library and required dependencies

npm install @pnp/spfx-controls-react --save --save-exact

We have used pnp list view picker control

Sender web part

This web part emits the property values, mainly we implement the IDynamicDataCallables on the BaseClientSideWebPart. check below code for more details.

import * as React from 'react';
import * as ReactDom from 'react-dom';
import { Version } from '@microsoft/sp-core-library';
import {
  IPropertyPaneConfiguration,
  PropertyPaneTextField
} from '@microsoft/sp-property-pane';
import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base';
import * as strings from 'SpfxSendWebPartStrings';
import SpfxSend from './components/SpfxSend';
import { ISpfxSendProps } from './components/ISpfxSendProps';
import { IDynamicDataPropertyDefinition, IDynamicDataCallables } from '@microsoft/sp-dynamic-data';

export interface IList {
  selectedlist: string;
}

export interface ISpfxSendWebPartProps {
  description: string;
}

export default class SpfxSendWebPart extends BaseClientSideWebPart<ISpfxSendWebPartProps> implements IDynamicDataCallables {

  private _selectedlist: IList;
  protected onInit(): Promise<void> {
    this.context.dynamicDataSourceManager.initializeSource(this);
    return Promise.resolve();
  }

  public getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition> {
    return [
      {
        id: 'selectedlist',
        title: 'selectedlist'
      }
    ];
  }

  private _listelected = (list: IList): void => {
    this._selectedlist = list;
    this.context.dynamicDataSourceManager.notifyPropertyChanged('selectedlist');
  }

  public getPropertyValue(propertyId: string): IList {
    return this._selectedlist;
  }

  public render(): void {
    const element: React.ReactElement<ISpfxSendProps> = React.createElement(
      SpfxSend,
      {
        title: this.properties.description,
        context: this.context,
        _listelected: this._listelected
      }
    );
    ReactDom.render(element, this.domElement);
  }

  protected onDispose(): void {
    ReactDom.unmountComponentAtNode(this.domElement);
  }

  protected get dataVersion(): Version {
    return Version.parse('1.0');
  }

  protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
    return {
      pages: [
        {
          header: {
            description: strings.PropertyPaneDescription
          },
          groups: [
            {
              groupName: strings.BasicGroupName,
              groupFields: [
                PropertyPaneTextField('description', {
                  label: strings.DescriptionFieldLabel
                })
              ]
            }
          ]
        }
      ]
    };
  }
}

Receiver web part

In this web part, we have to connect the sender web part and select the property to receive, the received value will be available in the web part property, so we can access the value in the props on the react component

import * as React from 'react';
import * as ReactDom from 'react-dom';
import { Version } from '@microsoft/sp-core-library';
import {
  IPropertyPaneConfiguration,
  PropertyPaneTextField,
  PropertyPaneDynamicFieldSet,
  PropertyPaneDynamicField,
  DynamicDataSharedDepth,
  IPropertyPaneConditionalGroup
} from '@microsoft/sp-property-pane';
import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base';
import * as strings from 'SpfxReceiveWebPartStrings';
import SpfxReceive from './components/SpfxReceive';
import { ISpfxReceiveProps } from './components/ISpfxReceiveProps';
import { DynamicProperty } from '@microsoft/sp-component-base';
import { IWebPartPropertiesMetadata } from '@microsoft/sp-webpart-base';

export interface ISpfxReceiveWebPartProps {
  description: string;
  selectedlist: DynamicProperty<string>;
}

export default class SpfxReceiveWebPart extends BaseClientSideWebPart<ISpfxReceiveWebPartProps> {
  public render(): void {
    const selectedlist: string | undefined = this.properties.selectedlist.tryGetValue();
    const element: React.ReactElement<ISpfxReceiveProps> = React.createElement(
      SpfxReceive,
      {
        title: this.properties.description,
        selectedlist:selectedlist
      }
    );
    ReactDom.render(element, this.domElement);
  }

  protected get propertiesMetadata(): IWebPartPropertiesMetadata {
    return {
      'selectedlist': {
        dynamicPropertyType: 'string'
      }
    };
  }

  protected onDispose(): void {
    ReactDom.unmountComponentAtNode(this.domElement);
  }

  protected get dataVersion(): Version {
    return Version.parse('1.0');
  }

  protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
    return {
      pages: [
        {
          groups: [
            {
              primaryGroup: {
                groupName: "PrimaryGroup",
                groupFields: [
                  PropertyPaneTextField('description', {
                    label: strings.DescriptionFieldLabel
                  })
                ]
              },
              secondaryGroup: {
                groupName: "SecondaryGroup",
                groupFields: [
                  PropertyPaneDynamicFieldSet({
                    label: 'selectedlist',
                    fields: [
                      PropertyPaneDynamicField('selectedlist', {
                        label: ""
                      })
                    ],
                    sharedConfiguration: {
                      depth: DynamicDataSharedDepth.Property
                    }
                  })
                ]
              },
              showSecondaryGroup: !!this.properties.selectedlist.tryGetSource()
            } as IPropertyPaneConditionalGroup
          ]
        }
      ]
    };
  }
}

Deploy the solution

You’re now ready to build, bundle, package, and deploy the solution.

Run the gulp commands to verify that the solution builds correctly.

gulp build

Use the following command to bundle and package the solution.

gulp bundle --ship
gulp package-solution --ship

Browse to the app catalog of your target tenant and upload the solution package. You can find the solution package under the sharepoint/solution folder of your solution. It is the .sppkg file. After you upload the solution package in the app catalog. you can find and the web part anywhere across the tenant.

Sharing is caring!

If you have any questions, feel free to let me know in the comments section.
Happy coding!!!

Comments

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s