PCF Components: Build & Lifecycle

Building custom controls

The PCF component lifecycle

Every component goes through four phases:

Method	When It Runs	What You Do
init	Component first loads	Set up DOM elements, event listeners, initial state. Called ONCE.
updateView	Data changes (from the platform)	Re-render the component with new data. Called MANY times.
getOutputs	Platform requests current value	Return the current value(s) to save to Dataverse. Called when user interacts.
destroy	Component is removed	Clean up event listeners, timers, memory. Called ONCE.

// Simplified PCF component structure
export class StarRating implements ComponentFramework.StandardControl<IInputs, IOutputs> {
    
    private container: HTMLDivElement;
    private currentValue: number;
    private notifyOutputChanged: () => void;
    
    // Called ONCE when the component loads
    public init(
        context: ComponentFramework.Context<IInputs>,
        notifyOutputChanged: () => void,
        state: ComponentFramework.Dictionary,
        container: HTMLDivElement
    ): void {
        this.container = container;
        this.notifyOutputChanged = notifyOutputChanged;
        this.currentValue = context.parameters.ratingValue.raw || 0;
        this.renderStars();
    }
    
    // Called when data changes from the platform
    public updateView(context: ComponentFramework.Context<IInputs>): void {
        this.currentValue = context.parameters.ratingValue.raw || 0;
        this.renderStars();
    }
    
    // Called when the platform needs the current value
    public getOutputs(): IOutputs {
        return { ratingValue: this.currentValue };
    }
    
    // Called when the component is removed
    public destroy(): void {
        // Clean up event listeners, timers, etc.
    }
    
    private renderStars(): void {
        // Render star HTML based on this.currentValue
        // When user clicks a star: this.currentValue = n;
        // Then call: this.notifyOutputChanged();
    }
}

💡 The notifyOutputChanged pattern

The notifyOutputChanged callback is critical. When a user interacts with your component (clicks a star, types in a field), you:

1. Update your internal state (this.currentValue = newValue)
2. Call this.notifyOutputChanged() to tell the platform “my value changed”
3. The platform calls getOutputs() to retrieve the new value
4. The platform saves the value to the bound field

If you forget to call notifyOutputChanged, the platform never knows the value changed and nothing saves. This is a common bug and exam topic.

The component manifest

The manifest (ControlManifest.Input.xml) defines your component’s contract with the platform:

<?xml version="1.0" encoding="utf-8" ?>
<manifest>
  <control namespace="NovaSoft" 
           constructor="StarRating" 
           version="1.0.0" 
           display-name-key="Star Rating" 
           description-key="A star rating control"
           control-type="standard">
    
    <!-- Bound property (the value this component reads/writes) -->
    <property name="ratingValue" 
              display-name-key="Rating Value" 
              of-type="Whole.None" 
              usage="bound" 
              required="true" />
    
    <!-- Input property (configuration, not saved to Dataverse) -->
    <property name="maxStars" 
              display-name-key="Maximum Stars" 
              of-type="Whole.None" 
              usage="input" 
              required="false" 
              default-value="5" />
    
    <resources>
      <code path="index.ts" order="1" />
      <css path="css/StarRating.css" order="1" />
    </resources>
  </control>
</manifest>

Key manifest concepts

Element	Purpose	Example
namespace	Unique identifier for your org	NovaSoft
constructor	Class name in index.ts	StarRating
property (bound)	Data field the component reads/writes	ratingValue — saves to Dataverse
property (input)	Configuration value (not saved)	maxStars — set by the form designer
control-type	standard (field) or virtual (no bound property)	standard
data-set	For dataset components (grids)	Replaces property for collection binding

Field components bind to one value; dataset components bind to collections

Feature	Field Component	Dataset Component
Binds to	A single column (field)	A view or collection of records
Manifest	Uses <property> with usage='bound'	Uses <data-set> element
Use case	Star rating, colour picker, toggle	Custom grid, chart, kanban board
Context data	context.parameters.fieldName	context.parameters.dataSet
Host	Form field, canvas control	Grid/subgrid, canvas gallery

💡 Scenario: Marcus designs a PCF manifest

Marcus at NovaSoft is building a colour-coded priority badge component. His manifest decisions:

• Bound property: priorityValue (Whole.None) — reads the priority number from Dataverse
• Input property: colorScheme (SingleLine.Text) — lets admins configure “warm” or “cool” colours
• Input property: showLabel (TwoOptions) — toggle whether the priority name shows alongside the badge
• No data-set — this is a field-level component (binds to one value)

The manifest defines the contract; the index.ts implements the visual rendering.

Question

What are the four lifecycle methods of a PCF component?

Click or press Enter to reveal answer

Answer

init (called once, set up DOM), updateView (called on data changes, re-render), getOutputs (return current value to platform), destroy (clean up resources). The platform controls when each is called — you implement the logic.

Click to flip back

Question

What is the purpose of notifyOutputChanged in a PCF component?

Click or press Enter to reveal answer

Answer

notifyOutputChanged is a callback you receive in init(). When the user changes the component's value (e.g., clicks a star), you call notifyOutputChanged() to tell the platform the value changed. The platform then calls getOutputs() to retrieve the new value. Without this call, changes are never saved.

Click to flip back

Question

What is the difference between a 'bound' and 'input' property in a PCF manifest?

Click or press Enter to reveal answer

Answer

A bound property connects to a Dataverse column — the component reads and writes this value. An input property is configuration that the form designer sets — like 'max stars' or 'colour scheme'. Input properties do not save to Dataverse.

Click to flip back

Knowledge Check

Marcus builds a PCF component for a progress bar. When the user drags the slider, the component should update the bound Dataverse field. The component renders correctly but the value never saves. What is the most likely cause?

AThe manifest property is configured as 'input' instead of 'bound'BThe component is not calling notifyOutputChanged() after the user drags the sliderCThe updateView method is overwriting the user's change with the old valueDThe getOutputs method returns an empty object

Check Answer

🎬 Video coming soon

Next up: PCF Components: Package, Deploy & Advanced Features — getting your component from code to production, plus Device and Web API features.