Yeoman generator will present you with the wizard by asking questions about the solution to be created.
Solution Name
Hit enter to have a default name (spfx-crud-reactjs in this case) or type in any other name for your solution.
Selected choice - Hit enter
Target for component
Here, we can select the target environment where we are planning to deploy the client web part; i.e., SharePoint Online or SharePoint OnPremise (SharePoint 2016 onwards).
Selected choice - SharePoint Online only (latest)
Place of files
We may choose to use the same folder or create a subfolder for our solution.
Selected choice - Same folder
Deployment option
Selecting Y will allow the app to be deployed instantly to all sites and will be accessible everywhere.
Selected choice - N (install on each site explicitly)
Type of client-side component to create
We can choose to create a client-side web part or an extension. Choose web part option.
Selected choice - WebPart
Web part name
Hit enter to select the default name or type in any other name.
Selected choice - ReactCRUD
Web part description
Hit enter to select the default description or type in any other value.
Selected choice - CRUD operations with React JS
Framework to use
Select any JavaScript framework to develop the component. Available choices are (No JavaScript Framework, React, and Knockout)
Selected choice - React
Yeoman generator will perform a scaffolding process to generate the solution. The scaffolding process will take a significant amount of time.
Once the scaffolding process is completed, lock down the version of project dependencies by running the below command
In the command prompt type the below command to open the solution in the code editor of your choice.
Configure Property for List Name
SPFx solution by default has description property created. Let us change the property to list name. We will use this property to configure the list name on which the CRUD operation is to perform.
Step 1
Open mystrings.d.ts under "\src\webparts\reactCrud\loc\" folder
Step 2
Rename DescriptionFieldLabel to ListNameFieldLabel
- declare interface IReactCrudWebPartStrings {
- PropertyPaneDescription: string;
- BasicGroupName: string;
- ListNameFieldLabel: string;
- }
-
- declare module 'ReactCrudWebPartStrings' {
- const strings: IReactCrudWebPartStrings;
- export = strings;
- }
Step 3
In en-us.js file under "\src\webparts\reactCrud \loc\" folder set the display name for listName property
- define([], function() {
- return {
- "PropertyPaneDescription": "Description",
- "BasicGroupName": "Group Name",
- "ListNameFieldLabel": "List Name"
- }
- });
Step 4
In the interface IReactCrudProps.ts under "\src\webparts\reactCrud\components\", set the member name to listName
- export interface IReactCrudProps {
- listName: string;
- }
Step 5
Open the main webpart file (ReactCrudWebPart.ts) under "\src\webparts\reactCrud" folder.
Step 6
Rename description property pane field to listName
- export interface IReactCrudWebPartProps {
- listName: string;
- }
-
- export default class ReactCrudWebPart extends BaseClientSideWebPart<IReactCrudWebPartProps> {
-
- public render(): void {
- const element: React.ReactElement<IReactCrudProps > = React.createElement(
- ReactCrud,
- {
- listName: this.properties.listName,
- spHttpClient: this.context.spHttpClient,
- siteUrl: this.context.pageContext.web.absoluteUrl
- }
- );
-
- ReactDom.render(element, this.domElement);
- }
-
- protected onDispose(): void {
- ReactDom.unmountComponentAtNode(this.domElement);
- }
-
- protected get dataVersion(): Version {
- return Version.parse('1.0');
- }
-
- protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
- return {
- pages: [
- {
- header: {
- description: strings.PropertyPaneDescription
- },
- groups: [
- {
- groupName: strings.BasicGroupName,
- groupFields: [
- PropertyPaneTextField('listName', {
- label: strings.ListNameFieldLabel
- })
- ]
- }
- ]
- }
- ]
- };
- }
- }
Step 7
The UI in React gets served from component ReactCrud.tsx under "\src\webparts\reactCrud\components\ReactCrud.tsx". Make the changes for listName property in the component.
- import * as React from 'react';
- import styles from './ReactCrud.module.scss';
- import { IReactCrudProps } from './IReactCrudProps';
- import { escape } from '@microsoft/sp-lodash-subset';
-
- export default class ReactCrud extends React.Component<IReactCrudProps, {}> {
- public render(): React.ReactElement<IReactCrudProps> {
- return (
- <div className={ styles.reactCrud }>
- <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.listName)}</p>
- <a href="https://aka.ms/spfx" class="${ styles.button }">
- <span class="${ styles.label }">Learn more</span>
- </a>
- </div>
- </div>
- </div>
- </div>
- );
- }
- }
Step 8
In the command prompt, type “gulp serve”
Step 9
In the SharePoint local workbench page, add the web part.
Step 10
Edit the web part to ensure the listName property pane field is getting reflected.
Model for List Item
Step 1
Add a class (IListItem.ts) representing the list item.
React JS acts on the state change. Let us add a state to our solution.