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.