Text to speech in SharePoint Framework (SPFx) web part

This article provides steps to implement the Text to speech feature in the SharePoint Framework (SPFx) web part

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 speak-tts

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

export interface ISpfxTexttospeakState {
  textcontent : String;
}

React Component

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 styles from './SpfxTexttospeak.module.scss';
import { ISpfxTexttospeakProps } from './ISpfxTexttospeakProps';
import { ISpfxTexttospeakState } from './ISpfxTexttospeakState';
import Speech from 'speak-tts'
import { TextField, DefaultButton, Stack, IStackTokens } from 'office-ui-fabric-react/lib';

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

export default class SpfxTexttospeak extends React.Component<ISpfxTexttospeakProps, ISpfxTexttospeakState> {
  private speech: Speech;
  constructor(props: ISpfxTexttospeakProps, state: ISpfxTexttospeakState) {
    super(props);
    this.state = {
      textcontent: ''
    };
    
    this.speech = new Speech();
    this.speech
      .init({
        volume: 1,
        lang: 'en-GB',
        rate: 1,
        pitch: 1,
        'voice': 'Google UK English Male',
        //'splitSentences': false,
        listeners: {
          onvoiceschanged: voices => {
            console.log("Voices changed", voices);
          }
        }
      })
      .then(data => {
        console.log("Speech is ready", data);
      })
      .catch(e => {
        console.log("An error occured while initializing : ", e);
      });
  }

Replace this render function with the following code.

 public render(): React.ReactElement<ISpfxTexttospeakProps> {
    return (
      <div className={styles.spfxTexttospeak}>
        <TextField rows={10} label="Text content" multiline autoAdjustHeight onChange={(e, newval) => this.setState({ textcontent: newval })} />
        <br />
        <Stack horizontal tokens={sectionStackTokens}>
          <DefaultButton
            text={'Play'}
            allowDisabledFocus onClick={this.onclickPlay} />
          <DefaultButton
            text={'Stop'}
            allowDisabledFocus onClick={this.onclickStop} />
        </Stack>
      </div>
    );
  }

Add below functions are inside the react component class

  private onclickStop = (): void => {
    this.speech.cancel();
  };

  private onclickPlay = (): void => {
    this.speech.speak({
      text: this.state.textcontent,
      queue: false,
      listeners: {
        onstart: () => {
          console.log("Start utterance");
        },
        onend: () => {
          console.log("End utterance");
        },
        onresume: () => {
          console.log("Resume utterance");

        },
        onboundary: event => {
          console.log(
            event.name +
            " boundary reached after " +
            event.elapsedTime +
            " milliseconds."
          );
        }
      }
    })
      .then(data => {
        console.log("Success !", data);
      })
      .catch(e => {
        console.error("An error occurred :", e);
      });
  }

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

A Complete Guide to Getting and Setting Fields Value using PnP JS in SPFx

This article provides the complete Guide to Getting and Setting Fields value using PnP JS in SharePoint Framework (SPFx).

Install the library and required dependencies

npm install @pnp/sp --save

For PnP js selective import, refer PnP js site. I just imported below

import { sp } from "@pnp/sp";
import "@pnp/sp/webs";
import "@pnp/sp/lists";
import "@pnp/sp/items";
import "@pnp/sp/site-users/web";
import { ISiteUserProps } from "@pnp/sp/site-users/";
import "@pnp/sp/fields";

Get a list item

const list = sp.web.lists.getByTitle("GetSet");
const item: any = await list.items.getById(1).get();

Single line of text

//get value
let textvalue: string = item["Title"];
//set value 
const i = await list.items.getById(1).update({
  Title: textvalue
});

Multiple lines of text (Plain text)

//get value
let multipleLineTextValue: string = item["MultipleLinesText"];
//set value 
const i = await list.items.getById(1).update({
  MultipleLinesText: multipleLineTextValue
});

Multiple lines of text (Enhanced rich text)

//get value
let multipleLineHTMLValue: string = item["MultipleLinesHTML"];
//set value 
const i = await list.items.getById(1).update({
  MultipleLinesHTML: multipleLineHTMLValue
});

Choice (single selection)

//get value
let singleChoice: string = item["Location"];
//set value 
const i = await list.items.getById(1).update({
  Location: singleChoice
});

Choice (multiple selections)

//get value
let multiChoice: string[] = item["Locations"];
//set value 
const i = await list.items.getById(1).update({
  Locations: { results: multiChoice }
});

Number

//get value
let numvervalue: number = item["Quantity"];
//set value 
const i = await list.items.getById(1).update({
  Quantity: numvervalue
});

Currency

//get value
let currencyvalue: number = item["Cost"];
//set value 
const i = await list.items.getById(1).update({
  Cost: currencyvalue
});

Date and Time

//get value
let datevalue: Date = item["BirthDay"];
//set value 
const i = await list.items.getById(1).update({
  BirthDay: datevalue
});

Lookup (single selection)

PnP always only return id value, also we get the value from different field name, Example <Field Internal Name> + ‘Id’. So “Id” is always added in the suffix of your filed internal name

//get value
let lookupvalue: number = item["ColorId"];
//set value 
const i = await list.items.getById(1).update({
  ColorId: lookupvalue
});

Lookup (multiple selection)

//get value
let lookupvalues: number[] = item["ColorsId"];
//set value 
const i = await list.items.getById(1).update({
  ColorsId: { results: lookupvalues }
});

Yes/No

//get value
let yesnovalue: boolean = item["IsActive"];
//set value 
const i = await list.items.getById(1).update({
  IsActive: yesnovalue
});

Person or Group (single selection)

PnP always only return id value, also we get the value from different field name, Example <Field Internal Name> + ‘Id’. So “Id” is always added in the suffix of your filed internal name

//get value
let uservalue: number = item["OwnerId"];
const user: ISiteUserProps = await sp.web.getUserById(uservalue).get();
console.log(user.LoginName)
//set value 
const i = await list.items.getById(1).update({
  OwnerId: uservalue
});
//FYI...
//import { ISiteUserProps } from "@pnp/sp/site-users/";

Person or Group (multiple selection)

//get value
let usersvalue: number[] = item["OwnersId"];
//set value 
const i = await list.items.getById(1).update({
  OwnersId: { results: usersvalue }
});

Hyperlink or Picture

//get value
let linkvalue: object = item["Reference"];
const Description = linkvalue["Description"];
const Url = linkvalue["Url"];
//set value 
const i = await list.items.getById(1).update({
  Reference: {
    "__metadata": { type: "SP.FieldUrlValue" },
    Description: Description,
    Url: Url
  }
});

Managed Metadata (single selection)

//get value
let tagvalue: any = item["Tag"];
//set value 
const i = await list.items.getById(1).update({
  Tag: {
    "__metadata": { "type": "SP.Taxonomy.TaxonomyFieldValue" },
    "Label": tagvalue.Label,
    'TermGuid': tagvalue.TermGuid,
    'WssId': '-1'
  }
});

Managed Metadata (multiple selection)

//get value
let tagsvalue: any = item["Tags"];
let tagsString: string = '';
tagsvalue.forEach(function (v, i) {
  tagsString += `${v.Label}|${v.TermGuid};`;
})
//set value 
const i = await list.items.getById(1).validateUpdateListItem([{
  ErrorMessage: null,
  FieldName: "Tags",
  FieldValue: tagsString,
  HasException: false
}]);

Code can be view in the GitHub

Sharing is caring!

If you have any questions, feel free to let me know in the comments section.
Happy coding!!!

Material-UI in SPFx

This article provides steps to implement the basic input form using Material-UI in the SharePoint Framework (SPFx) web part, generally, Material-UI is the react components for faster and easier web development. Build your own design system, or can start with Material Design.

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 @material-ui/core

Import the library into your application, update constructor, and access the root sp object in render for PnPjs libraries.

sp.setup({spfxContext: this.props.context});

Web part base class

Pass the context to the react component

  public render(): void {
    const element: React.ReactElement<ISpfxReactMaterialuiProps> = React.createElement(
      SpfxReactMaterialui,
      {
        description: this.properties.description
      }
    );
    ReactDom.render(element, this.domElement);
  }

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

export interface ISpfxReactMaterialuiState {
  firstname: string;
  lastname: string;
  premiumplan:boolean;
  age: number;
  gender:string;
  isAgreed:boolean;
}

React Component

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 styles from './SpfxReactMaterialui.module.scss';
import { ISpfxReactMaterialuiProps } from './ISpfxReactMaterialuiProps';
import { ISpfxReactMaterialuiState } from './ISpfxReactMaterialuiState';
import Button from '@material-ui/core/Button';
import TextField from '@material-ui/core/TextField';
import Switch from '@material-ui/core/Switch';
import Select from '@material-ui/core/Select';
import FormControl from '@material-ui/core/FormControl';
import Radio from '@material-ui/core/Radio';
import RadioGroup from '@material-ui/core/RadioGroup';
import FormControlLabel from '@material-ui/core/FormControlLabel';
import FormLabel from '@material-ui/core/FormLabel';
import Checkbox from '@material-ui/core/Checkbox';
import InputLabel from '@material-ui/core/InputLabel';
import { sp } from "@pnp/sp";
import "@pnp/sp/webs";
import "@pnp/sp/lists";
import "@pnp/sp/items";
import { IItemAddResult } from "@pnp/sp/items";
import { autobind } from 'office-ui-fabric-react';

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

export default class SpfxReactMaterialui extends React.Component<ISpfxReactMaterialuiProps, ISpfxReactMaterialuiState> {
  constructor(props: ISpfxReactMaterialuiProps, state: ISpfxReactMaterialuiState) {
    super(props);
    this.state = ({ age: 0, firstname: '', gender: '', isAgreed: false, lastname: '', premiumplan: false })
  }

Replace this render function with the following code.

 public render(): React.ReactElement<ISpfxReactMaterialuiProps> {
    return (
      <div className={styles.spfxReactMaterialui}>
        <FormControl variant={"outlined"}>
          <TextField style={{ width: '400px' }} id="outlined-basic" onChange={(event: React.ChangeEvent<HTMLInputElement>) => { this.setState({ firstname: event.target.value }) }} label="First name" variant="outlined" />
        </FormControl>
        <br />
        <br />
        <FormControl variant={"outlined"}>
          <TextField style={{ width: '400px' }} id="outlined-basic1" onChange={(event: React.ChangeEvent<HTMLInputElement>) => { this.setState({ lastname: event.target.value }) }} label="Last name" variant="outlined" />
        </FormControl>
        <br />
        <br />
        <FormControl variant={"outlined"}>
          <FormLabel component="legend">Premium plan</FormLabel>
          <Switch color="primary" onChange={(event: React.ChangeEvent<HTMLInputElement>) => { this.setState({ premiumplan: event.target.checked }) }} name="checkedB" inputProps={{ 'aria-label': 'primary checkbox' }} />
        </FormControl>
        <br />
        <br />
        <FormControl variant={"outlined"}>
          <InputLabel id="demo-simple-select-outlined-label">Age</InputLabel>
          <Select style={{ width: '400px' }}
            labelId="demo-simple-select-outlined-label"
            id="demo-simple-select-outlined"
            onChange={(event: React.ChangeEvent<HTMLInputElement>) => { this.setState({ age: parseInt(event.target.value) }) }}
            label="Age"
            inputProps={{
              name: 'age',
              id: 'outlined-age-native-simple',
            }}
          >
            <option aria-label="None" value="" />
            <option value={10}>Ten</option>
            <option value={20}>Twenty</option>
            <option value={30}>Thirty</option>
          </Select>
        </FormControl>
        <br />
        <br />
        <FormLabel component="legend">Gender</FormLabel>
        <RadioGroup row aria-label="position" name="position" defaultValue="top"
          onChange={(event: React.ChangeEvent<HTMLInputElement>) => { this.setState({ gender: event.target.value }) }}>
          <FormControlLabel value="female" control={<Radio color="primary" />} label="female" />
          <FormControlLabel value="male" control={<Radio color="primary" />} label="male" />
          <FormControlLabel value="other" control={<Radio color="primary" />} label="other" />
        </RadioGroup>
        <br />
        <FormControlLabel
          control={
            <Checkbox
              name="checkedB" color="primary"
              onChange={(event: React.ChangeEvent<HTMLInputElement>) => { this.setState({ isAgreed: event.target.checked }) }}></Checkbox>
          }
          label="I agree to all the terms and conditions"
        />
        <br />
        <br />
        <Button variant="contained" disabled={!this.state.isAgreed} color="primary" onClick={this.saveinfo}>Save</Button>
      </div>
    );
  }

Add below functions are inside the react component calss

  @autobind
  private async saveinfo() {
    const iar: IItemAddResult = await sp.web.lists.getByTitle("People").items.add({
      Title: this.state.firstname,
      LastName: this.state.lastname,
      Premiumplan: this.state.premiumplan,
      Age: this.state.age,
      Gender: this.state.gender
    });
  }

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