Why the SPFx Application Customizer Component Property File Is Not Created and How to Fix It

When deploying SharePoint Framework (SPFx) Application Customizer extensions, you might encounter an issue where the Component property file is not created. This file is essential for managing the properties and configurations of your Application Customizer. In this article, we will explore why this problem occurs and provide the solution to ensure that the component property file is generated correctly.

The Problem:

After deploying an SPFx Application Customizer, you may notice that the expected Component property file is missing. This file is crucial for applying custom configurations to your Application Customizer, such as custom CSS or JavaScript. Without this file, your customizations might not work as intended.

The Cause:

The Component property file for SPFx Application Customizers is created only if the solution is made available to all sites in the organization. If this option is not selected during the deployment of the SPFx package, the property file will not be generated, leading to issues with applying custom properties across the site collection.

The Solution:

To ensure that the Component property file is created for your SPFx Application Customizer, follow these steps:

When deploying your SPFx Application Customizer in the App Catalog, make sure to select the option “Make this solution available to all sites in the organization”. This setting ensures that the property file will be generated for the solution.

After enabling the checkbox and deploy, navigate to below URL to to verify the existence of the Component property file.

https://<YourSiteCollectionUrl>/Lists/TenantWideExtensions/AllItems.aspx

This URL provides access to the TenantWideExtensions list, which stores the configurations, including the Component property file, for your SPFx Application Customizer. Make sure the properties are listed here to confirm successful deployment.

Here’s a quick checklist:

• Upload the .sppkg file to the App Catalog.
• During the upload process, you will be prompted to make the solution available to all sites in the organization.
• Enable the check box for this option.

By choosing this setting, SharePoint will generate the necessary Component property file, allowing your Application Customizer to apply the required properties and configurations.

Conclusion:

If the Component property file is missing after deploying your SPFx Application Customizer, it’s likely because the solution was not made available to all sites in your organization. To resolve this, ensure that the “Make this solution available to all sites in the organization” option is selected during deployment. This will create the component property file and enable proper configuration of your Application Customizer.

For more information on enabling the App Catalog at the site collection level, you can refer to this guide.