Bing Spell Check in SPFx

This article provides steps to implement the spell check functionality using Azure Cognitive Services of Bing Spell Check in the SharePoint Framework (SPFx) web part, this is very useful feature also you can get this service free if your usage is less, if you want to know the more details please this Bing Spell Check page

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 .

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 ISpfxAzureBingspellcheckState {
  content: string;
  processedcontnet: 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 './SpfxAzureBingspellcheck.module.scss';
import { ISpfxAzureBingspellcheckProps } from './ISpfxAzureBingspellcheckProps';
import { ISpfxAzureBingspellcheckState } from './ISpfxAzureBingspellcheckState';
import { Stack, IStackProps, IStackStyles } from 'office-ui-fabric-react/lib/Stack';
import { TextField } from 'office-ui-fabric-react/lib/TextField';
import { PrimaryButton } from 'office-ui-fabric-react/lib/Button';
import { autobind } from 'office-ui-fabric-react/lib/Utilities';

next to the imports, added some stack properties

const stackStyles: Partial<IStackStyles> = { root: { width: 650 } };
const stackTokens = { childrenGap: 50 };
const columnProps: Partial<IStackProps> = {
  tokens: { childrenGap: 15 },
  styles: { root: { width: 300 } },
};
const smallcolumnProps: Partial<IStackProps> = {
  tokens: { childrenGap: 15 },
  styles: { root: { width: 180 } },
};

Replace this render function with the following code.

  public render(): React.ReactElement<ISpfxAzureBingspellcheckProps> {
    return (
      <div className={styles.spfxAzureBingspellcheck}>
        <Stack horizontal tokens={stackTokens} styles={stackStyles}>
          <Stack {...columnProps}>
            <TextField label="Original" multiline autoAdjustHeight onChanged={(newtext) => this.setState({ content: newtext })} />
          </Stack>
          <Stack {...smallcolumnProps}>
            <PrimaryButton className={styles.button} text="Check spell >>" onClick={this._processClicked} />
          </Stack>
          <Stack {...columnProps}>
            <TextField label="Result" value={this.state.processedcontnet} multiline autoAdjustHeight />
          </Stack>
        </Stack>
      </div >
    );
  }

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

export default class SpfxAzureBingspellcheck extends React.Component<ISpfxAzureBingspellcheckProps, ISpfxAzureBingspellcheckState> {
  constructor(props: ISpfxAzureBingspellcheckProps, state: ISpfxAzureBingspellcheckState) {
    super(props);
    this.state = ({ content: '', processedcontnet: '' });
  }

Add below function inside the react component to access and get the result from Azure Cognitive Bing Spell Check Services

  @autobind
  private _processClicked(): void {
    this.getSpellcheckedContent();
  }
  @autobind
  private async getSpellcheckedContent() {
    let text = this.state.content;
    if (text !== '') {
      let response = await fetch('https://api.cognitive.microsoft.com/bing/v7.0/spellcheck?text=' + text + '&mkt=en-US&mode=spell', {
        method: 'POST',
        headers: {
          'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
          'Ocp-Apim-Subscription-Key': '<ENTER-KEY-HERE>',
          'Content-Length': (text.length + 5) + ''
        },
        body: ''
      });
      let jresponse = await response.json();
      console.log(jresponse)
      jresponse.flaggedTokens.forEach(word => {
        text = text.replace(word.token, word.suggestions[0].suggestion);
      });
      this.setState({ processedcontnet: text })
    }
  }

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

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