Components Overview

Components are used to render content into regions on pages. They are the gatekeepers/controllers to decide what  content to show on a page.

Often they will have some user-configurable settings such as what article to show, and what content template to use when rendering the article.

Component Types

There are three main types of components

  1. System Components. These are the default components that come with Textstem. They installed in the Application/System directory.
  2. Application Components. These are installed in the Application/Components directory. If an Application Components has the same name as a system component, the Application component will be used (ie they override the System component)
  3. Module Components. These are installed in the Application/Module/[modulename] directory. These are usually concerned with displaying content created or managed by that module.

Components

Content is displayed using components. Components are data + template. They collect content data and render it into HTML for display on the page. Components can be added directly to a page template (typically, menus and footers are added directly to the template), or can be assigned to page template regions by content administrators.

Article

The default component is an 'article'.

Parameters:

Article This is the ID of the attached article.
Template

This is the template used to display the article. If not specified, the default template for the article type (Image, post, news, article etc) is used

Example template:

 

Articles

A manual collection of ordered articles displayed using the specified template

Parameters:

Articlelist This is a collection of articles.
Template

This is the template used to dispay the article. If not specified, the default template for the article type (Image, post, news, article etc) is used

Example template:

Articlelist

Automatically collected and ordered articles

Parameters:

Filter Filter object used to collect and sort articles.
Template

This is the template used to dispay the article. If not specified, the default template for the article type (Image, post, news, article etc) is used

Example template:

Images

A manual collection of ordered images. With an appropriate template, this can be used to create image grids, slideshows and carousels

Parameters:

Articlelist This is a collection of 'image articles'.
Template

This is the template used to dispay the article. If not specified, the default template for the article type (Image, post, news, article etc) is used

Example template:

Base Components


Custom Components