List
Simple List.
When To Use#
A list can be used to display content related to a single subject. The content can consist of multiple elements of varying type and size.
import { NzListModule } from 'ng-zorro-antd/list';
Examples
Default Size
Small Size
Large Size
Loading...
Loading...
Loading...
156 156 2
156 156 2
156 156 2
156 156 2
156 156 2
Loading...
Title 1
Card content
Title 2
Card content
Title 3
Card content
Title 4
Card content
Loading...
Title 1
Card content
Title 2
Card content
Title 3
Card content
Title 4
Card content
Title 5
Card content
Title 6
Card content
Loading...
Loading...
API#
nz-list#
Property | Description | Type | Default |
---|---|---|---|
[nzBordered] | Toggles rendering of the border around the list | boolean | false |
[nzFooter] | List footer renderer | string | TemplateRef<void> | - |
[nzHeader] | List header renderer | string | TemplateRef<void> | - |
[nzItemLayout] | The layout of list, default is horizontal , If a vertical list is desired, set the itemLayout property to vertical | 'vertical' | 'horizontal' | 'horizontal' |
[nzLoading] | Shows a loading indicator while the contents of the list are being fetched | boolean | false |
[nzSize] | Size of list | 'large' | 'small' | 'default' | 'default' |
[nzSplit] | Toggles rendering of the split under the list item | boolean | true |
nz-list-empty#
Empty content component for the list.
Property | Description | Type | Default |
---|---|---|---|
[nzNoResult] | Empty content | string | TemplateRef<void> | - |
nz-list[nzGrid]#
Use grid layout for the list.
nz-list-header#
Header component for the list.
nz-list-footer#
Footer component for the list.
nz-list-pagination#
Pagination component for the list.
nz-list-load-more#
Load more component for the list.
nz-list-item#
Property | Description | Type | Default |
---|---|---|---|
[nzNoFlex] | Whether it's not flex layout rendering | boolean | false |
ul[nz-list-item-actions]#
Actions container component for the list items.
nz-list-item-action#
Action component for the list items.
nz-list-item-extra#
Extra content for the list items.
nz-list-item-meta#
Property | Description | Type | Default |
---|---|---|---|
[nzAvatar] | The avatar of list item | string | TemplateRef<void> | - |
[nzDescription] | The description of list item | string | TemplateRef<void> | - |
[nzTitle] | The title of list item | string | TemplateRef<void> | - |
nz-list-item-meta-title#
Title component for the list items meta part.
nz-list-item-meta-description#
Description component for the list items meta part.
nz-list-item-meta-avatar#
Avatar component for the list items meta part.
Property | Description | Type | Default | Global Config |
---|---|---|---|---|
[nzSrc] | The address of the image for an image avatar | string | - |