Compartilhar via

Kit de Ferramentas do Microsoft Graph em soluções de Estrutura do SharePoint

  • Artigo

Use o Microsoft Graph Toolkit em suas soluções de Estrutura do SharePoint.

Importante

O @microsoft/mgt-spfx pacote foi descontinuado. Use a disambiguation para suas web parts Estrutura do SharePoint.

Instalação

Para carregar componentes do Microsoft Graph Toolkit da biblioteca, adicione os @microsoft/mgt-elementpacotes , @microsoft/mgt-componentse @microsoft/mgt-sharepoint-provider como uma dependência de runtime ao seu projeto Estrutura do SharePoint:

npm install @microsoft/mgt-element @microsoft/mgt-components @microsoft/mgt-sharepoint-provider

ou

yarn add @microsoft/mgt-element @microsoft/mgt-components @microsoft/mgt-sharepoint-provider

Uso

Ao criar Estrutura do SharePoint web parts e extensões, referencie o Kit de Ferramentas customElementsHelperdo Microsoft Graph , Providere SharePointProvider do @microsoft/mgt-element e @microsoft/mgt-sharepoint-provider. Se você não estiver usando React, também deve importar as funções de registro de componente de @microsoft/mgt-components pacotes.

Para soluções não baseadas em React

import { customElementsHelper, Providers } from '@microsoft/mgt-element';
import { SharePointProvider } from "@microsoft/mgt-sharepoint-provider";
import { registerMgtPersonComponent } from '@microsoft/mgt-components';

// [...] trimmed for brevity

export default class MgtWebPart extends BaseClientSideWebPart<IMgtWebPartProps> {
  protected async onInit() {
    if (!Providers.globalProvider) {
      Providers.globalProvider = new SharePointProvider(this.context);
    }
    customElementsHelper.withDisambigutaion('contoso-hr-solution');
    registerMgtPersonComponent();
  }

  public render(): void {
    this.domElement.innerHTML = `
      <div>
        <mgt-contoso-hr-solution-person person-query="me"></mgt-person>
      </div>`;
  }

  // [...] trimmed for brevity
}

Reagir

Se você estiver criando uma Web Part usando React, poderá usar o @microsoft/mgt-react pacote e ignorar o registro manual de componentes. No entanto, certifique-se de carregar seu componente React da Web Part para usar a disambiguação.

// [...] trimmed for brevity
import { Providers, customElementHelper } from "@microsoft/mgt-element";
import { SharePointProvider } from "@microsoft/mgt-sharepoint-provider";
import { lazyLoadComponent } from "@microsoft/mgt-spfx-utils";


// Async import of component that imports the React Components
const MgtReact = React.lazy(
  () =>
    import(/* webpackChunkName: 'mgt-react-component' */ "./components/MgtReact")
);

// set the disambiguation before initializing any web part
customElementHelper.withDisambiguation("mgt-demo-client-side-solution");

export default class MgtDemoWebPart extends BaseClientSideWebPart<IMgtDemoWebPartProps> {
  // set the global provider
  protected async onInit(): Promise<void> {
    if (!Providers.globalProvider) {
      Providers.globalProvider = new SharePointProvider(this.context);
    }
    return super.onInit();
  }

  public render(): void {
    const element = lazyLoadComponent(MgtReact, {
      description: this.properties.description
    });

    ReactDom.render(element, this.domElement);
  }
// [...] trimmed for brevity
}

Nos componentes React subjacentes, o componente do Kit de Ferramentas do Microsoft Graph pode ser usado diretamente.

import { Person } from '@microsoft/mgt-react';
import { ViewType } from '@microsoft/mgt-components';

// [...] trimmed for brevity

export default class MgtReact extends React.Component<IMgtReactProps, {}> {
  public render(): React.ReactElement<IMgtReactProps> {
    return (
      <div className={ styles.mgtReact }>
        <Person personQuery="me" view={ViewType.image}></Person>
      </div>
    );
  }
}

Importante

Certifique-se de que sua classe web part raiz não importe nenhum recurso do Kit de Ferramentas do Microsoft Graph do @microsoft/mgt-react. Elas só devem ser importadas dentro dos componentes de React carregados com preguiçosa.

Configurar webpack

Para criar sua Web Part, você deve atualizar a configuração do webpack Estrutura do SharePoint para lidar corretamente com JavaScript moderno com encadeamento opcional e agrupamento nullish por meio de transformações adicionais do Babel.

! [IMPORTANTE] Se você não configurar o webpack para processar o JavaScript moderno, não poderá criar web parts que usam o Microsoft Graph Toolkit.

Instalar pacotes Babel

Para lidar corretamente com dependências que emitem código baseado em ES2021, adicione um carregador babel e algumas transformações como dependências de desenvolvimento ao projeto.

npm i --save-dev babel-loader@8.3.0 @babel/plugin-transform-optional-chaining @babel/plugin-transform-nullish-coalescing-operator @babel/plugin-transform-logical-assignment-operators

Modificar a configuração do webpack

Estrutura do SharePoint fornece um modelo de extensibilidade para modificar a configuração do webpack usada para empacotar as web parts. Localize e abra gulpfile.js. Adicione o seguinte código acima da linha que contém build.initialize(require('gulp'));:

const path = require("path");
const litFolders = [
  `node_modules${path.sep}lit${path.sep}`,
  `node_modules${path.sep}@lit${path.sep}`,
  `node_modules${path.sep}lit-html${path.sep}`
];
build.configureWebpack.mergeConfig({
  additionalConfiguration: generatedConfiguration => {
    generatedConfiguration.module.rules.push({
      test: /\.js$/,
      // only run on lit packages
      include: resourcePath => 
        litFolders.some(litFolder => resourcePath.includes(litFolder)),
      use: {
        loader: 'babel-loader',
        options: {
          plugins: [
            '@babel/plugin-transform-optional-chaining',
            '@babel/plugin-transform-nullish-coalescing-operator',
            '@babel/plugin-transform-logical-assignment-operators'
          ]
        }
      }
    });
    return generatedConfiguration;
  }
});

Conteúdo relacionado