Skip to content

Platform: Grid List Component V1.0 Technical Design

sKudum edited this page Mar 12, 2020 · 13 revisions

Grid List Component

Summary

As with the list and the responsive table, the grid list displays a set of items. In contrast to both controls, the grid list displays the items not in rows, but in a grid.

The grid list is usually used as an alternative view for a list or table. It is ideal for displaying images, charts, object cards, and other content, which profit from more height (but less width).

Design


<fdp-grid-list
    [id]="list Id"
    [noDataText]="no data present"
    [borderType]="all|none|inner"
    [grouping]="true|false"
    
 [selectionMode]="Delete|multiSelect|none|singleSelect|itemSelection|singleSelectMaster"
    [background]="solid|translucent|transparent"
    (delete)="handleDelete"
    (selectionChange)="onSelectionChange"
    >
<fdp-header 
    <fdp-grid-list-item 
           *ngFor="let item of listItems"
	   [title]="{{item.Name}}"
	   [description]="{{item.description}}" />............./>
<fdp-footer>{{item.footerText}}</fdp-footer>
</fdp-grid-list>

Property Bindings

id: string

id of the list component it is optional.

[noDataText]="no data present"

When the list contains no items then this message will be displayed.

[borderType]="all|none|inner"

   The property Show Separators (All, Inner, None) allows only the outer lines (Inner) or all the lines (None) 

to be hidden when the list is used as a more structural element within a content area.

[grouping]="true|false"

List items can be grouped. If it set to true <fdp-(list item type)-item> will have group header attribute value.

[selectionMode]="Delete|multiSelect|none|singleSelect|itemSelection|singleSelectMaster"

 The list can have several modes. The respective property (Mode) allows the following selection methods:

  * None
  •   SingleSelectMaster (used to pick one item with no additional indicator, as in the master list for a master- 
    
  •   detail scenario with the flexible column layout)
    
  •   SingleSelectLeft (used to pick one item using a radio button on the far left)
    
  •   MultiSelect (used to pick several items from the list using checkboxes on the far left). The Shift key can be used to select a range.
    
  •   Delete (used to delete items from the list using a delete indicator on the far right)
    

[background]="solid|translucent|transparent"

  Sets the background style for the controller. 
  Depending on the theme, we can change the state of the background from Solid/ to Translucent/ to Transparent.

Event Bindings

(delete)="handleDelete"

Fires when item is deleted by user interaction inside the List.

(selectionChange)="onSelectionChange"

Fires when selection is changed by user interaction inside the List.

Template:

<div id=“header”……../>
<div id=“body”>
<ul fd-list id="list”………………….>
 <ng-content></ng-content>
</ul>
</div>
<div id=“footer” …../>

Two-Way Bindings

N/A

Content Projection

N/A

Interfaces and Types

Related Modules

Additional Notes

*ngFor="let item of listItems"

To loop the list of items contained within this control.

Item types:

  1. Object List Item
  2. Standard List Item
  3. Action List Item
  4. Input List Item
  5. Display List Item

Questions:

Clone this wiki locally