Salesforce Dictionary - Free Salesforce GlossarySalesforce Dictionary
Full Lightning Extension entry
How-to guide

Add a Lightning Extension to the org

Adding a Lightning Extension differs slightly by type, but the general flow is consistent: identify the right extension type for the need, install or develop it in a sandbox, configure where it appears, validate behavior, and promote to production. Below is the standard sequence for adding a custom LWC to a Lightning record page, which covers the broadest case.

By Dipojjal Chakrabarti · Founder & Editor, Salesforce DictionaryLast updated May 19, 2026

Adding a Lightning Extension differs slightly by type, but the general flow is consistent: identify the right extension type for the need, install or develop it in a sandbox, configure where it appears, validate behavior, and promote to production. Below is the standard sequence for adding a custom LWC to a Lightning record page, which covers the broadest case.

  1. Identify the extension type and build or install

    Decide whether the requirement is best served by a custom LWC, an AppExchange package, a Quick Action override, or an App Extension on a console utility bar. Custom builds happen in VS Code with Salesforce DX. AppExchange installations happen via the standard install flow. For Quick Action overrides, no install is needed; the LWC exists in the org's metadata. Deploy the component to a sandbox, confirming the component appears in the App Builder palette with the expected name and icon.

  2. Place the extension on the target page

    Open Lightning App Builder, edit the target page (Account Record Page, Service Console App Page, Home Page), and drag the extension into the desired region. Configure component properties using the right-side panel: API name of the source object, default record id, custom property values. Add component visibility rules to limit appearance to specific users, profiles, or record conditions. Save the page and activate it for the appropriate org or app default.

  3. Test the extension across users and devices

    Open the modified page as a test user in the sandbox. Verify the extension renders, responds to clicks and field updates, and respects field-level security and component visibility rules. Test on both desktop and mobile if the extension supports both. Check the browser console for JavaScript errors. If the extension calls Apex, run with debug logs enabled and confirm no exceptions surface. Repeat for at least two profile-distinct user types to catch profile-specific permission issues early.

  4. Deploy to production with documentation

    Use Change Sets, DevOps Center, or a CI/CD pipeline to promote the component and its page layout changes to production. Schedule the deployment during a low-traffic window. After deployment, sample a small set of production users and confirm the extension behaves the same way it did in sandbox. Update the org's running architecture log and the user-facing documentation portal with a brief description of what the new extension does and how to get help when it breaks.

Gotchas
  • LWC components must declare the right target surfaces in their .js-meta.xml file. A component built for record pages will not appear in the App Builder palette for app pages unless explicitly enabled.
  • Lightning Web Security blocks unallowlisted third-party scripts silently. Console errors are the only signal, and many admins miss them on the first rollout.
  • Quick Action overrides apply to every page layout that exposes the action. There is no way to override per page layout; the override is global to the action.
  • Component visibility rules are evaluated at page render time. Rules that depend on related-record fields can return stale data if the related record is updated mid-session.
  • App Extensions on Lightning Console utility bars consume vertical real estate. Adding too many at once turns the bar into a search-required interface and hurts agent productivity.

See the full Lightning Extension entry

Lightning Extension includes the definition, worked example, deep dive, related terms, and a quiz.