The default constructor
The name of the template containing action heading layout
The name of the template containing actions for each item
The list config containing component properties
The name of the template used to contain expandable content for each item
The name of the template containing item heading layout
The name of the template containing item layout
An array of items to display in the list
The event emitted when an action (e.g., button, kebab, etc.) has been selected
The event emitted when an item has been clicked
The event emitted when an item is double clicked
The event emitted when an item pin has been changed
The event emitted when an item selection has been changed
Get the flag indicating list has no items
The flag indicating list has no items
Helper to generate selection change event
The selected item
Helper to generate double click event
The triggered event
The double clicked item
Helper to deselect given items items and children
The items to be deselected
Return component config
ListConfig The component config
Return an ID for the given element prefix and index (e.g., 'pfng-list1-item0')
Note: The ID prefix can be overridden by providing an id for the pfng-list tag.
The element suffix (e.g., 'item')
The current item index
Helper to retrieve selected items
The items containing possible selections
A list of selected items
Helper to generate action select event
The selected action
Check if the component config has changed
Setup component configuration upon initialization
Helper to generate selection change event
The selected item
Select or deselect an item
The item to select or deselect
True if item should be selected
Helper to select a single item and deselect all others
The item to select
Set up default config
Helper to toggle item selection
The triggered event
The item to select
Generated using TypeDoc
List component
For items, use a template named itemTemplate to contain content for each item. For each item in the items array, the expansion can be disabled by setting disabled to true on the item. If using actions, use a template named actionTemplate to contain expandable content for the actions of each item. If using expand items, use a template named itemExpandedTemplate to contain expandable content for each item.
Cannot use both multi-select and double click selection at the same time Cannot use both checkbox and click selection at the same time
Unique IDs are generated for each list item, which can be overridden by providing an id for the pfng-list tag.
Usage:
// NGX Bootstrap import { BsDropdownConfig, BsDropdownModule } from 'ngx-bootstrap/dropdown'; import { TooltipConfig, TooltipModule } from 'ngx-bootstrap/tooltip';
@NgModule({ imports: [ListModule, BsDropdownModule.forRoot(), TooltipModule.forRoot(),...], providers: [BsDropdownConfig, TooltipConfig] }) export class AppModule(){}
Optional: