Fluent UI Teaching Bubble in SPFx

This article provides steps to implement the Fluent UI Teaching Bubble in the SharePoint Framework (SPFx) web part, generally, TeachingBubbles are a special kind of Callout used to prominently display important hints to a specific part of a page. They should be used to educate the user about an element that may be easy to miss, such as a new feature or option in the UI. Because they increase engagement with a part of the UI, they are often paired with Coachmarks.

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

React functional component

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 for some other controls. teaching bubble moves around by hiding and show bubbles

import * as React from 'react';
import { useState } from 'react';
import styles from './SpfxFluentuiTeachingbubble.module.scss';
import { ISpfxFluentuiTeachingbubbleProps } from './ISpfxFluentuiTeachingbubbleProps';
import { DefaultButton, IButtonProps } from 'office-ui-fabric-react/lib/Button';
import { ChoiceGroup, IChoiceGroupOption } from 'office-ui-fabric-react/lib/ChoiceGroup';
import { TeachingBubble } from 'office-ui-fabric-react/lib/TeachingBubble';

function SpfxFluentuiTeachingbubble(props: ISpfxFluentuiTeachingbubbleProps) {
  const localvalue = localStorage.getItem('694bd607-18b6-4c53-b085-fdc985c8963e')
  const [bubble1, setBubble1] = useState(true)
  // const [bubble1, setBubble1] = useState(localvalue == 'done' ? false : true)
  const [bubble2, setBubble2] = useState(false)
  const [bubble3, setBubble3] = useState(false)

  const options: IChoiceGroupOption[] = [
    { key: 'day', text: 'Day', iconProps: { iconName: 'CalendarDay' } },
    { key: 'week', text: 'Week', iconProps: { iconName: 'CalendarWeek' } },
    { key: 'month', text: 'Month', iconProps: { iconName: 'Calendar' }, disabled: true },
  ];

  const options2: IChoiceGroupOption[] = [
    {
      key: 'bar',
      imageAlt: 'Bar chart icon',
      text: 'Clustered bar chart',
      iconProps:{iconName:'StackedColumnChart2Fill'}
    },
    {
      key: 'pie',
      iconProps:{iconName:'PieDouble'},
      imageSize: { width: 32, height: 32 },
      text: 'Pie chart',
    },
  ];
  

  const dontshowmeagain = () => {
    localStorage.setItem('694bd607-18b6-4c53-b085-fdc985c8963e', 'done')
  }

  const bubble1Next: IButtonProps = React.useMemo(
    () => ({
      children: 'Next',
      onClick: () => { setBubble2(true); setBubble1(false) },
    }),
    [setBubble2, setBubble1],
  );

  const bubble1Dontshowagain: IButtonProps = React.useMemo(
    () => ({
      children: 'Close',
      onClick: () => { setBubble1(false), dontshowmeagain() },
    }),
    [setBubble1, dontshowmeagain],
  );

  const bubble2Previous: IButtonProps = React.useMemo(
    () => ({
      children: 'Previous',
      onClick: () => { setBubble1(true); setBubble2(false) },
    }),
    [setBubble2, setBubble1],
  );

  const bubble2Next: IButtonProps = React.useMemo(
    () => ({
      children: 'Next',
      onClick: () => { setBubble2(false); setBubble3(true) },
    }),
    [setBubble2, setBubble3],
  );

  const bubble3Previous: IButtonProps = React.useMemo(
    () => ({
      children: 'Previous',
      onClick: () => { setBubble2(true); setBubble3(false) },
    }),
    [setBubble2, setBubble3],
  );

  const bubble3Close: IButtonProps = React.useMemo(
    () => ({
      children: 'Close',
      onClick: () => { setBubble3(false), dontshowmeagain() },
    }),
    [setBubble3, dontshowmeagain],
  );
  return (
    <div className={styles.spfxFluentuiTeachingbubble}>
      <DefaultButton id={'targetButton'} href="http://bing.com" target="_blank" title="let us bing!" >
        Bing
      </DefaultButton>
      <br />
      <br />
      <ChoiceGroup width="300px" id={'targetChoice'} label="Pick one icon" defaultSelectedKey="day" options={options} />
      <br />
      <br />
      <ChoiceGroup id={'targetChoice2'} label="Pick one image" defaultSelectedKey="bar" options={options2} />;

      {bubble1 && (
        <TeachingBubble
          target="#targetButton"
          primaryButtonProps={bubble1Next}
          secondaryButtonProps={bubble1Dontshowagain}
          footerContent="1 of 3"
          headline="Discover what’s trending around you">
          Lorem ipsum dolor sit amet, consectetur adipisicing elit. Facere, nulla, ipsum? Molestiae quis aliquam magni
          harum non?
        </TeachingBubble>
      )}
      {bubble2 && (
        <TeachingBubble
          target="#targetChoice"
          primaryButtonProps={bubble2Next}
          secondaryButtonProps={bubble2Previous}
          footerContent="2 of 3"
          headline="Discover what’s trending around you">
          Lorem ipsum dolor sit amet, consectetur adipisicing elit. Facere, nulla, ipsum? Molestiae quis aliquam magni
          harum non?
        </TeachingBubble>
      )}
      {bubble3 && (
        <TeachingBubble
          target="#targetChoice2"
          primaryButtonProps={bubble3Close}
          secondaryButtonProps={bubble3Previous}
          footerContent="3 of 3"
          headline="Discover what’s trending around you">
          Lorem ipsum dolor sit amet, consectetur adipisicing elit. Facere, nulla, ipsum? Molestiae quis aliquam magni
          harum non?
        </TeachingBubble>
      )}
    </div>
  );
}

export default SpfxFluentuiTeachingbubble;

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.