SharePoint Online / SPFx

PnP DateTimePicker in the SharePoint Framework (SPFx) webpart

Ravichandran Krishnasamy4 Comments

This article provide steps to implement the dynamic PnP Date Time Picker in the SharePoint Framework (SPFx), generally Date Time Picker control allows you to select dates from a calendar and optionally the time of day using dropdown controls. You can configure the control to use 12 or 24-hour clock.

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 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.

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/sp --save
npm install @pnp/spfx-controls-react --save --save-exact

Import the library into your application, update constructor, and access the root sp object in render for PnPjs libraries.

sp.setup({spfxContext: this.props.spcontect});

Configure the custom properties

Create a new source code file under the src\webparts\spfxPnpDatetimepicker\components\ folder of the solution. Call the new file ISpfxPnpDatetimepickerState.ts and use it to create a TypeScript Interface

export interface ISpfxPnpDatetimepickerState {
  StartDateTime: Date;
  DueDate: Date;
  SuccessMessage:string;
}

In addition, you need to update the render method of the client-side web part to create a properly configured instance of the React component for rendering. The following code shows the updated method definition.

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

Update the SpfxPnpDatetimepicker.tsx file. First, add some import statements to import the types you defined earlier. Notice the import for ISpfxPnpDatetimepickerProps and ISpfxPnpDatetimepickerState. There are also some imports for the PnP components used to render the UI of the PnP React component and pnp sp imports.

import * as React from 'react';
import styles from './SpfxPnpDatetimepicker.module.scss';
import { ISpfxPnpDatetimepickerProps } from './ISpfxPnpDatetimepickerProps';
import { ISpfxPnpDatetimepickerState } from './ISpfxPnpDatetimepickerState';
import { sp } from "@pnp/sp";
import { DateTimePicker, DateConvention, TimeConvention, TimeDisplayControlType } from '@pnp/spfx-controls-react/lib/dateTimePicker';
import { autobind } from 'office-ui-fabric-react/lib/Utilities';
import "@pnp/sp/webs";
import "@pnp/sp/lists";
import "@pnp/sp/items";

Replace this render function with the following code.

  public render(): React.ReactElement<ISpfxPnpDatetimepickerProps> {
    return (
      <div className={styles.spfxPnpDatetimepicker}>
        {this.state.StartDateTime ?
          <div>
            <DateTimePicker label="Start date and time"
              dateConvention={DateConvention.DateTime}
              timeConvention={TimeConvention.Hours12}
              timeDisplayControlType={TimeDisplayControlType.Dropdown}
              formatDate={(date: Date) => date.toLocaleDateString()}
              showLabels={false}
              value={this.state.StartDateTime}
              onChange={(date: Date) => this.setState({ StartDateTime: date })}
            />
            <label className={styles.label}>Selected value: {this.state.StartDateTime.toString()}</label>
          </div>
          : null
        }
        <DateTimePicker label="Due date"
          dateConvention={DateConvention.Date}
          formatDate={(date: Date) => date.toLocaleDateString()}
          showLabels={false}
          value={this.state.DueDate}
          onChange={(date: Date) => this.setState({ DueDate: date })}
        />
        <label className={styles.label}>Selected value: {this.state.DueDate.toString()}</label>
        <br></br><br></br>
        <button className={styles.button} onClick={this.saveIntoSharePoint}>Save</button>
        <br></br>
        <br></br>
        <label className={styles.label}>{this.state.SuccessMessage}</label>
      </div>
    );
  }

Update the React component type declaration and add a constructor, as shown in the following example.

export default class SpfxPnpDatetimepicker extends React.Component<ISpfxPnpDatetimepickerProps, ISpfxPnpDatetimepickerState> {
  constructor(props: ISpfxPnpDatetimepickerProps, state: ISpfxPnpDatetimepickerState) {
    super(props);
    sp.setup({
      spfxContext: this.props.context
    });
    this.state = {
      StartDateTime: null,
      DueDate: new Date(),
      SuccessMessage: ''
    }
    this._getValues();
  }

place the below code inside the react component code, these functions using PnPjs to get date from the SharePoint Document list and save the values as well

  @autobind
  private async _getValues() {
    const item: any = await sp.web.lists.getByTitle("ActionInfo").items.getById(1).get();
    this.setState({
      StartDateTime: new Date(item.StartDateTime),
      DueDate: new Date(item.DueDate)
    });
  }

 @autobind
  private async saveIntoSharePoint() {
    const updatedItem = await sp.web.lists.getByTitle("ActionInfo").items.getById(1).update({
      StartDateTime: this.state.StartDateTime,
      DueDate: this.state.DueDate
    });
    this.setState({ SuccessMessage: 'Successfully saved' });
  }

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!!!

4 thoughts on “PnP DateTimePicker in the SharePoint Framework (SPFx) webpart”

  1. Hi,
    May I know how to set value of DateTime control from SharePoint List. I’m following this article & I can set the date value but for Time (Hours & Minutes) it’s taking systems Hours & Minutes. Can you help me here?

    Thanks,
    Sanjay

    Like

    Reply

  2. Ravichandran, do you have an example of being successful in setting the time as well as date based on values from a SharePoint online list? It seems to ignore the time values.

    Like

    Reply

Comments