Pcf React Platform Libraries

React Controls & Platform Libraries

When you use React and platform libraries, you're using the same infrastructure used by the Power Apps platform. This means you no longer have to package React and Fluent libraries individually for each control. All controls share a common library instance and version to provide a seamless and consistent experience.

Benefits

By reusing the existing platform React and Fluent libraries, you can expect:

• Reduced control bundle size
• Optimized solution packaging
• Faster runtime transfer, scripting, and control rendering
• Design and theme alignment with the Power Apps Fluent design system

Note: With GA release, all existing virtual controls will continue to function. However, they should be rebuilt and deployed using the latest CLI version (>=1.37) to facilitate future platform React version upgrades.

Prerequisites

As with any component, you must install Visual Studio Code and the Microsoft Power Platform CLI.

Note: If you have already installed Power Platform CLI for Windows, make sure you are running the latest version by using the pac install latest command. The Power Platform Tools for Visual Studio Code should update automatically.

Create a React Component

Note: These instructions expect that you have created code components before. If you have not, see Create your first component.

There's a new --framework (-fw) parameter for the pac pcf init command. Set the value of this parameter to react.

Command Parameters

PowerShell Command

The following PowerShell command uses the parameter shortcuts and creates a React component project and runs npm-install:

pac pcf init -n ReactSample -ns SampleNamespace -t field -fw react -npm

You can now build and view the control in the test harness as usual using npm start.

After you build the control, you can package it inside solutions and use it for model-driven apps (including custom pages) and canvas apps like standard code components.

Differences from Standard Components

ControlManifest.Input.xml

The control element control-type attribute is set to virtual rather than standard.

Note: Changing this value does not convert a component from one type to another.

Within the resources element, find two new platform-library element child elements:

<resources>
  <code path="index.ts" order="1" />
  <platform-library name="React" version="16.14.0" />
  <platform-library name="Fluent" version="9.46.2" />
</resources>

Note: For more information about valid platform library versions, see Supported platform libraries list.

Recommendation: We recommend using platform libraries for Fluent 8 and 9. If you don't use Fluent, you should remove the platform-library element where the name attribute value is Fluent.

Index.ts

The ReactControl.init method for control initialization doesn't have div parameters because React controls don't render the DOM directly. Instead ReactControl.updateView returns a ReactElement that has the details of the actual control in React format.

bundle.js

React and Fluent libraries aren't included in the package because they're shared, therefore the size of bundle.js is smaller.

Sample Controls

The following controls are included in the samples. They function the same as their standard versions but offer better performance since they are virtual controls.

Supported Platform Libraries List

Platform libraries are made available both at the build and runtime to the controls that are using platform libraries capability. Currently, the following versions are provided by the platform and are the highest currently supported versions.

Note: The application might load a higher compatible version of a platform library at runtime, but the version might not be the latest version available. Fluent 8 and Fluent 9 are each supported but can not both be specified in the same manifest.

FAQ

Q: Can I convert an existing standard control to a React control using platform libraries?

A: No. You must create a new control using the new template and then update the manifest and index.ts methods. For reference, compare the standard and react samples described above.

Q: Can I use React controls & platform libraries with Power Pages?

A: No. React controls & platform libraries are currently only supported for canvas and model-driven apps. In Power Pages, React controls don't update based on changes in other fields.

Related Articles

• What are code components?
• Code components for canvas apps
• Create and build a code component
• Learn Power Apps component framework
• Use code components in Power Pages