Customize list components


Sitefinity CMS Admin App uses the list component in various places, such as the list of content items, the sidebar, or related data.

This article demonstrates how to customize the list's item template using a custom Angular component.

One common way to extend the list of items is to add a column to the grid in the selector. This column makes the administration of your items more convenient and faster.

For example, you can display additional information for dynamic module selectors. For example, if you have a Physicians module with Physician ID as an identifier, the data is not sufficient for the content editors to understand which is the correct item to select, and you may want to customize the data displayed to your visitors.

To solve this problem, Sitefinity CMS exposes an API that enables you to modify the HTML of the related data selector. This way, you can change the displayed information. For example, in addition to its name, you can add the start and end date to an event.

When you create custom templates, these templates are applied in the following places:

  • The full list of items
  • The short list of items that can be selected, where five items are shown
  • The already selected items

The picture below shows where the custom component is rendered in the list's item template.

sample - Customize list components 

Tutorial: Implement custom component for related data

In this tutorial, you learn how to create a custom Angular component for the related data feature. This component is rendered in the following parts of the UI:

  • Already selected related items
  • Dropdown box for the recent items and search drop-down
  • Related data selector and the adjacent search feature
  • Read-only mode of the content item
RelatedDataCustomTreeComponent - Customize list components 

NOTE: The search functionality in the related data fields (and in the entire Admin App) is based on the item's primary identifier, which is the Title in the case of the default content modules. When you modify the component rendered in the tree's item template, it will not affect the search feature. If you want to add another field to the search, see Extending search functionality in AdminApp.

Implement the component

Implement an Angular component as usual. The only requirement is that your custom component must extend the abstract class CustomTreeComponentBase. This, in turn, forces you to implement its sole property item: DataItem, which Sitefinity CMS will populate with the item to be rendered.

IMPORTANT: You cannot use the Angular binding syntax {{}} when creating component HTML templates. Instead, you must use another binding such as [textContent]="" or [innerHtml]="".

Registering the component

After you implement the component, you must register it in a class that implements the TreeNodeComponentProvider interface. This interface has a single method - getComponentData, which accepts two parameters:

  1. feature: TreeNodeComponentFeatures. The only currently supported feature is the related data.
  2. entitySet: string, representing the currently loaded data.

Admin App calls the getComponentData method. For example, if your project's news items have a related data field for events, the values passed to the method will be TreeNodeComponentFeatures.RelatedData and events. Therefore, the provider you implement must return a ComponentData object that you would like to be used when displaying the related data nodes in the content item.

To implement a custom provider, you start by creating a custom class, which in this sample is called RelatedDataTreeNodeComponentProvider, and it must implement the TreeNodeComponentProvider interface.

The sample implementation follows:

As a next step, you export the provider using the special Angular DI token CUSTOM_TREE_COMPONENT_TOKEN.

As the last step, you create a custom Angular module for this extension and register it where all other extensions are registered. Implementing this module is optional because you can reuse another module if you have it created already.

The sample code for a custom module follows:

To register the module, add the following line to the __extensions_index.ts file:

Your __extensions_index.ts file should look something like this:

After you complete these steps, your sample extension is ready to be tested.

Increase your Sitefinity skills by signing up for our free trainings. Get Sitefinity-certified at Progress Education Community to boost your credentials.

Get started with Integration Hub | Sitefinity Cloud | Sitefinity SaaS

This free lesson teaches administrators, marketers, and other business professionals how to use the Integration hub service to create automated workflows between Sitefinity and other business systems.

Web Security for Sitefinity Administrators

This free lesson teaches administrators the basics about protecting yor Sitefinity instance and its sites from external threats. Configure HTTPS, SSL, allow lists for trusted sites, and cookie security, among others.

Foundations of Sitefinity ASP.NET Core Development

The free on-demand video course teaches developers how to use Sitefinity .NET Core and leverage its decoupled architecture and new way of coding against the platform.

Was this article helpful?