Confetti in SPFx

This article provides steps to implement the Confetti in the SharePoint Framework (SPFx) web part, generally beautiful when we show some seconds after the user filled the long-form,

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 i react-confetti

Update the react component

Import the Confetti in the src\webparts\spfxReactConfetti\components\SpfxReactConfetti.tsx file and call the Confetti tag to execute,

import * as React from 'react';
import styles from './SpfxReactConfetti.module.scss';
import { ISpfxReactConfettiProps } from './ISpfxReactConfettiProps';
import { escape } from '@microsoft/sp-lodash-subset';
import Confetti from 'react-confetti'
import { PrimaryButton, Stack, IStackTokens } from 'office-ui-fabric-react';

const stackTokens: IStackTokens = { childrenGap: 40 };

export interface ISpfxReactConfettiState {
  showConfetti: boolean;
}

export default class SpfxReactConfetti extends React.Component<ISpfxReactConfettiProps, ISpfxReactConfettiState> {
  constructor(props: ISpfxReactConfettiProps, state: ISpfxReactConfettiState) {
    super(props);
    this.state = ({ showConfetti: true });
  }
  public render(): React.ReactElement<ISpfxReactConfettiProps> {
    return (
      <div className={styles.spfxReactConfetti}>
        {this.state.showConfetti == true ?
          <Confetti
            width={750}
            height={200}
          />
          : ''
        }
        <div className={styles.container}>
          <div className={styles.row}>
            <div className={styles.column}>
              <span className={styles.title}>Welcome to SharePoint!</span>
              <p className={styles.subTitle}>Customize SharePoint experiences using Web Parts.</p>
              <p className={styles.description}>{escape(this.props.description)}</p>
              <Stack horizontal tokens={stackTokens}>
                <a href="https://aka.ms/spfx" className={styles.button}>
                  <span className={styles.label}>Learn more</span>
                </a>
                <PrimaryButton text="Stop Confetti" onClick={() => this.setState({ showConfetti: false })} />
              </Stack>
            </div>
          </div>
        </div>
      </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.