Platform: List Component V1.0 Technical Design

List Component

Summary

List and table usually contain homogeneous data, but lists generally have rather basic data, whereas the data in tables tends to be more complex.

Lists are mostly used
    * The master list for a master-detail scenario using the flexible column layout,
    * In popovers or dialogs.

Design

<fdp-list
    [id]="list Id"
    *ngFor="let item of listItems"
    [headerTitle]="header title"
    [footerText]="footer text"
    [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-(object/standard/action/feed/display/input)list-item ............./>
</fdp-list>

Property Bindings

id: string

id of the list component it is optional.

*ngFor="let item of listItems"

To loop the list of items contained within this control.

[headerTitle]="header text"

Header text that appears in the List header.

[footerText]="footer text"

footer text that appears in the List footer.

[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

Questions:

Frank

• I am confused with the ngFor thign in there. Usually you have a list as container and list-items. so ngFor here is not the right thing what do you think?

• Is this headerText or Title / label? Let's be more specific Changes Done

• isBorder is more like a boolean hasboarder yes no, but when you have more options it does not fit in. more like borderType _ -Changes Done_

• You should think of to support both imperative as well as declarative way so most of the bindings here first more to list item and some to its parent container.

• I am not sure if I am clear about this <fd-object/// - Can you give some examples how it is going to be used ? -_Added above _

• is mode more selectionMode- Changes Done

• could this be also part of Form? Like showing some list of items?
  - As per Fiori3 Lists are mostly used in the master list for a master-detail scenario using the flexible column layout, as well as in popovers or dialogs. For certain use cases, lists can also be used in the dynamic page layout.

And as per my understanding in general, form does not shows huge list of data. We can use select, combobox,menu etc for it. Please let me know in case my understanding is correct.