Selecting Fluent UI Icons using PnP IconPicker control in the SharePoint Framework (SPFx) web part

This article provide steps to implement the Selecting Fluent UI Icons using PnP IconPicker control in the SharePoint Framework (SPFx) web part, generally icon is an image that represents an application, a capability, or some other concept or specific entity with meaning for the user.

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/spfx-controls-react --save --save-exact

Configure the custom properties

Create a new source code file under the src\webparts\<web part name>\components\ folder of the solution. Call the new file I<web part name>State.ts and use it to create a TypeScript Interface

export interface ISpfxPnpIconpickerState {
  icon: string;
}

Update the <web part name>.tsx file. First, add some import statements to import the types you defined earlier. Notice the import for I<web part name>Props and I<web part name>State. 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 './SpfxPnpIconpicker.module.scss';
import { ISpfxPnpIconpickerProps } from './ISpfxPnpIconpickerProps';
import { IconPicker } from '@pnp/spfx-controls-react/lib/IconPicker';
import { Icon } from 'office-ui-fabric-react/lib/Icon';
import { Stack, IStackTokens } from 'office-ui-fabric-react';
import { mergeStyles } from 'office-ui-fabric-react/lib/Styling';

Replace this render function with the following code.

  public render(): React.ReactElement<ISpfxPnpIconpickerProps> {
    return (
      <div className={styles.spfxPnpIconpicker}>
        <Stack horizontal wrap tokens={stackTokens}>
          <Icon iconName={this.state.icon} className={iconClass} />
          <IconPicker buttonLabel={'Icon'}
            onChange={(iconName: string) => { this.setState({ icon: iconName }); }}
            onSave={(iconName: string) => { this.setState({ icon: iconName }); }} />
        </Stack>
      </div>
    );
  }

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

export default class SpfxPnpIconpicker extends React.Component<ISpfxPnpIconpickerProps, ISpfxPnpIconpickerState> {
  constructor(props: ISpfxPnpIconpickerProps, state: ISpfxPnpIconpickerState) {
    super(props);
    this.state = ({ icon: '' });
  }

Add below const next to the react import

const iconClass = mergeStyles({
  fontSize: 50,
  height: 50,
  width: 50,
  margin: '0 25px',
});

const stackTokens: IStackTokens = { childrenGap: 40 };

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

Fluent UI Tooltip inside the PnP Listview in SPFx

This article provides steps to implement the Fluent UI Tooltip inside the PnP Listview in the SharePoint Framework (SPFx) webpart, generally Fluent UI Tooltip is a wrapper that automatically shows a tooltip when the wrapped element is hovered or focused. 

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
npm install moment --save

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\<Webpart name>\components\ folder of the solution. Create the new file I<web part name>State.ts and use it to create a TypeScript Interface

import { IViewField } from "@pnp/spfx-controls-react/lib/ListView";
export interface ISpfxFluentuiTooltipState {
  items: any[];
  viewFields: IViewField[];
}

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<ISpfxFluentuiTooltipProps> = React.createElement(
      SpfxFluentuiTooltip,
      {
        description: this.properties.description,
        context:this.context
      }
    );
    ReactDom.render(element, this.domElement);
  }

Update the tsx file under the components. First, add some import statements to import the types you defined earlier. Notice the import for I<web part name>Props and I<web part name>State. 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 * as moment from 'moment';
import styles from './SpfxFluentuiTooltip.module.scss';
import { ISpfxFluentuiTooltipProps } from './ISpfxFluentuiTooltipProps';
import { ISpfxFluentuiTooltipState } from './ISpfxFluentuiTooltipState';
import { ListView, IViewField, SelectionMode } from "@pnp/spfx-controls-react/lib/ListView";
import { autobind } from 'office-ui-fabric-react/lib/Utilities';
import { sp } from "@pnp/sp";
import "@pnp/sp/webs";
import "@pnp/sp/files";
import "@pnp/sp/folders";
import {
  TooltipHost,
  TooltipDelay,
  DirectionalHint,
  ITooltipProps,
  ITooltipHostStyles,
} from 'office-ui-fabric-react/lib/Tooltip';

Replace this render function with the following code.

  public render(): React.ReactElement<ISpfxFluentuiTooltipProps> {
    return (
      <div className={styles.spfxFluentuiTooltip}>
        <ListView
          items={this.state.items}
          viewFields={this.state.viewFields}
          iconFieldName="ServerRelativeUrl"
          compact={true}
          selectionMode={SelectionMode.multiple}
          showFilter={true}
          filterPlaceHolder="Search..." />
      </div>
    );
  }

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

export default class SpfxFluentuiTooltip extends React.Component<ISpfxFluentuiTooltipProps, ISpfxFluentuiTooltipState> {
  constructor(props: ISpfxFluentuiTooltipProps, state: ISpfxFluentuiTooltipState) {
    super(props);
    sp.setup({
      spfxContext: this.props.context
    });
    var _viewFields: IViewField[] = [
      {
        name: "Name",
        displayName: "Name",
        sorting: false,
        minWidth: 200,
        render: (item: any) => {
          let tooltipProps: ITooltipProps = {
            onRenderContent: () => (
              <ul style={{ margin: 10, padding: 0 }}>
                <li><b>Description</b></li>
                <li>{item['ListItemAllFields.Description0']}</li>
              </ul>
            ),
          };

          return <TooltipHost
            tooltipProps={tooltipProps}
            delay={TooltipDelay.zero}
            id={'tooltipId' + item['ID']}
            directionalHint={DirectionalHint.rightCenter}
            styles={hostStyles}
          ><a href={item['ServerRelativeUrl']}>{item['Name']}</a></TooltipHost>;
        }
      },
      {
        name: "Author.Title",
        displayName: "Author",
        sorting: false,
        minWidth: 200,
        render: (item: any) => {
          const authoremail = item['Author.UserPrincipalName'];
          return <a href={'mailto:' + authoremail}>{item['Author.Title']}</a>;
        }
      },
      {
        name: "TimeCreated",
        displayName: "Created",
        minWidth: 150,
        render: (item: any) => {
          const created = item["TimeCreated"];
          if (created) {
            const createdDate = moment(created);
            return <span>{createdDate.format('DD/MM/YYYY HH:mm:ss')}</span>;
          }
        }
      }
    ];
    this.state = { items: [], viewFields: _viewFields };
    this._getfiles();
  }

place the below code inside the react component code, these functions using PnPjs to get files from the SharePoint document library

 @autobind
  private async _getfiles() {
    const allItems: any[] = await sp.web.getFolderByServerRelativeUrl("/sites/TheLanding/Policies").files.select().expand("ListItemAllFields,Author,Description").get();
    this.setState({ items: allItems });
  }

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

Gathering collection of data in property page using PnP PropertyFieldCollectionData control in SPFx

This article provides steps to Gathering collection of data in property page using PnP PropertyFieldCollectionData control in the SharePoint Framework (SPFx) web part, This property field control gives you the ability to insert a list/collection data which can be used in your web part.

The control allows you to specify multiple data types like string, number, boolean, or dropdown.

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/spfx-property-controls --save

Client side web part class

In the client side web part class file we have to import the PnP component library and have to add one new property in web part property interface for our PropertyFieldCollectionData control then pass the values into our react component.

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 'SpfxPnpPropertyfieldcollectiondataWebPartStrings';
import SpfxPnpPropertyfieldcollectiondata from './components/SpfxPnpPropertyfieldcollectiondata';
import { ISpfxPnpPropertyfieldcollectiondataProps } from './components/ISpfxPnpPropertyfieldcollectiondataProps';

import { PropertyFieldCollectionData, CustomCollectionFieldType } from '@pnp/spfx-property-controls/lib/PropertyFieldCollectionData';


export interface ISpfxPnpPropertyfieldcollectiondataWebPartProps {
  description: string;
  collectionData: any[];
}

export default class SpfxPnpPropertyfieldcollectiondataWebPart extends BaseClientSideWebPart<ISpfxPnpPropertyfieldcollectiondataWebPartProps> {

  public render(): void {
    const element: React.ReactElement<ISpfxPnpPropertyfieldcollectiondataProps> = React.createElement(
      SpfxPnpPropertyfieldcollectiondata,
      {
        description: this.properties.description,
        listinformation: this.properties.collectionData
      }
    );

    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
                }),
                PropertyFieldCollectionData("collectionData", {
                  key: "collectionData",
                  label: "Links",
                  panelHeader: "links",
                  manageBtnLabel: "Manage links",
                  value: this.properties.collectionData,
                  fields: [
                    {
                      id: "LinkName",
                      title: "Name",
                      type: CustomCollectionFieldType.string,
                      required: true
                    },
                    {
                      id: "URL",
                      title: "URL",
                      type: CustomCollectionFieldType.string
                    },
                    {
                      id: "Openinnewtab",
                      title: "Open in new tab",
                      type: CustomCollectionFieldType.boolean
                    }
                  ],
                  disabled: false
                })
              ]
            }
          ]
        }
      ]
    };
  }
}

React Component Class

In the react component class file we have to do very simple changes, have to import link control and use it with the props values

import * as React from 'react';
import styles from './SpfxPnpPropertyfieldcollectiondata.module.scss';
import { ISpfxPnpPropertyfieldcollectiondataProps } from './ISpfxPnpPropertyfieldcollectiondataProps';
import { Link } from 'office-ui-fabric-react/lib/Link';

export default class SpfxPnpPropertyfieldcollectiondata extends React.Component<ISpfxPnpPropertyfieldcollectiondataProps, {}> {
  public render(): React.ReactElement<ISpfxPnpPropertyfieldcollectiondataProps> {
    return (
      <div className={styles.spfxPnpPropertyfieldcollectiondata}>
        <h2>{this.props.description}</h2>
        {this.props.listinformation &&
          <ul>
            {this.props.listinformation.map(function (linkinfo, i) {
              return <li><Link target={linkinfo.Openinnewtab ? '_blank' : '_self'} href={linkinfo.URL}>{linkinfo.LinkName}</Link></li>
            })}
          </ul>
        }
      </div>
    );
  }
}

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