Tag: FluentUI

Azure Translator in SPFx

Ravichandran Krishnasamy2 Comments

This article provides steps to implement the Azure translation in the SharePoint Framework (SPFx) web part, generally, Azure translate is translating text in real-time across more than 60 languages, powered by the latest innovations in machine translation. Support a wide range of use cases, such as translation for call centers, multilingual conversational agents, or in-app communication.

You can create a free trial to access this Azure Cognitive Services, click this link to navigate and check more details about this translate service

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 jquery

Update the react component

Import the npm translate module in the src\webparts\spfxAzureTranslator\components\SpfxAzureTranslator.tsx also, you have to get the Azure API secret key from Azure to use this service.

import * as React from 'react';
import styles from './SpfxAzureTranslator.module.scss';
import { ISpfxAzureTranslatorProps } from './ISpfxAzureTranslatorProps';
import { ISpfxAzureTranslatorState } from './ISpfxAzureTranslatorState';
import { Stack, IStackProps, IStackStyles } from 'office-ui-fabric-react/lib/Stack';
import { TextField } from 'office-ui-fabric-react/lib/TextField';
import { IDropdownOption, Dropdown } from 'office-ui-fabric-react';
import $ from "jquery";


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 } },
};

export default class SpfxAzureTranslator extends React.Component<ISpfxAzureTranslatorProps, ISpfxAzureTranslatorState> {
  constructor(props: ISpfxAzureTranslatorProps, state: ISpfxAzureTranslatorState) {
    super(props);
    this.state = ({ toLanguage: '', content: '', userinput: '', langarr: [] })
    this._getSupportedLangualge();
  }

  private async _getSupportedLangualge() {
    $.get({
      url: 'https://api.cognitive.microsofttranslator.com/languages?api-version=3.0&scope=translation'
    })
      .done((languages: any): void => {
        let droparr: IDropdownOption[] = []
        let langobjs = languages.translation;
        for (var key in langobjs) {
          if (langobjs.hasOwnProperty(key)) {
            droparr.push({ key: key, text: langobjs[key].name })
          }
        }
        this.setState({ langarr: droparr })
      }).fail(function (res) {
        console.log(res);
      });
  }

  private async _translate() {
    $.post({
      url: 'https://ravichandran.cognitiveservices.azure.com/sts/v1.0/issueToken',
      headers: {
        'Ocp-Apim-Subscription-Key': '03e88fd1d1cc403654861c891001e457',
        'Authorization': 'ravichandran.cognitiveservices.azure.com'
      }
    })
      .done((tocken: any): void => {
        $.post({
          url: 'https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&to=' + this.state.toLanguage,
          headers: {
            'Ocp-Apim-Subscription-Key': '03e88fd1d1cc403654861c891001e457',
            'Authorization': 'Bearer ' + tocken,
            'Content-Type': 'application/json'
          },
          data: JSON.stringify([{ "Text": this.state.userinput }])
        })
          .done((result: any): void => {
            console.log(result);
            this.setState({ content: result[0].translations[0].text })
          }).fail(function (res) {
            console.log(res);
          });

      }).fail(function (res) {
        console.log(res);
      });
  }

  public render(): React.ReactElement<ISpfxAzureTranslatorProps> {
    return (
      <div className={styles.spfxAzureTranslator}>
        <Stack horizontal tokens={stackTokens} styles={stackStyles}>
          <Stack {...columnProps}>
            <TextField label="Any language (auto deducted)" multiline autoAdjustHeight onChanged={(newtext) => { this.setState({ userinput: newtext }); this._translate() }} />
          </Stack>
          <Stack {...smallcolumnProps}>
            <Dropdown
              placeholder="Select a language"
              label="Select Language"
              options={this.state.langarr}
              onChanged={(value) => { this.setState({ toLanguage: value.key.toString() }); this._translate() }}
            />
          </Stack>
          <Stack {...columnProps}>
            <label>{this.state.content}</label>
          </Stack>
        </Stack>
      </div>
    );
  }
}

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

Fluent UI Tooltip inside the PnP Listview in SPFx

Ravichandran KrishnasamyLeave a comment

This article provides steps to implement the Fluent UI Tooltip inside the PnP Listview in the SharePoint Framework (SPFx) webpart, generally Fluent UI Tooltip is a wrapper that automatically shows a tooltip when the wrapped element is hovered or focused. 

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 @pnp/spfx-controls-react --save --save-exact
npm install moment --save

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

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

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

import { IViewField } from "@pnp/spfx-controls-react/lib/ListView";
export interface ISpfxFluentuiTooltipState {
  items: any[];
  viewFields: IViewField[];
}

In addition, you need to update the render method of the client-side web part to create a properly configured instance of the React component for rendering. The following code shows the updated method definition.

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

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 * as moment from 'moment';
import styles from './SpfxFluentuiTooltip.module.scss';
import { ISpfxFluentuiTooltipProps } from './ISpfxFluentuiTooltipProps';
import { ISpfxFluentuiTooltipState } from './ISpfxFluentuiTooltipState';
import { ListView, IViewField, SelectionMode } from "@pnp/spfx-controls-react/lib/ListView";
import { autobind } from 'office-ui-fabric-react/lib/Utilities';
import { sp } from "@pnp/sp";
import "@pnp/sp/webs";
import "@pnp/sp/files";
import "@pnp/sp/folders";
import {
  TooltipHost,
  TooltipDelay,
  DirectionalHint,
  ITooltipProps,
  ITooltipHostStyles,
} from 'office-ui-fabric-react/lib/Tooltip';

Replace this render function with the following code.

  public render(): React.ReactElement<ISpfxFluentuiTooltipProps> {
    return (
      <div className={styles.spfxFluentuiTooltip}>
        <ListView
          items={this.state.items}
          viewFields={this.state.viewFields}
          iconFieldName="ServerRelativeUrl"
          compact={true}
          selectionMode={SelectionMode.multiple}
          showFilter={true}
          filterPlaceHolder="Search..." />
      </div>
    );
  }

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

export default class SpfxFluentuiTooltip extends React.Component<ISpfxFluentuiTooltipProps, ISpfxFluentuiTooltipState> {
  constructor(props: ISpfxFluentuiTooltipProps, state: ISpfxFluentuiTooltipState) {
    super(props);
    sp.setup({
      spfxContext: this.props.context
    });
    var _viewFields: IViewField[] = [
      {
        name: "Name",
        displayName: "Name",
        sorting: false,
        minWidth: 200,
        render: (item: any) => {
          let tooltipProps: ITooltipProps = {
            onRenderContent: () => (
              <ul style={{ margin: 10, padding: 0 }}>
                <li><b>Description</b></li>
                <li>{item['ListItemAllFields.Description0']}</li>
              </ul>
            ),
          };

          return <TooltipHost
            tooltipProps={tooltipProps}
            delay={TooltipDelay.zero}
            id={'tooltipId' + item['ID']}
            directionalHint={DirectionalHint.rightCenter}
            styles={hostStyles}
          ><a href={item['ServerRelativeUrl']}>{item['Name']}</a></TooltipHost>;
        }
      },
      {
        name: "Author.Title",
        displayName: "Author",
        sorting: false,
        minWidth: 200,
        render: (item: any) => {
          const authoremail = item['Author.UserPrincipalName'];
          return <a href={'mailto:' + authoremail}>{item['Author.Title']}</a>;
        }
      },
      {
        name: "TimeCreated",
        displayName: "Created",
        minWidth: 150,
        render: (item: any) => {
          const created = item["TimeCreated"];
          if (created) {
            const createdDate = moment(created);
            return <span>{createdDate.format('DD/MM/YYYY HH:mm:ss')}</span>;
          }
        }
      }
    ];
    this.state = { items: [], viewFields: _viewFields };
    this._getfiles();
  }

place the below code inside the react component code, these functions using PnPjs to get files from the SharePoint document library

 @autobind
  private async _getfiles() {
    const allItems: any[] = await sp.web.getFolderByServerRelativeUrl("/sites/TheLanding/Policies").files.select().expand("ListItemAllFields,Author,Description").get();
    this.setState({ items: allItems });
  }

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

Switch Between React Components using Fluent UI Pivot in SPFx

Ravichandran Krishnasamy2 Comments

This article provide steps to Switch Between React Components using Fluent UI Pivot in the SharePoint Framework (SPFx) web part, generally Fluent UI Pivot control used for navigating frequently accessed, distinct content categories. Pivots allow for navigation between two or more content views and relies on text headers to articulate the different sections of content.

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 .

Primary react component

Update the <web part name>.tsx file

import * as React from 'react';
import styles from './SpfxFluentuiPivot.module.scss';
import { ISpfxFluentuiPivotProps } from './ISpfxFluentuiPivotProps';
import SpfxFluentuiPivotTab1 from './SpfxFluentuiPivotTab1';
import SpfxFluentuiPivotTab2 from './SpfxFluentuiPivotTab2';
import SpfxFluentuiPivotTab3 from './SpfxFluentuiPivotTab3';
import { Pivot, PivotItem } from 'office-ui-fabric-react/lib/Pivot';


export default class SpfxFluentuiPivot extends React.Component<ISpfxFluentuiPivotProps, {}> {
  public render(): React.ReactElement<ISpfxFluentuiPivotProps> {
    return (
      <div className={styles.spfxFluentuiPivot}>
        <Pivot aria-label="Basic Pivot Example">
          <PivotItem headerText="New User">
            <SpfxFluentuiPivotTab1></SpfxFluentuiPivotTab1>
          </PivotItem>
          <PivotItem headerText="Users">
            <SpfxFluentuiPivotTab2></SpfxFluentuiPivotTab2>
          </PivotItem>
          <PivotItem headerText="Shared Memberships">
            <SpfxFluentuiPivotTab3></SpfxFluentuiPivotTab3>
          </PivotItem>
        </Pivot>
      </div>
    );
  }
}

Tab 1 react component

import * as React from 'react';
import styles from './SpfxFluentuiPivot.module.scss';
import { TextField } from 'office-ui-fabric-react/lib/TextField';
import { PrimaryButton } from 'office-ui-fabric-react';


export default class SpfxFluentuiPivotTab1 extends React.Component<{}, {}> {
  public render(): React.ReactElement<{}> {
    return (
      <div className={styles.spfxFluentuiPivot}>
        <h3>New user details</h3>
        <TextField label="First Name" />
        <TextField label="Last Name" />
        <TextField label="House number" />
        <TextField label="City" />
        <TextField label="State" />
        <br />
        <PrimaryButton text="Save" />
      </div>
    );
  }
}

Tab 2 react component

import * as React from 'react';
import styles from './SpfxFluentuiPivot.module.scss';

export default class SpfxFluentuiPivotTab2 extends React.Component<{}, {}> {
  public render(): React.ReactElement<{}> {
    return (
      <div className={ styles.spfxFluentuiPivot }>
        Tab 2
      </div>
    );
  }
}

Tab 3 react component

import * as React from 'react';
import styles from './SpfxFluentuiPivot.module.scss';

export default class SpfxFluentuiPivotTab3 extends React.Component<{}, {}> {
  public render(): React.ReactElement<{}> {
    return (
      <div className={ styles.spfxFluentuiPivot }>
        Tab 3
      </div>
    );
  }
}

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