The Ignite UI List Item component is a container intended for row items in the Ignite UI for Angular List component.

Example:

<igx-list>
  <igx-list-item isHeader="true">Contacts</igx-list-item>
  <igx-list-item *ngFor="let contact of contacts">
    <span class="name">{{ contact.name }}</span>
    <span class="phone">{{ contact.phone }}</span>
  </igx-list-item>
</igx-list>

Constructors

Section titled "Constructors"

IgxListItemComponent

new IgxListItemComponent(): IgxListItemComponent

Returns IgxListItemComponent

Properties

Section titled "Properties"

ariaLabel

Section titled "ariaLabel"

Sets/gets the aria-label attribute of the list item.

this.listItem.ariaLabel = "Item1";
let itemAriaLabel = this.listItem.ariaLabel;
ariaLabel: string

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:98

hidden

Section titled "hidden"

Sets/gets whether the list item is hidden. By default the hidden value is false.

<igx-list-item [hidden] = "true">Hidden Item</igx-list-item>
let isHidden =  this.listItem.hidden;
hidden: boolean = false

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:84

isHeader

Section titled "isHeader"

Sets/gets whether the list item is a header.

<igx-list-item [isHeader] = "true">Header</igx-list-item>
let isHeader =  this.listItem.isHeader;
isHeader: boolean

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:69

leftPanningTemplateElement

Section titled "leftPanningTemplateElement"

Provides a reference to the template's base element shown when left panning a list item.

const leftPanTmpl = this.listItem.leftPanningTemplateElement;
leftPanningTemplateElement: any

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:46

list

Section titled "list" 
list: IgxListBaseDirective

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:35

rightPanningTemplateElement

Section titled "rightPanningTemplateElement"

Provides a reference to the template's base element shown when right panning a list item.

const rightPanTmpl = this.listItem.rightPanningTemplateElement;
rightPanningTemplateElement: any

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:55

touchAction

Section titled "touchAction"

Gets the touch-action style of the list item.

let touchAction = this.listItem.touchAction;
touchAction: string = 'pan-y'

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:107

index

Section titled "index" 
index: number

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:153, projects/igniteui-angular/list/src/list/list-item.component.ts:165

role

Section titled "role" 
role: string

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:265, projects/igniteui-angular/list/src/list/list-item.component.ts:269

selected

Section titled "selected" 
selected: boolean

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:289, projects/igniteui-angular/list/src/list/list-item.component.ts:293

Accessors

Section titled "Accessors"

contentElement

Section titled "contentElement"

Returns a reference container which contains the list item's content.

let listItemContainer =  this.listItem.contentElement.
get contentElement(): any

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:189

Returns any

context

Section titled "context"

Returns the context object which represents the template context binding into the list item container by providing the $implicit declaration which is the IgxListItemComponent itself.

let listItemComponent = this.listItem.context;
get context(): any

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:201

Returns any

display

Section titled "display"

Returns string value which describes the display mode of the list item.

let isHidden = this.listItem.display;
get display(): string

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:332

Returns string

element

Section titled "element"

Returns an element reference to the list item.

let listItemElement =  this.listItem.element.
get element(): any

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:177

Returns any

headerStyle

Section titled "headerStyle"

Indicates whether list item should have header style.

let headerStyle =  this.listItem.headerStyle;
get headerStyle(): boolean

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:306

Returns boolean

innerStyle

Section titled "innerStyle"

Applies the inner style of the list item if the item is not counted as header.

let innerStyle =  this.listItem.innerStyle;
get innerStyle(): boolean

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:319

Returns boolean

maxLeft

Section titled "maxLeft"

Gets the maximum left position of the list item.

let maxLeft = this.listItem.maxLeft;
get maxLeft(): number

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:229

Returns number

maxRight

Section titled "maxRight"

Gets the maximum right position of the list item.

let maxRight = this.listItem.maxRight;
get maxRight(): any

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:241

Returns any

panState

Section titled "panState"

Gets the panState of a list item.

let itemPanState =  this.listItem.panState;
get panState(): IgxListPanState

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:140

Returns IgxListPanState

width

Section titled "width"

Gets the width of a list item.

let itemWidth = this.listItem.width;
get width(): any

Defined in projects/igniteui-angular/list/src/list/list-item.component.ts:215

Returns any