Lightning Components Developer Guide

What is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Adding Components to Apps
Add Lightning Components to Salesforce1
Add Lightning Components to Lightning Experience
Use Lightning Components in Visualforce Pages
Add Lightning Components to Any App with Lightning Out (Beta)
Configure Components for Communities
Create Custom Page Layout Components for Communities
Configure Components for Lightning Pages and the Lightning App Builder
Communicating with Events
Creating Apps
Debugging
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Create Custom Page Layout Components for Communities

Community Builder includes several ready-to-use layouts that let you quickly change the look of your community’s pages. However, if you need a layout that’s customized for your community, create a custom layout component to use when building new pages in Community Builder. You can also update the layout of the default pages that come with your community template.
When you create a custom layout component in the Developer Console, it appears in Community Builder in:
  • The Create New Page dialog box. To view the custom layout, select the Custom view in the Layouts tab.
  • The Change Layout dialog box. To view the custom layout, select the Custom tab.

1. Add a New Interface to Your Layout Component

To appear in the Create New Page and Change Layout dialog boxes in Community Builder, a custom layout component must implement the forceCommunity:layout interface.

Here’s the sample code for a simple two-column layout.

Mark your resources, such as a component, with access="global" to make the resource usable outside of your own org. For example, if you want a component to be usable in an installed package or by a Lightning App Builder user or a Community Builder user in another org.

Note

2. Add a CSS Resource to Your Component Bundle

Next, add a CSS resource to style the layout as needed.

Here’s the sample CSS for our simple two-column layout.

CSS resources must be named componentName.css. For example, the CSS resource for the component communityLayout.cmp is communityLayout.css.

3 Optional: Add an SVG Resource to Your Component Bundle

You can include an SVG resource in your component bundle to define a custom icon for the layout component when it appears in the Community Builder.

The recommended image size for a layout component in Community Builder is 155px by 120px. However, if the image has different dimensions, Community Builder scales the image to fit.

SVG resources must be named componentName.svg.