Contact Free trial Login

API Community Look-and-Feel Customization

Community Builder enables you to create a community with your desired brand identity, look and feel, and site structure by providing control over the community’s components, themes, and pages, and its settings for general properties, themes, and SEO.

In the Anypoint API Community Manager control panel, the Community Builder link opens your site for editing. With Community Builder you can edit each page in your community, create new pages, and add and edit the components in each page.

Community Builder’s interface contains the pages list, component palette, theme menu, page structure menu, and settings menu.

Pages List

The Pages list shows the pages included with API Community Manager and the pages you have added, and enables you to select and edit each page. The included page Home is selected by default.

The Pages list enables you to create new pages by using the New Page option.

A new page can be an object page or a standard page. Object pages are used only with Salesforce objects, so a custom community page starts as a standard page. A standard page can start from one of the preconfigured pages or as a new blank page.

Make a new blank page by selecting the layout and then entering the new page’s name and URL. Use that URL to make links to the new page, including links in menus.

The new page displays with placeholders for content based on the layout.

Fill in a new page by adding components from the Components menu, such as a Headline component in the page header, or an API Community Manager Lightning component such as an API Version Carousel.

The Pages list shows the editable configuration properties for each page, which are described in Manage Your Community’s Pages and Their Properties in Community Builder.

Components

Clicking the Components lightning bolt icon displays the component palette, which includes Salesforce Community Cloud components, such as Headline or Featured Topics, and components specific to API Community Manager, such as API Carousel or API Console. You can drag any component from the component palette to the current page. Select the component on the page to show the component’s configuration options.

Detailed component information is available from the page Description of API Community Manager Lightning Components and the Salesforce Community Cloud Community Components documentation.

Components typically used in home pages include:

The Navigation Menu component provides the menu for navigating the site, with settings for Max Items to Display (2-15) and Menu Item Alignment, and a Navigation Menu button to edit the links on the navigation menu. The menu always starts with the Home link. Other links can be added, removed, and reordered. Each link other than Home can be customized with these options:

  • Name

    Sets the link name.

  • Type

    Sets the link type, such as Community Page or External URL.

  • Page

    Specifies community page links from a list of all community pages.

  • Publicly available

    Sets whether the link is available to all page viewers or only logged in community members.

Components typically used in API details pages include:

  • API Header

    Specifies the API name and description.

  • Tabs

    Contains these components:

    • API Documentation Viewer

      Displays API Exchange information.

    • API Console

      Renders information from the API RAML specification.

    • Feed

      Displays comments, discussions, and questions.

  • API Access Requestor

    Registers a client application and requests access to the API.

  • Learn More Button

    Provides additional information about the API.

Components typically used in My Application pages include:

  • Application Listing

    Lists all client applications that the member has registered and can access.

You can drag items on a page to reorder them.

Theme

Clicking the Theme paintbrush icon offers these general branding parameters:

  • Colors

    Sets the site’s general color scheme, including paragraph, heading, and button text.

  • Images

    Specifies the site’s company logo and the login page’s background Image.

  • Fonts

    Specifies the site’s fonts, which include a primary font and header fonts, and specifies the site’s text case.

  • Theme Settings

You can adjust community styling by editing the CSS rules. Next to the Theme title, click the Theme list, and click Edit CSS.

Page Structure

Clicking the Page Structure icon, which resembles a bulleted list, shows the components in the current page and enables you to select and remove them. Selecting a component displays its configuration menu.

Settings

Clicking the Settings gear icon offers these parameters:

  • General

  • Theme

  • SEO

    Search Engine Optimization (SEO) features define what information can be indexed by external services and discovered through online searches, and can increase traffic to your public community.

Refer to the Community Builder Settings help topic for additional information.

See Also

You can find further information in the Salesforce Community Cloud documentation:

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.