QR Code Generator in the SharePoint Framework (SPFx) web part

This article provides steps to implement the QR Code Generator in the SharePoint Framework (SPFx) web part, generally, QR Code Generator is a simple and convenient tool that help you create QR Code image displayed on the screen. Several content types are supported, include Text, Url, Email, Phone number, Contact, Geolocation and SMS.

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 --save qrcode

In the react component properties interface file, replace below properties  

export interface ISpfxQrcodeProps {
  qrcontent: string;
  qrcodedata: string;
}

In the client-side web part class file, import the QRCode and the modify the client-side web part properties, property pane configuration and render functions are modified according to get and set QR code values, please refer below code.  

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 'SpfxQrcodeWebPartStrings';
import SpfxQrcode from './components/SpfxQrcode';
import { ISpfxQrcodeProps } from './components/ISpfxQrcodeProps';
import QRCode from 'qrcode'

export interface ISpfxQrcodeWebPartProps {
  qrcontent: string;
}

export default class SpfxQrcodeWebPart extends BaseClientSideWebPart<ISpfxQrcodeWebPartProps> {

  public render(): void {
    QRCode.toDataURL(this.properties.qrcontent)
      .then(url => {
        const element: React.ReactElement<ISpfxQrcodeProps> = React.createElement(
          SpfxQrcode,
          {
            qrcontent: this.properties.qrcontent,
            qrcodedata: url
          }
        );
        ReactDom.render(element, this.domElement);
      })
      .catch(err => {
        console.error(err)
      })
  }

  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('qrcontent', {
                  label: 'Code content'
                })
              ]
            }
          ]
        }
      ]
    };
  }
}

In the react component just replace the default render function to blow render function we just add the image to display the code  

import * as React from 'react';
import styles from './SpfxQrcode.module.scss';
import { ISpfxQrcodeProps } from './ISpfxQrcodeProps';

export default class SpfxQrcode extends React.Component<ISpfxQrcodeProps, {}> {
  public render(): React.ReactElement<ISpfxQrcodeProps> {
    return (
      <div className={styles.spfxQrcode}>
        <img className={styles.img} src={this.props.qrcodedata} alt={this.props.qrcontent} />
        <small>{this.props.qrcontent}</small>
      </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.

For your reference, this complete project added in to the GitHub

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