Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Get Information About the Current Lightning Community

Use the @salesforce/community scoped module to import information about the current community context when developing Lightning web components for Lightning communities.

Where: This change applies to Lightning web components in Lightning communities in Enterprise, Performance, Unlimited, and Developer editions.

How: Use @salesforce/community/Id to import the ID of the current community—for example, when your component must pass the community ID as a parameter to an API.

import communityId from '@salesforce/community/Id';

Use @salesforce/community/basePath to import the base URL of your community and then dynamically construct the full URL—for example, when building a link component that works across several communities.

import communityBasePath from '@salesforce/community/basePath';

The base URL is the section of the community’s URL that comes after the domain. So if your community domain name is UniversalTelco.force.com and myPartnerCommunity was the URL value added when you created the community, the community’s URL is UniversalTelco.force.com/myPartnerCommunity/s. In this case, myPartnerCommunity/s is the base URL.

Important

You can use @salesforce/community when targeting a Lightning community page only. If a component imports @salesforce/community, it can’t be used in any other Salesforce experience.