Skip to main content

LWC js-meta.xml Configuration File Tags

Each Lightning web component folder must include a configuration file named <componentName>.js-meta.xml. The configuration file defines the metadata values for the component, including the design configuration for the Lightning App Builder and Community Builder.

Some Standard Key metadata values:

apiVersion: A double value that binds the component to a Salesforce API version.

isExposed: If isExposed is false, the component is not exposed to Lightning App Builder or Community Builder.
To allow the component to be used in Lightning App Builder or Community Builder, set isExposed to true and define at least one <target>, which is a type of Lightning page.

Some Standard Optional metadata values:

description: A short description of the component, usually a single sentence.

masterLabel: The title of the component. Appears in list views, like the list of Lightning Components in Setup, and in the Lightning App Builder and in Community Builder.

targets: Specifies where the component can be added, such as on a type of Lightning Page or in Embedded Service Chat. If you want your component to appear in the Lightning App Builder or in Community Builder, specify at least one Lightning page type.

Supports the target subtag:

lightning__AppPage: Enables a component to be used on an App page in Lightning App Builder.

lightning__HomePage: Enables a component to be used on a Home page in Lightning App Builder.

lightning__RecordPage: Enables a component to be used on a record page in Lightning App Builder.

lightning__UtilityBar: Enables a component to be used as a utility item on the utility bar in the App Manager.

lightning__FlowScreen: Enables a component to be used on flow screens in Flow Builder.

lightning__Tab: Enables a component to be used in a custom tab in Lightning Experience or the Salesforce mobile app.

lightning__Inbox: Enables a component to be used in Lightning App Builder to add to email application panes for the Outlook and Gmail integrations.

lightningCommunity__Page: Enables a component to be used on a Lightning community page in Community Builder.

lightningCommunity__Default: Used together with lightningCommunity__Page. Enables a component that includes configurable properties to be used on a Lightning community page in Community Builder. When the component is selected on the page, the properties appear.

lightningSnapin__ChatMessage: Enables a component to be selected from Embedded Service Chat Setup. If a component imports the lightningsnapin/baseChatMessage module, it must specify the lightningSnapin__ChatMessage target. For more information, see the lightningsnapin/baseChatMessage documentation.

targetConfigs: Configure the component for different page types and define component properties. For example, a component could have different properties on a record home page than on the Salesforce Home page or on an app page. For Communities, only lightningCommunity__Default supports component properties.

Example:
lwc.js-meta.xml
<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>47.0</apiVersion>
    <isExposed>true</isExposed>
    <targets>
        <target>lightning__HomePage</target>
    </targets>
</LightningComponentBundle>

Note: targetConfigs supported Subtags : ClickHere

Comments

Popular posts from this blog

Maintain Your Platform Developer I Certification for Winter ’25

  Make Invocable Actions Easier to Configure with New InvocableVariable Modifiers Simplify the configuration of invocable actions using new modifiers from Salesforce. Both the defaultValue and placeholderText modifiers will appear in Flow Builder for the Action elements that correspond to an invocable method. Here’s how to use them. defaultValue Modifier : Set a default value for an input parameter. When the action is used, the input parameter will have a predefined value unless changed by the user. placeholderText Modifier : Set custom placeholder text for an input parameter. Text can provide examples or additional guidance to help users understand what to enter in the input field. Accessing these modifiers in Flow Builder makes it easier to configure and use the actions within your flows. This change applies to Lightning Experience and Salesforce Classic in Performance, Unlimited, Developer, Enterprise, and Database.com editions.

Maintain Your Administrator Certification for Spring ’25

  Manage Included Permission Sets in Permission Set Groups via Summaries Update user access more efficiently by specifying which permission set groups include a permission set directly from the permission set’s summary. Previously, to manage included permission sets, you were required to navigate to each permission set group’s page. From Setup, in the Quick Find box, enter  Permission Sets , and select Permission Sets. Select a permission set, and then click  View Summary . In the Related Permission Set Groups tab, click  Add  or  Remove . This change applies to Lightning Experience and Salesforce Classic (not available in all orgs) in Contact Manager, Group, Essentials, Professional, Enterprise, Performance, Unlimited, Developer, and Database.com editions. Sort List Views by Multiple Columns To see your data in a more intuitive way and make your list views more actionable, you can now sort list views on object home pages by up to five columns. Select the c...

Salesforce Architect Certification Maintenance (Winter '25)

  Update Records Using ISO State and Country Codes Standardize and simplify updating address records with two new fields that store the ISO code for country or territory and state or province. Improve data quality and accuracy using this new support for ISO codes, and reduce the risk of errors and inconsistencies that can occur when using names. Previously, the Address component stored only the name associated with the user’s selection. With this new support for ISO codes, you can update the country or territory and state or province fields on records with ISO codes instead of names. This feature can be used for new or existing screen flows. Here are the steps to create a new flow. In Setup, on the State and Country/Territory Picklists page, ensure that Enable Picklists for Address Fields is enabled. In Flow Builder, create a screen flow. Add a Screen element to the flow. Include an Address component in the Screen element. Optionally, specify a default value in the Country Code and...

Translate