Skip to content

rileydutton/SVProgressHUD-Titanium-Mobile

Repository files navigation

SVProgessHUD-Titanium-Mobile

Description

This is a simple port of the SVProgressHUD iOS library to Titanium Mobile. You can simply include it as a module in your Titanium project, and use a few basic commands to get a great-looking progress indicator.

Installation (Pre-Compiled)

These are instructions for those of you who just want to use the library without modifying it in your own project.

Create a new folder called modules in the root directory of your Titanium Project. Create a subfolder of the modules directory called ios. Download and extract svprojecthud-0.1.zip into that directory. Refer to the Usage section below for information on actually using the library in your application.

Note: I have not yet been able to figure out how to make this work with Titanium Mobile's module asset packaging, so right now the icons for the success and error status messages are missing. Hopefully this will be fixed soon. Alternatively, if anyone else out there knows how I should go about implementing that, please let me know :-).

Installation (Source)

Clone the git repository or download it as a zip/tar file. You should then be able to open the xcodeproj and compile the project. Refer to the module documentation if you need more information on how to create/edit/compile/distribute Titanium Mobile modules.

Usage

// open a single window
var window = Ti.UI.createWindow({
	backgroundColor:'white'
});
var label = Ti.UI.createLabel();
window.add(label);
window.open();

//Include the module.

var svprogresshud = require('com.svprogresshud');

//You must create a view that holds the progress indicator. The easiest thing to do is to add this to your main app window.
//The indicator *should* automatically take care of putting itself on top of other views/windows, although this has not ben extensively tested.

var indicator = svprogresshud.createView();

window.add(indicator);

//Show the HUD with a status message. You can also choose to show a Network Indicator (default is true).

indicator.showHUD({status: "Test", showNetwork: true});

setTimeout(function() {

	//Update the status text of the currently shown indicator.

	indicator.setStatus("Step 2");
},	3000);

setTimeout(function() {

	//Dismiss the current indicator, with an optional status message. Also choose to show an error icon (error: true) or a success icon (error: false)

	indicator.dismissHUD({error: false, status: "Complete!"});
}, 6000);

setTimeout(function() {
	indicator.showHUD({status: "Going", showNetwork: false});
}, 9000);

setTimeout(function() {
	indicator.dismissHUD({status: "Gone!", error: true});
}, 12000);

License

This work is licensed under an MIT License. Please note, however, that like the original SVProgressHUD this repository contains two images from the excellent Glyphish icon set. They are licensed under their own terms, visit the Glyphish website for more information about them.

Original Code Copyright (c) 2011 Sam Vermette Modifications Copyright (c) 2011 Riley Dutton

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.

A different license may apply to other ressources included in this package, including Joseph Wain's Glyphish Icons. Please consult their respective headers for the terms of their individual licenses.

About

A port of SVProgressHUD packaged as a module for Titanium Mobile projects.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published