Web Components List Overview

    The Ignite UI for Web Components List element is extremely useful when presenting a group of items. You can create a simple list of textual items, or a more complex one, containing an array of different layout elements. The IgcListComponent component displays rows of items and supports one or more headers as well. Each list item is completely templatable and will support any valid HTML or other components.

    Web Components List Example

    The following example represents a list populated with contacts with a name and a phone number properties. The IgcListComponent component demonstrated below uses the IgcAvatarComponent and IgcButtonComponent elements to enrich the user experience and expose the capabilities of setting avatar picture and buttons for text and call actions.

    Usage

    At its core the list web component allows you to easily display a vertical list of items.

    First, you need to install the Ignite UI for Web Components by running the following command:

    npm install igniteui-webcomponents
    
    import { defineComponents, IgcListComponent } from 'igniteui-webcomponents';
    
    defineComponents(IgcListComponent);
    

    Add List Items

    Now, we can add the following code to get a simple list of items:

        <igc-list>
            <igc-list-header>Header</igc-list-header>
            <igc-list-item>
                <h2 slot="title">Item 1</h2>
            </igc-list-item>
            <igc-list-item>
                <h2 slot="title">Item 2</h2>
            </igc-list-item>
            <igc-list-item>
                <h2 slot="title">Item 3</h2>
            </igc-list-item>
        </igc-list>
    

    If all went well, you should see the following in your browser:

    Let's up our game a bit and enhance our list items. Say we want to create a list of contacts with a name and a phone number displayed under the name. To achieve that we can use some of the slots that come with the list items as demonstrated in the next example:

    <igc-list>
        <igc-list-header>
            <h1>Contacts</h1>
        </igc-list-header>
        <igc-list-item>
            <h2 slot="title">Terrance Orta</h2>
            <span slot="subtitle">770-504-2217</span>
        </igc-list-item>
        <igc-list-item>
            <h2 slot="title">Richard Mahoney</h2>
            <span slot="subtitle">423-676-2869</span>
        </igc-list-item>
        <igc-list-item>
            <h2 slot="title">Donna Price</h2>
            <span slot="subtitle">859-496-2817</span>
        </igc-list-item>
    </igc-list>
    

    After implementing the above code, our list component should now look like the following:

    Adding Avatar and Buttons

    We can use some of our other components in conjunction with the IgcListComponent component to enrich the experience and add some functionality. We can have a nice picture avatar to the left of the name and phone values. Additionally, we can add some buttons to the right of them to allow the user to text and call contacts, so let's update our contacts list component to show the avatar and the buttons. We can do that by using some of the list item's slots.

        <igc-list>
            <igc-list-header>
                <h1>Job Positions</h1>
            </igc-list-header>
            <igc-list-item>
                <igc-avatar slot="start" src="https://randomuser.me/api/portraits/men/27.jpg" shape="circle">
                    AA
                </igc-avatar>
                <h2 slot="title">Terrance Orta</h2>
                <span slot="subtitle">770-504-2217</span>
                <igc-button slot="end" variant="outlined">
                    Text
                </igc-button>
                <igc-button slot="end" variant="outlined">
                    Call
                </igc-button>
            </igc-list-item>
            <igc-list-item>
                <igc-avatar slot="start" src="https://randomuser.me/api/portraits/men/1.jpg" shape="circle">
                    AA
                </igc-avatar>
                <h2 slot="title">Richard Mahoney</h2>
                <span slot="subtitle">423-676-2869</span>
                <igc-button slot="end" variant="outlined">
                    Text
                </igc-button>
                <igc-button slot="end" variant="outlined">
                    Call
                </igc-button>
            </igc-list-item>
            <igc-list-item>
                <igc-avatar slot="start" src="https://randomuser.me/api/portraits/women/50.jpg" shape="circle">
                    AA
                </igc-avatar>
                <h2 slot="title">Donna Price</h2>
                <span slot="subtitle">859-496-2817</span>
                <igc-button slot="end" variant="outlined">
                    Text
                </igc-button>
                <igc-button slot="end" variant="outlined">
                    Call
                </igc-button>
            </igc-list-item>
        </igc-list>
    

    The start slot is meant to be used for adding some kind of media before all other content of our list items. The target element, in our case the IgcAvatarComponent component, will also be provided with a default position and spacing.

    The end slot is meant to be used for list items that have some kind of action or metadata, represented, for example, by a switch, a button, a checkbox, etc. We will use IgcButtonComponent components.

    Let's also allow the user to choose the size of the list by using its size property. We will add some radio buttons to display all size values. This way whenever one gets selected, we will change the size property of the list.

    <igc-radio-group id="radio-group" alignment="horizontal">
        <igc-radio name="size" value="small" label-position="after">Small</igc-radio>
        <igc-radio name="size" value="medium" label-position="after">Medium</igc-radio>
        <igc-radio name="size" value="large" label-position="after" checked="true">Large</igc-radio>
    </igc-radio-group>
    
    this.list = document.getElementById('list') as IgcListComponent;
    this.radioGroup = document.getElementById('radio-group') as IgcRadioGroupComponent;
    
    this.radioGroup.addEventListener('click', (radio: any) => {
        this.list.size = radio.target.value;
    });
    

    The result of implementing the above code should look like the following:

    Styling

    You can change the appearance of our list, by using some of the exposed CSS parts - title, subtitle and end.

    igc-list-header {
        font-size: 20px;
        font-weight: 700;
        color: #3f51b5;
    }
    
    igc-list-item::part(title) {
        font-size: 18px;
        color: #3f51b5;
    }
    
    igc-list-item::part(subtitle) {
        color: #0099ff;
    }
    
    igc-list-item::part(end) {
        --ig-secondary-500: 230,48%,47%;
    }
    

    API References

    In this article we covered a lot of ground with the IgcListComponent component. First, we created a simple list with text items. Then, we created a list of contact items and added functionality to them by using some additional Ignite UI for Web Components components, like the IgcAvatarComponent and IgcButtonComponent. Finally, we changed the component's appearance through the exposed CSS parts.

    Additional components that were used:

    Additional Resources

    API Members