Module: alfresco/lists/views/HtmlListView

alfresco/lists/views/HtmlListView

This module extends the base list view to render a simple HTML list of items. It is intended to be used when only a single property from each item in the list needs to be displayed. This view replaces the standard ListRenderer with a custom list renderer that iterates over the list of items and renders a single property of each one as an individual bullet. The bullet style can be configured using the listStyleType attributes.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Example

Example of using the view within a list:

{
  name: "alfresco/lists/AlfList",
  config: {
    widgets: [
      {
        name: "alfresco/lists/views/HtmlListView",
        config: {
          propertyToRender: "node.properties.cm:name",
          listStyleType: "square"
        }
      }
    ]
  }

Extends

Members

listStyleType :string

The bullet style to apply to each list item. These should be set to one of the supported link-style-type values.
Type:
  • string
Default Value:
  • "none"
Source:

propertyToRender :string

This is the dot-notation addressed property within each item to render as the value in the list element.
Type:
  • string
Default Value:
  • "displayName"
Source:

renderFilterSelectorQuery :string

Override the default selector to match the li elements created by the renderer.
Type:
  • string
Default Value:
  • "li.alfresco-lists-views-HtmlListView--item"
Source:

templateString :String

The HTML template to use for the widget.
Type:
  • String
Source:

Methods

createListRenderer() → {object}

Overrides the inherited function to create an HtmlListViewRenderer.
Source:
Returns:
A new HtmlListViewRenderer
Type
object