# Titanium.UI.ListView

A list view is used to present information, organized in to sections and items, in a vertically-scrolling view.

Availability
3.1.0
3.1.0
9.2.0
4.1.0

# Overview

Android iOS Windows
Android iOS Windows

Use the Titanium.UI.createListView method or <ListView> Alloy element to create a ListView.

A ListView object is a container for Titanium.UI.ListSection objects that are, in turn, containers for Titanium.UI.ListItem objects. This is easily visualized as an Alloy view:

<Alloy>
    <ListView id="list">
        <ListSection>
            <ListItem title="List item 1"></ListItem>
            <ListItem title="List item 2"></ListItem>
            <ListItem title="List item 3"></ListItem>
        </ListSection>
    </ListView>
</Alloy>

For more instructions and examples of using ListView, refer to the ListViews guide (opens new window).

# Creating a List

To create a ListView object using JavaScript, pass an array of ListDataItem objects to the list section's Titanium.UI.ListSection.items property, which creates and adds each array element as a row to a single Titanium.UI.ListSection. Use the ListView's Titanium.UI.ListView.sections property to add the section(s) to the list view.

By default, only the image, title and accessoryType of a list data item are displayed in the list. Refer to the next section for using an item template.

See the "List View Sections" example.

# Customizing the List Items

To create a custom list view, you need to define an ItemTemplate and define each view component you want to add. Use the bindId property of the child template to bind a dictionary property in the item data to a child view component.

Map the template to a style name using the Titanium.UI.ListView.templates property, then use the style name to set the Titanium.UI.ListView.defaultItemTemplate property to globally change all item styles or set the ListDataItem.template property when passing in your list data to apply the template to that one list item or to override the globally defined template.

On iOS, you can specify one of the template constants for the ListDataItem.template property or Titanium.UI.ListView.defaultItemTemplate: Titanium.UI.LIST_ITEM_TEMPLATE_CONTACTS, Titanium.UI.LIST_ITEM_TEMPLATE_SETTINGS or Titanium.UI.LIST_ITEM_TEMPLATE_SUBTITLE.

See Titanium.UI.ListItem for a detailed description of creating list items with a custom item template and see the "List View with Custom Item Template" example for a sample.

# List and Table Views

This section describes the differences between the new list view and the old table view.

ListView is analogous to TableView, ListSection is analogous to TableViewSection, and ListItem is analogous to TableViewRow.

Both list view and table view present data to user as a vertically scrolling list of rows. However, list view uses a data-oriented approach versus table view's view-oriented approach.

List view is designed for performance. One side effect of the design is that you cannot directly manipulate the views--add children, set view properties and bind event callbacks--as you can in TableView. Instead, you interact with list items indirectly, using templates and data items. The next subsection describes how to use list items.

# ListItem versus TableViewRow

With TableView, you can directly add rows to a table view using the data property and its accessors. With TableViewRows, you can directly create a row using the Ti.UI.createTableViewRow and customize its styling by setting its view properties. You can add view subcomponents to the row using the add method.

With ListView, you need to explicitly create a ListSection in order to add a ListItem to a ListView. You cannot directly add a ListItem to a ListView. In a TableView, a TableViewRow can be directly added to a TableView because a TableViewSection is implicitly created and added to the TableView.

A ListItem object is not created in the same method as a TableViewRow. A ListItem is created by passing an array of ListDataItem objects to the ListSection.

You cannot add views to a ListItem using the add method, which could be done with a TableViewRow. To add views to a ListItem, you need to define an ItemTemplate, which is bound to a list data item using the template property.

You cannot explicitly set properties or bind events for a ListItem. You have to set them using the properties dictionary of a ListDataItem or ItemTemplate and the events dictionary of the ItemTemplate or ViewTemplate, respectively.

# API Differences

  • TableViewRow properties: The following properties and their accessors are not available for ListItem: accessibilityLabel, className, editable, hasCheck, hasChild, hasDetail, leftImage, moveable and rightImage.

    • For hasCheck, hasChild, and hasDetail, use the accessoryType property.
    • For leftImage and rightImage, use the image property or create a custom item template.
  • TableViewRow methods: ListItem does not support any methods. Adding views and binding event callbacks are supported through the item template.

  • TableViewSection properties: The following properties and their accessors are not supported by ListSection: rows and rowCount.

    • For rows, use the items property.
    • For rowCount, use the itemCount property. (Not yet implemented.)
  • TableViewSection methods: The following methods are not supported by ListSection: add, remove and rowAtIndex.

    • For rowAtIndex, use the getItemAt method.
    • For add and remove, use the other ListSection methods to manipulate the ListItem objects in the ListSection.
  • TableView properties: The data property and its accessors are not available for ListView. Use the sections property to set the ListSections for a ListView. You cannot directly add ListItem objects to a ListView.

  • TableView methods: The following methods are not available to ListView: appendRow, deleteRow, deselectRow, insertRowAfter, insertRowBefore, selectRow, updateRow, scrollToIndex and selectRow.

    • For scrollToIndex, use the scrollToItem method.
    • For selectRow, use the selectItem method. (Currently implemented only for iOS.)
    • For all other row methods, you cannot manipulate ListItems with a ListView. You have to manipulate them with the ListSection they are contained in.

# List and Scroll Views

As a list view inherently scrolls, it creates a very poor user experience when it contains other scrolling views, such as a Titanium.UI.ScrollableView or Titanium.UI.TextArea. Thus, this layout is strongly discouraged.

# TextFields in Lists with SOFT_INPUT_ADJUST_PAN (Android)

In order to use Titanium.UI.TextField inside ListView, Titanium.UI.Android.SOFT_INPUT_ADJUST_PAN must be set to the window that is containing the ListView, otherwise the Titanium.UI.TextField may not be able to gain focus.

When a Titanium.UI.TextField is placed in a row near the bottom of a ListView, in a window that is configured with Titanium.UI.Android.SOFT_INPUT_ADJUST_PAN, it is expected for the text field to automatically move to a visible position after it is focused and the software keyboard displayed. However, due to a known problem caused by native Android's ListView behavior, the keyboard is likely to completely obscure the text field.

To mitigate this, a ScrollView may be used instead of a list view, as demonstrated in the Titanium.UI.ScrollView, "Scroll View as a Table View", example.

# Editing Support

Editing a ListView through user initiated actions is supported through the following properties.

# Examples

# List View Sections

Creates a list with three sections, each with two rows. Adds two sections to the table before and one after it is rendered.

var win = Ti.UI.createWindow({backgroundColor: 'gray'});
var listView = Ti.UI.createListView();
var sections = [];

var fruitDataSet = [
    {properties: { title: 'Apple'}},
    {properties: { title: 'Banana'}},
];
var fruitSection = Ti.UI.createListSection({ headerTitle: 'Fruits', items: fruitDataSet});
sections.push(fruitSection);

var vegDataSet = [
    {properties: { title: 'Carrots'}},
    {properties: { title: 'Potatoes'}},
];
sections.push(vegSection);
var vegSection = Ti.UI.createListSection({ headerTitle: 'Vegetables', items: vegDataSet});

listView.sections = sections;
win.add(listView);
win.open();

var fishDataSet = [
    {properties: { title: 'Cod'}},
    {properties: { title: 'Haddock'}},
];
var fishSection = Ti.UI.createListSection({ headerTitle: 'Fish', items: fishDataSet});
listView.appendSection(fishSection);

# List View with Custom Item Template

Modifies the previous example to create a list using an item template to customize the view layout.

var win = Ti.UI.createWindow({backgroundColor: 'white'});

// Create a custom template that displays an image on the left,
// then a title next to it with a subtitle below it.
var myTemplate = {
    childTemplates: [
        {                            // Image justified left
            type: 'Ti.UI.ImageView', // Use an image view for the image
            bindId: 'pic',           // Maps to a custom pic property of the item data
            properties: {            // Sets the image view  properties
                width: '50dp', height: '50dp', left: 0
            }
        },
        {                            // Title
            type: 'Ti.UI.Label',     // Use a label for the title
            bindId: 'info',          // Maps to a custom info property of the item data
            properties: {            // Sets the label properties
                color: 'black',
                font: { fontFamily:'Arial', fontSize: '20dp', fontWeight:'bold' },
                left: '60dp', top: 0,
            }
        },
        {                            // Subtitle
            type: 'Ti.UI.Label',     // Use a label for the subtitle
            bindId: 'es_info',       // Maps to a custom es_info property of the item data
            properties: {            // Sets the label properties
                color: 'gray',
                font: { fontFamily:'Arial', fontSize: '14dp' },
                left: '60dp', top: '25dp',
            }
        }
    ]
};

var listView = Ti.UI.createListView({
    // Maps myTemplate dictionary to 'template' string
    templates: { 'template': myTemplate },
    // Use 'template', that is, the myTemplate dict created earlier
    // for all items as long as the template property is not defined for an item.
    defaultItemTemplate: 'template'
});
var sections = [];

var fruitDataSet = [
    // the text property of info maps to the text property of the title label
    // the text property of es_info maps to text property of the subtitle label
    // the image property of pic maps to the image property of the image view
    { info: {text: 'Apple'}, es_info: {text: 'Manzana'}, pic: {image: 'apple.png'}},
    { info: {text: 'Banana'}, es_info: {text: 'Banana'}, pic: {image: 'banana.png'}}
];
var fruitSection = Ti.UI.createListSection({ headerTitle: 'Fruits / Frutas', items: fruitDataSet});
sections.push(fruitSection);

var vegDataSet = [
    { info: {text: 'Carrot'}, es_info: {text: 'Zanahoria'}, pic: {image: 'carrot.png'}},
    { info: {text: 'Potato'}, es_info: {text: 'Patata'}, pic: {image: 'potato.png'}}
];
var vegSection = Ti.UI.createListSection({ headerTitle: 'Vegetables / Verduras', items: vegDataSet});
sections.push(vegSection);

var grainDataSet = [
    { info: {text: 'Corn'}, es_info: {text: 'Maiz'}, pic: {image: 'corn.png'}},
    { info: {text: 'Rice'}, es_info: {text: 'Arroz'}, pic: {image: 'rice.png'}}
];
var grainSection = Ti.UI.createListSection({ headerTitle: 'Grains / Granos', items: grainDataSet});
sections.push(grainSection);

listView.sections = sections;
win.add(listView);
win.open();

# List View with a pullView

This sample shows how the Titanium.UI.ListView.pullView property could be utilized along with the Titanium.UI.ListView.pull and Titanium.UI.ListView.pullend events to create a refresh control.

var win = Ti.UI.createWindow({backgroundColor: 'white'});
var listView = Ti.UI.createListView({height:'90%', top:0});
var sections = [];

var fruitDataSet = [
    {properties: { title: 'Apple'}},
    {properties: { title: 'Banana'}},
];
var fruitSection = Ti.UI.createListSection({ headerTitle: 'Fruits', items: fruitDataSet});
sections.push(fruitSection);

var vegDataSet = [
    {properties: { title: 'Carrots'}},
    {properties: { title: 'Potatoes'}},
];
var vegSection = Ti.UI.createListSection({ headerTitle: 'Vegetables', items: vegDataSet});

var fishDataSet = [
    {properties: { title: 'Cod'}},
    {properties: { title: 'Haddock'}},
];
var fishSection = Ti.UI.createListSection({ headerTitle: 'Fish', items: fishDataSet});

listView.sections = sections;
var refreshCount = 0;

function getFormattedDate(){
    var date = new Date();
    return date.getMonth() + '/' + date.getDate() + '/' + date.getFullYear() + ' ' + date.getHours() + ':' + date.getMinutes();
}

function resetPullHeader(){
    actInd.hide();
    imageArrow.transform=Ti.UI.createMatrix2D();
    if (refreshCount < 2) {
        imageArrow.show();
        labelStatus.text = 'Pull down to refresh...';
        labelLastUpdated.text = 'Last Updated: ' + getFormattedDate();
    } else {
        labelStatus.text = 'Nothing To Refresh';
        labelLastUpdated.text = 'Last Updated: ' + getFormattedDate();
        listView.removeEventListener('pull', pullListener);
        listView.removeEventListener('pullend', pullendListener);
        eventStatus.text = 'Removed event listeners.';
    }
    listView.setContentInsets({top:0}, {animated:true});
}

function loadTableData()
{
    if (refreshCount == 0) {
        listView.appendSection(vegSection);
    } else if (refreshCount == 1) {
        listView.appendSection(fishSection);
    }
    refreshCount ++;
    resetPullHeader();
}

function pullListener(e){
    eventStatus.text = 'EVENT pull FIRED. e.active = '+e.active;
    if (e.active == false) {
        var unrotate = Ti.UI.createMatrix2D();
        imageArrow.animate({transform:unrotate, duration:180});
        labelStatus.text = 'Pull down to refresh...';
    } else {
        var rotate = Ti.UI.createMatrix2D().rotate(180);
        imageArrow.animate({transform:rotate, duration:180});
        if (refreshCount == 0) {
            labelStatus.text = 'Release to get Vegetables...';
        } else {
            labelStatus.text = 'Release to get Fish...';
        }
    }
}

function pullendListener(e){
    eventStatus.text = 'EVENT pullend FIRED.';

    if (refreshCount == 0) {
        labelStatus.text = 'Loading Vegetables...';
    } else {
        labelStatus.text = 'Loading Fish...';
    }
    imageArrow.hide();
    actInd.show();
    listView.setContentInsets({top:80}, {animated:true});
    setTimeout(function(){
        loadTableData();
    }, 2000);
}

var tableHeader = Ti.UI.createView({
    backgroundColor:'#e2e7ed',
    width:320, height:80
});

var border = Ti.UI.createView({
    backgroundColor:'#576c89',
    bottom:0,
    height:2
});
tableHeader.add(border);

var imageArrow = Ti.UI.createImageView({
    image:'arrow.png',
    left:20, bottom:10,
    width:23, height:60
});
tableHeader.add(imageArrow);

var labelStatus = Ti.UI.createLabel({
    color:'#576c89',
    font:{fontSize:13, fontWeight:'bold'},
    text:'Pull down to refresh...',
    textAlign:'center',
    left:55, bottom:30,
    width:200
});
tableHeader.add(labelStatus);

var labelLastUpdated = Ti.UI.createLabel({
    color:'#576c89',
    font:{fontSize:12},
    text:'Last Updated: ' + getFormattedDate(),
    textAlign:'center',
    left:55, bottom:15,
    width:200
});
tableHeader.add(labelLastUpdated);

var actInd = Ti.UI.createActivityIndicator({
    left:20, bottom:13,
    width:30, height:30
});
tableHeader.add(actInd);
listView.pullView = tableHeader;
listView.addEventListener('pull', pullListener);
listView.addEventListener('pullend',pullendListener);

var eventStatus = Ti.UI.createLabel({
    font:{fontSize:13, fontWeight:'bold'},
    text: 'Event data will show here',
    bottom:0,
    height:'10%'
})

win.add(listView);
win.add(eventStatus);
win.open();

# Alloy XML Markup

'List View with Custom Item Template' as an Alloy view. List view markup is supported in Alloy 1.2.0 and later.

app/views/index.xml:

<Alloy>
    <Window backgroundColor="white">
        <ListView id="listView" defaultItemTemplate="template">

            <!-- The Templates tag sets the ListView's templates property -->

            <Templates>

                <!-- Define your item templates within the Templates tags or use the
                      Require tag to include a view that only contains an ItemTemplate -->

                <ItemTemplate name="template">
                    <ImageView bindId="pic" id="icon" />
                    <Label bindId="info" id="title" />
                    <Label bindId="es_info" id="subtitle" />
                </ItemTemplate>

            </Templates>

            <ListSection headerTitle="Fruit / Frutas">

                <!-- You can specify any ListItem or ListDataItem properties in ListItem -->

                <!-- Specify data to bind to the item template with inline attributes
                      defined as <bindId>:<Ti.UI.Component.property> -->

                <ListItem info:text="Apple" es_info:text="Manzana" pic:image="/apple.png" />
                <ListItem info:text="Banana" es_info:text="Banana" pic:image="/banana.png" />
            </ListSection>
            <ListSection headerTitle="Vegetables / Verduras">
                <ListItem info:text="Carrot" es_info:text="Zanahoria" pic:image="/carrot.png" />
                <ListItem info:text="Potato" es_info:text="Patata" pic:image="/potato.png" />
            </ListSection>
            <ListSection headerTitle="Grains / Granos">
                <ListItem info:text="Corn" es_info:text="Maiz" pic:image="/corn.png" />
                <ListItem info:text="Rice" es_info:text="Arroz" pic:image="/rice.png" />
            </ListSection>
        </ListView>
    </Window>
</Alloy>

app/styles/index.tss:

"#icon" : {
    width: '50dp', height: '50dp', left: 0
},
"#title" : {
    color: 'black',
    font: { fontFamily:'Arial', fontSize: '20dp', fontWeight:'bold' },
    left: '60dp', top: 0
},
"#subtitle" : {
    color: 'gray',
    font: { fontFamily:'Arial', fontSize: '14dp' },
    left: '60dp', top: '25dp'
}

# Alloy example of ListView properties

Supported in Alloy 1.3.0 and later.

In Alloy, ListView's searchView, headerView, footerView, and pullView properties may be declared as XML elements inline with the ListView element. The example below demonstrates how to use searchView, headerView and footerView.

<Alloy>
    <Window fullscreen="true">
        <ListView>
            <!-- Sets ListView's searchView property.
                  For Android, you can also do <SearchView platform="android" />
                  to use a Ti.UI.Android.SearchView instead of a search bar. -->
            <SearchBar barColor="#000" />

            <!-- Sets ListView's headerView property -->
            <HeaderView>
                <View backgroundColor="#DDD" height="Ti.UI.SIZE">
                    <Label>Header View</Label>
                </View>>
            </HeaderView>

            <ListSection>
                <ListItem title="Papaya" searchableText="Papaya"/>
                <ListItem title="Peach" searchableText="Peach"/>
                <ListItem title="Pear" searchableText="Pear"/>
                <ListItem title="Persimmon" searchableText="Persimmon"/>
                <ListItem title="Pineapple" searchableText="Pineapple"/>
                <ListItem title="Pluot" searchableText="Pluto"/>
                <ListItem title="Pomegranate" searchableText="Pomegranate"/>
            </ListSection>

            <!-- Sets ListView's footerView property -->
            <FooterView>
                <View backgroundColor="#DDD" height="Ti.UI.SIZE">
                    <Label>Footer View</Label>
                </View>
            </FooterView>
        </ListView>
    </Window>
</Alloy>

# Alloy example of <PullView> element

The example below demonstrates how to use a <PullView> Alloy element.

<!-- views/index.xml -->
<Alloy>
    <Window class="container" >
        <ListView id="list">
            <ListSection>
                <ListItem title="Number 1"></ListItem>
                <ListItem title="Number 2"></ListItem>
            </ListSection>
            <PullView>
                <View backgroundColor="red" height="50">
                    <Label>Release to reload</Label>
                </View>
            </PullView>
        </ListView>
    </Window>
</Alloy>

# Properties

# allowsMultipleSelectionDuringEditing

Availability
10.1.0
7.0.0
9.2.0
allowsMultipleSelectionDuringEditing :Boolean

Determines whether multiple items of this list view can be selected at the same time while editing the table.

Default: false


# allowsMultipleSelectionInteraction

Availability
10.1.0
8.2.0
9.2.0
allowsMultipleSelectionInteraction :Boolean

Allows a two-finger pan gesture to automatically transition the table view into editing mode and start selecting rows.

Setting this property to true allows the user to start selecting multiple contiguous rows via a two-finger pan gesture. If the table view is already in editing mode, the user can also select multiple rows via a one-finger pan gesture along the edge of the table that contains editing controls (checkboxes). In order to support this behavior, you must also set allowsMultipleSelectionDuringEditing to true. Once user interaction stops the itemsselected event is fired.

Default: false


# allowsSelection

Availability
3.1.0
9.2.0
allowsSelection :Boolean

Determines whether this item can be selected.

Set to false to prevent the item from being selected.

On iOS, even if this property is set to false, you can interact with the detail disclosure accessory (accessoryType set to LIST_ACCESSORY_TYPE_DETAIL) and any child templates that are controls, such as a button, slider, etc.

Default: true


# allowsSelectionDuringEditing

Availability
10.1.0
5.4.0
9.2.0
allowsSelectionDuringEditing :Boolean

Determines whether this list view items can be selected while editing the table.

Default: false


# canScroll

Availability
6.1.0
3.2.0
9.2.0
canScroll :Boolean

Determines if the list view can scroll in response to user actions.

Set to false to disable scrolling.

Default: true


# caseInsensitiveSearch

Availability
3.2.0
3.2.0
9.2.0
4.1.0
caseInsensitiveSearch :Boolean

Determines if the search performed is case insensitive.

Used in conjunction with searchView and searchText properties of List View and searchableText property of List Item.

Default: true


# defaultItemTemplate

Availability
3.1.0
3.1.0
9.2.0
4.1.0
defaultItemTemplate :String | Number

Sets the default template for list data items that do not specify the template property.

Can be set to any of the built-in templates or those defined in the templates property.

Can be changed dynamically.

Default: Titanium.UI.LIST_ITEM_TEMPLATE_DEFAULT


# dimBackgroundForSearch CREATION ONLY

Availability
6.2.0
9.2.0
dimBackgroundForSearch :Boolean

A Boolean indicating whether the underlying content is dimmed during a search.

If you do not want to show the dimmed background when clicking on the search bar, set this property false during creation.

Default: true


# disableBounce

Availability
5.4.0
9.2.0
disableBounce :Boolean

Determines whether the scroll-bounce of the list view should be disabled.

Set to true to disable the vertical bounce.

Default: false


# editing

Availability
9.3.0
3.2.0
9.2.0
editing :Boolean

Determines if the list view is currently in editing mode.

For more information see the "Editing Support" section of Titanium.UI.ListView.

Default: false


# fastScroll

Availability
7.5.0
fastScroll :Boolean

Sets the fastScroll mode on Android ListViews.

Set to true to enable fastScroll mode. When fast scrolling is enabled, the user can quickly scroll through lists by dragging the fast scroll thumb.

Default: false


# footerDividersEnabled CREATION ONLY

Availability
3.3.0
footerDividersEnabled :Boolean

When set to false, the ListView will not draw the divider before the footer view.

Default: undefined but behaves as false


# footerTitle

Availability
3.1.0
3.1.0
9.2.0
4.1.0
footerTitle :String

List view footer title.


# footerView

Availability
3.2.0
3.2.0
9.2.0
4.1.0
footerView :Titanium.UI.View

List view footer as a view that will be rendered instead of a label.

In Alloy you can specify this property with a <FooterView> child element of a <ListView> element (see Examples). On Android, this is a creation only property.


# headerDividersEnabled CREATION ONLY

Availability
3.3.0
headerDividersEnabled :Boolean

When set to false, the ListView will not draw the divider after the header view.

Default: undefined but behaves as false


# headerTitle

Availability
3.1.0
3.1.0
9.2.0
4.1.0
headerTitle :String

List view header title.


# headerView

Availability
3.2.0
3.2.0
9.2.0
4.1.0
headerView :Titanium.UI.View

List view header as a view that will be rendered instead of a label.

On Android, this is a creation only property. In Alloy you can specify this property with a <HeaderView> child element of a <ListView> element (see Examples).


# keepSectionsInSearch

Availability
3.2.0
9.2.0
keepSectionsInSearch :Boolean

Determines if the section information is displayed in the search results when using the searchText property.

Used in conjunction with searchText property of List View and searchableText property of List Item.

Default: false


# keyboardDismissMode

Availability
6.0.0
9.2.0
keyboardDismissMode :Number

The manner in which the keyboard is dismissed when a drag begins in the list view.

Default: Undefined (behaves like <Titanium.UI.iOS.KEYBOARD_DISMISS_MODE_NONE>)


# lazyLoadingEnabled

Availability
5.1.0
9.2.0
lazyLoadingEnabled :Boolean

Determines if the list view should use lazy loading to load remote images.

Lazy loading is used to load remote images only if they are in the visible view area. It is enabled by default. If you disable it, images will be loaded even if they are currently not visible. Disabling improves the loading of images, but can also cause trouble in list views having a lot of remote images, because every remote image opens a new HTTP request.

Default: true


# listSeparatorInsets

Availability
5.4.0
9.2.0
listSeparatorInsets :HorizontalInsets

The insets for the list view header and footer.

Cell separators do not extend all the way to the edge of the list view. Set this to a dictionary with two keys, left specifying inset from left edge and right specifying the inset from the right edge. If the rowSeparatorInsets is not set, the listSeparatorInsets will also set the cell insets.

For example:

listView.listSeparatorInsets = {
    left: 10,
    right: 10
};

# pruneSectionsOnEdit

Availability
3.2.0
9.2.0
pruneSectionsOnEdit :Boolean

Determines if empty sections are retained when the user completes editing the list view.

For more information see the "Editing Support" section of Titanium.UI.ListView.

Default: false


# pullView

Availability
3.2.0
9.2.0
pullView :Titanium.UI.View

View positioned above the first row that is only revealed when the user drags the list view contents down.

A pullView is a UI control that is often used to provide a convenient way for the user to refresh a table's data. Typically used in conjunction with setContentInsets method and pull and pullend events.

To specify the wrapper color see pullBackgroundColor.

In Alloy you can assign this property with a <PullView> child element of a <ListView> element:

<Alloy>
  <ListView>
    <ListSection>
      <ListItem title="Item a"></ListItem>
      <ListItem title="Item b"></ListItem>
      <ListItem title="Item c"></ListItem>
    </ListSection>
    <PullView>
      <View height="50" backgroundColor="black">
        <Label/>
      </View>
    </PullView>
  </ListView>
</Alloy>

See the code example on pullView to see how it may be utilized.


# refreshControl

Availability
6.2.0
3.2.0
9.2.0
refreshControl :Titanium.UI.RefreshControl

View positioned above the first row that is only revealed when the user drags the list view contents down.

An alternate to the pullView property. See Titanium.UI.RefreshControl for usage and examples.


# resultsBackgroundColor CREATION ONLY

Availability
6.1.0
9.2.0
resultsBackgroundColor :String | Titanium.UI.Color

The background color of the search results (iOS-only).

For information about color values, see the "Colors" section of Titanium.UI. Note: A transparent background-color is not officially supported by Apple to prevent that the list of results overlaps with the list view below it.

Default: undefined (behaves as white)


# resultsSeparatorColor CREATION ONLY

Availability
6.1.0
9.2.0
resultsSeparatorColor :String | Titanium.UI.Color

Separator line color between rows inside search results, as a color name or hex triplet (iOS-only).

To make the line invisible, set this property to transparent, or the same value as the backgroundColor property. For information about color values, see the "Colors" section of Titanium.UI.

Default: undefined (behaves as gray)


# resultsSeparatorInsets CREATION ONLY

Availability
6.1.0
9.2.0
resultsSeparatorInsets :HorizontalInsets

The insets for search results separators (applies to all cells & iOS-only).

Cell separators do not extend all the way to the edge of the list view. This property sets the default inset for all cells in the table. Set this to a dictionary with two keys, left specifying inset from left edge and right specifying the inset from the right edge.


# resultsSeparatorStyle CREATION ONLY

Availability
6.1.0
9.2.0
resultsSeparatorStyle :Number

The separator style of the search results (iOS-only).


# rowSeparatorInsets

Availability
5.2.0
9.2.0
rowSeparatorInsets :HorizontalInsets

The insets for list view cells (applies to all cells).

Cell separators do not extend all the way to the edge of the list view. Set this to a dictionary with two keys, left specifying inset from left edge and right specifying the inset from the right edge. This property is only available upon creation of the cells.

For example:

listView.rowSeparatorInsets = {
    left: 10,
    right: 10
};

# scrollIndicatorStyle

Availability
3.1.0
9.2.0
scrollIndicatorStyle :Number

Style of the scrollbar.

Default: Titanium.UI.iOS.ScrollIndicatorStyle.DEFAULT


# searchText

Availability
3.2.0
3.2.0
9.2.0
4.1.0
searchText :String

The string to use as the search parameter.

Provides a generic search API for the List View. This property can not be used when the searchView property is set. Used in conjunction with caseInsensitiveSearch property of List View and searchableText property of List Item.

On iOS, when using this property the style property of the List View is honored. If the keepSectionsInSearch property is set to true then section information is preserved in the search results, otherwise the search results are displayed in a single section.


# searchView

Availability
3.2.0
3.2.0
9.2.0
4.1.0

Search field to use for the list view.

Provides the same functionality as the search property in Titanium.UI.TableView. Used in conjunction with caseInsensitiveSearch property of List View and searchableText property of List Item.

On Android, you can either specify Titanium.UI.SearchBar or Titanium.UI.Android.SearchView, while on iOS only Titanium.UI.SearchBar is supported.

In an Alloy application, you can use a <SearchView> or <SearchBar> element inside a <ListView> element.

<Alloy>
    <ListView>
        <!-- search, shorthand with Ti.UI.SearchBar -->
      <SearchBar class="search" platform="ios"/>
      <!-- search, shorthand with Ti.UI.Android.SearchView -->
      <SearchView ns="Ti.UI.Android" class="search" platform="android"/>
    </ListView>
</Alloy>

# sectionCount READONLY

Availability
3.1.0
3.1.0
9.2.0
4.1.0
sectionCount :Number

Number of sections in this list view.


# sectionHeaderTopPadding

Availability
10.1.0
10.1.0
sectionHeaderTopPadding :Number

Padding above each section header.

If not set or set to -1, it defaults to an automatic spacing determined by the system.


# sectionIndexTitles

Availability
3.2.0
9.2.0
sectionIndexTitles :Array<ListViewIndexEntry>

Array of objects (with title and index properties) to control the list view index.

If an index array is specified, an index bar is displayed on the right-hand side of the list view. Clicking on a title in the index bar scrolls the list view to the section index associated with that title.


# sections

Availability
3.1.0
3.1.0
9.2.0
4.1.0
sections :Array<Titanium.UI.ListSection>

Sections of this list.


# selectedItems

Availability
10.1.0
7.0.0
9.2.0
selectedItems :Array<ListItemEventType>

Returns the selected list view items.


# separatorColor

Availability
3.2.0
3.2.0
9.2.0
separatorColor :String | Titanium.UI.Color

Separator line color between items, as a color name or hex triplet.

To make the line invisible, set this property to transparent, or the same value as the backgroundColor property. For information about color values, see the "Colors" section of Titanium.UI.

Default: platform-specific default color


# separatorHeight

Availability
4.1.0
separatorHeight :String | Number

height of the ListView separator.

Height of the ListView separator, in platform-specific units. If undefined, default native height will be used. Numerical inputs are treated as pixels. For example, 3 and "3px" are equivalent.


# separatorInsets DEPRECATED

Availability
3.2.0
9.2.0
separatorInsets :HorizontalInsets

DEPRECATED SINCE 5.2.0

Use listSeparatorInsets instead.

The insets for list view separators (applies to all cells).

Cell separators do not extend all the way to the edge of the list view. This property sets the default inset for all cells in the table. Set this to a dictionary with two keys, left specifying inset from left edge and right specifying the inset from the right edge.


# separatorStyle

Availability
8.1.0
3.2.0
9.2.0
separatorStyle :Number

Separator style constant.


# showSearchBarInNavBar CREATION ONLY

Availability
8.1.0
9.2.0
showSearchBarInNavBar :Boolean

A Boolean indicating whether search bar will be in navigation bar.

If you want to show the search bar in navigation bar, set this property true during creation. Use the hidesSearchBarWhenScrolling property to control the visibility of the searchbar when scrolling.

Default: false


# showSelectionCheck

Availability
10.1.0
showSelectionCheck :Boolean

Determines whether the selection checkmark is displayed on selected items.

Default: true


# showVerticalScrollIndicator

Availability
3.1.0
3.1.0
9.2.0
showVerticalScrollIndicator :Boolean

Determines whether this list view displays a vertical scroll indicator.

Set to false to hide the vertical scroll indicator.

Default: true


# style CREATION ONLY

Availability
3.1.0
9.2.0
style :Number

Style of the list view.

Style should always be set before setting the sections on list view.

Default: Titanium.UI.iOS.ListViewStyle.PLAIN


# tableSeparatorInsets DEPRECATED

Availability
5.2.0
9.2.0
tableSeparatorInsets :HorizontalInsets

DEPRECATED SINCE 5.4.0

Use listSeparatorInsets instead.

The insets for the table view header and footer.

Cell separators do not extend all the way to the edge of the list view. Set this to a dictionary with two keys, left specifying inset from left edge and right specifying the inset from the right edge. If the rowSeparatorInsets is not set, the tableSeparatorInsets will also set the cell insets.

For example:

listView.tableSeparatorInsets = {
    left: 10,
    right: 10
};

# templates CREATION ONLY

Availability
3.1.0
3.1.0
9.2.0
templates :Dictionary

Contain key-value pairs mapping a style name (key) to an ItemTemplate (value).

This property cannot be changed once a window has been opened.


# touchFeedback

Availability
10.0.0
touchFeedback :Boolean

A material design visual construct that provides an instantaneous visual confirmation of touch point.

Touch feedback is only applied to a view's background.

Default: true


# willScrollOnStatusTap

Availability
3.1.0
9.2.0
willScrollOnStatusTap :Boolean

Controls the scroll-to-top gesture.

If the user taps on the status bar, the view scrolls to the top. This gesture works when you have a single visible list view. If there are multiple list views, table views, web views, text areas, and/or scroll views visible, you need to disable (set to false) this property on the views you DO NOT want to enable this behavior for. The remaining view responds to the scroll-to-top gesture.

Default: true

# Methods

# addMarker

Availability
4.1.0
4.1.0
9.2.0
addMarker(markerProps) void

Adds a reference item in the list view.

See marker event for details.

Parameters

Name Type Description
markerProps ListViewMarkerProps

Dictionary to describe the reference item.

Returns

Type
void

# appendSection

Availability
3.1.0
3.1.0
9.2.0
4.1.0
appendSection(section[, animation]) void

Appends a single section or an array of sections to the end of the list.

On iOS, the section(s) can be inserted with an animation by specifying the animation parameter.

Parameters

Name Type Description
section Titanium.UI.ListSection | Array<Titanium.UI.ListSection>

Section or sections to add to the list.

animation ListViewAnimationProperties

Animation properties. (iOS only.)

Returns

Type
void

# deleteSectionAt

Availability
3.1.0
3.1.0
9.2.0
4.1.0
deleteSectionAt(sectionIndex[, animation]) void

Deletes an existing section.

On iOS, the section can be deleted with an animation by specifying the animation parameter.

Parameters

Name Type Description
sectionIndex Number

Index of the section to delete.

animation ListViewAnimationProperties

Animation properties. (iOS only.)

Returns

Type
void

# deselectItem

Availability
3.2.0
9.2.0
deselectItem(sectionIndex, itemIndex) void

Deselects a specific item.

Parameters

Name Type Description
sectionIndex Number

Section index.

itemIndex Number

Item index.

Returns

Type
void

# insertSectionAt

Availability
3.1.0
3.1.0
9.2.0
4.1.0
insertSectionAt(sectionIndex, section[, animation]) void

Inserts a section or an array of sections at a specific index.

Existing sections at that index and after are pushed down.

On iOS, the section(s) may be inserted with an animation by setting the animation parameter.

Parameters

Name Type Description
sectionIndex Number

Index of the section to insert before.

section Titanium.UI.ListSection | Array<Titanium.UI.ListSection>

Section or sections to insert.

animation ListViewAnimationProperties

Animation properties. (iOS only.)

Returns

Type
void

# replaceSectionAt

Availability
3.1.0
3.1.0
9.2.0
4.1.0
replaceSectionAt(sectionIndex, section[, animation]) void

Replaces an existing section.

On iOS, the section may be replaced with an animation by setting the animation parameter.

Parameters

Name Type Description
sectionIndex Number

Index of the section to update.

section Titanium.UI.ListSection

section data to update.

animation ListViewAnimationProperties

Animation properties. (iOS only.)

Returns

Type
void

# scrollToItem

Availability
3.1.0
3.1.0
9.2.0
4.1.0
scrollToItem(sectionIndex, itemIndex[, animation]) void

Scrolls to a specific item.

On Android 4.x, the list does not stop at the correct position. This is a known bug in Android. (Android Issue #37278)

Android added support for the animation parameter in Release 3.3.0 on the Titanium SDK.

Parameters

Name Type Description
sectionIndex Number

Section index.

itemIndex Number

Item index.

animation ListViewAnimationProperties

Animation properties. (iOS, Android and Windows)

Returns

Type
void

# selectItem

Availability
3.1.0
9.2.0
selectItem(sectionIndex, itemIndex) void

Selects an item in the list using the specified item and section indices.

Parameters

Name Type Description
sectionIndex Number

Index of the section the item is in.

itemIndex Number

Index of the item to select.

Returns

Type
void

# setContentInsets

Availability
3.2.0
9.2.0
setContentInsets(edgeInsets[, options]) void

Sets this list view's content insets.

A list view is essentially a scroll view that contains a set of static row views that represents the content. Thus, the setContentInsets method facilitates a margin, or inset, distance between the content and the container scroll view.

Typically used with the pullView property.

Parameters

Name Type Description
edgeInsets Padding

Sets the distance that the content view is inset from the enclosing scroll view of the list view. For example

setContentInset({top:50,bottom:10,right:10,left:10}, {animated:true})
options AnimatedWithDurationOptions

Determines whether, and how, the content inset change should be animated. Note that the default here is equivalent to passing in { animated: false, duration: 300 }

Returns

Type
void

# setContentOffset

Availability
10.1.0
3.4.0
9.2.0
setContentOffset(contentOffset[, options]) void

Sets the value of the content offset of the list view without animation by default.

Parameters

Name Type Description
contentOffset Point

Dictionary with the properties x, y. The x and y coordinates reposition the top-left point of the scrollable region of the list view.

options AnimatedOptions

Pass in { animated: true } to animate the transition. Note that the default here is equivalent to passing in { animated: false }

Returns

Type
void

# setMarker

Availability
3.2.0
3.2.0
9.2.0
setMarker(markerProps) void

Sets a reference item in the list view.

This method replaces previous reference items with the current one. See marker event for details.

Parameters

Name Type Description
markerProps ListViewMarkerProps

Dictionary to describe the reference item.

Returns

Type
void

# Events

# indexclick

Availability
3.4.0
9.2.0

Fired when the index bar is clicked by the user.

If the list view contains the sectionIndexTitles array of indices the index bar will appear on the side. This event will fire when this bar is clicked

Properties

Name Type Description
title String

The title of the index clicked.

index Number

The index number clicked.

bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.


# itemclick

Availability
3.1.0
3.1.0
9.2.0

Fired when a list row is clicked by the user.

Do not rely on the source property to determine which item fired the event. Use the sectionIndex and itemIndex, or the itemId to determine the list item that generated the event, and use the bindId to check which child control fired the event.

Properties

Name Type Description
section Titanium.UI.ListSection

List section if the item is contained in a list section.

sectionIndex Number

Section index.

itemIndex Number

Item index.

itemId String

The item ID bound to the list item that generated the event.

bindId String

The bind ID of the control that generated this event, if one exists.

accessoryClicked Boolean

Returns true if the detail button is clicked else returns false.

Only returns true if the accessoryType property is set to LIST_ACCESSORY_TYPE_DETAIL. All other accessories return false if clicked.

bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.


# itemsselected

Availability
10.1.0
8.2.0
9.2.0

Fired when user stops two-pan gesture interaction for selecting multiple items. It is used with allowsMultipleSelectionInteraction.

Properties

Name Type Description
selectedItems Array<SelectedItem>

List of items selected by user.

startingItem SelectedItem

First item selected when user started interaction.

bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.


# delete

Availability
10.0.0
3.2.0
9.2.0

Fired when a list row is deleted by the user.

Do not rely on the source property to determine which item fired the event. Use the sectionIndex and itemIndex, or the itemId to determine the list item that generated the event, and use the bindId to check which child control fired the event.

Note that the sectionIndex and itemIndex properties of this event correspond to the List View state before the user action.

Properties

Name Type Description
section Titanium.UI.ListSection

List section from which the item is deleted.

sectionIndex Number

Section index.

itemIndex Number

Item index.

itemId String

The item ID bound to the list item that generated the event.

bubbles Boolean

false. This event does not bubble.

bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.


# insert

Availability
5.4.0
9.2.0

Fired when a list row is inserted by the user.

Do not rely on the source property to determine which item fired the event. Use the sectionIndex and itemIndex, or the itemId to determine the list item that generated the event, and use the bindId to check which child control fired the event.

Note that the sectionIndex and itemIndex properties of this event correspond to the List View state before the user action.

Properties

Name Type Description
section Titanium.UI.ListSection

List section from which the item is deleted.

sectionIndex Number

Section index.

itemIndex Number

Item index.

itemId String

The item ID bound to the list item that generated the event.

bubbles Boolean

false. This event does not bubble.

bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.


# dragstart

Availability
5.2.0
9.2.0

Fired when the user starts dragging the list view.

Different to the pull event, this event does also fire when no pullView is specified and the user drags inside the list view.

Properties

Name Type Description
bubbles Boolean

false. This event does not bubble.

bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.


# dragend

Availability
5.2.0
9.2.0

Fired when the user stops dragging the list view.

Different to the pullend event, this event does also fire when no pullView is specified and the user drags inside the list view.

Properties

Name Type Description
bubbles Boolean

false. This event does not bubble.

bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.


# marker

Availability