Ti.CollectionView

⚠️ IMPORTANT TO NOTE:

Since version 2.0 the module id is ti.collectionview and NOT de.marcelpociot.CollectionView

The original work was done by Marcel Pociot. He passed the module to me for me continue his GREAT work, he had not the time to continue! I will need all the help possible to keep that module great!

Overview

This module allows you to use a collection / grid view with the Appcelerator Titanium SDK.

It uses the Titanium ItemTemplate objects for the best performance.

Grid layout

Waterfall layout

Context menu

Installation

Get it

Download the latest distribution ZIP-file and consult the Titanium Documentation on how install it, or simply use the gitTio CLI:

$ gittio install ti.collectionview

Important notes for Android

In order to make this module work for Android, you need to use the provided "CollectionView.js" CommonJS library.

API

This module uses the Ti.UI.ListView API.

Additional parameters

The ListView API gets extended by these custom parameters:

layout (LAYOUT_WATERFALL | LAYOUT_GRID) - sets the layout to use for the collection view. You can select between the waterfall layout (like Pinterest) or the standard grid layout which is the default value.

Waterfall layout specific configuration

columnCount (Number) The number of columns to use. Default: 3
minimumColumnSpacing (Number) The minimum spacing between each columns
minimumInteritemSpacing (Number) The minimum spacing between each items (vertically)
renderDirection (DIRECTION_LEFT_TO_RIGHT | DIRECTION_RIGHT_TO_LEFT | DIRECTION_SHORTEST_FIRST) The render direction to use. Default: DIRECTION_LEFT_TO_RIGHT

iOS specific configuration (Creation Only!)

scrollDirection (SCROLL_HORIZONTAL | SCROLL_VERTICAL ) Default: SCROLL_VERTICAL
showContextMenu Boolean - Should we show a contextual menu on longpress? Default: NO
contextMenuStrokeColor Color - The stroke color of the context Menu indicator
contextMenuItems Array - An array of context menu items each item is an object with the following attributes
- tintColor Color - The color used to tint the icon
- selected Image - The image for the selected state
- unselected Image - The image for the unselected state

Events

contextMenuClick - Fired when a context menu item gets selected
- index Number - The selected menu item index
- itemIndex Number - The selected collection view item index
- sectionIndex Number - The selected collection view section index

Android specific configuration

columnWidth (Number) - Defines the width of each column. The Android module will fit as many columns in a row as possible
verticalSpacing (Number) - Defines the vertical column spacing
horizontalSpacing (Number) - Defines the horizontal column spacing

Usage

Alloy:

<ListView id="listView" backgroundColor="white" defaultItemTemplate="template" module="ti.collectionview" method="createCollectionView">

<Templates>
    <ItemTemplate name="template">
        <View id="container">
            <Label bindId="info" id="title" />
            <Label bindId="es_info" id="subtitle" />
        </View>
    </ItemTemplate>

</Templates>

<ListSection module="ti.collectionview" method="createCollectionSection">

    <ListItem module="ti.collectionview" method="createCollectionItem" width="150" height="200" info:text="Apple" es_info:text="Manzana" />
    <ListItem module="ti.collectionview" method="createCollectionItem" width="150" height="200" info:text="Banana" es_info:text="Banana" />
    <ListItem module="ti.collectionview" method="createCollectionItem" width="150" height="200" info:text="Apple" es_info:text="Manzana" />
    <ListItem module="ti.collectionview" method="createCollectionItem" width="150" height="200" info:text="Banana" es_info:text="Banana" />
</ListSection>
</ListView>

Vanilla JS:

var collectionView = require("ti.collectionview");

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: [
        {                            // 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 = require("ti.collectionview").createCollectionView({
    backgroundColor: "white",
    top: 0,
    left: 0,
    width: Ti.UI.FILL,
    height: Ti.UI.FILL,
    // 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',
    
    // Context menu options
    showContextMenu : true,
    contextMenuStrokeColor : "red",
    contextMenuItems : [
        {
            tintColor: "red",
            selected: "/images/UploadIconSelected.png",
            unselected:"/images/UploadIcon.png",
        },
        {
            tintColor: "red",
            selected: "/images/TrashIconSelected.png",
            unselected:"/images/TrashIcon.png",
        }
    ],
    
    // ANDROID ONLY
    columnWidth: 150,
    verticalSpacing: 10,
    horizontalSpacing: 10
});
var sections = [];

var fruitSection = collectionView.createCollectionSection({ headerTitle: 'Fruits / Frutas'});
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'}, properties: {height:150,width:150}},
    { info: {text: 'Apple'}, es_info: {text: 'Manzana'}, properties: {height:150,width:150}},
];
fruitSection.setItems(fruitDataSet);
sections.push(fruitSection);

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

Changelog

All Releases are located in the "/dist/*" folder: https://github.com/nuno/TiCollectionView/tree/master/dist

v2.0.0
- iOS only Move project to ARC, fix all warnings and compile errors
- iOS only Fix main-thread execution
- iOS only Rebuild with 6.0.3.GA
- iOS only Rename project to "Ti.CollectionView"
- iOS only Support for the "allowsMultipleSelection" property
- iOS only Support for the "contentOffset" property
- iOS only Support for the "scrollstart" and "scrollend" event
v1.4.1
- iOS only Fix pull-to-refresh
v1.4.0
- iOS only Added support for horizontal scrolling
v1.3.0
- iOS only Added support for header and footer views
v1.2.0
- iOS only Added support for longtouch context menus
v1.1.1
- Added support for Pull To Refresh
v1.1.0
- Added waterfall layout for iOS
v1.0.0
- Initial release with Android support added

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contextmenu License