Skip to content

raulriera/Overlay-HUD

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 

Repository files navigation

What is it?:

Overlay HUD is a module created to simplify how to display basic messages on the screen to an user in Appcelerator's Titanium

Installation:

This module is pretty simple to use, you just need to import the library like so

var overlay = require("overlayHUD");

And that is it, now you can use the following functions to show or hide your HUD

Example

For the simplest example, follow this

// inits the module and displays it to the user right away
var overlay = require("overlayHUD");
overlay.load().show();	

Docs

Below is a simple version of documentions, is so simple you don't need anything more than this :)

load(message, style)

Init function, takes 2 optional arguments: the first one is the message you want to display, default is "Loading..." and the second argument is the style to use, default is "normal" and "tweetie", where normal is a fullscreen window and Tweetie is a black semi transparent window. Default is Tweetie

show()

Animates the HUD and displays it to the user.

hide()

Animates the HUD and hides it from the user. Another way to hide the HUD is by firing an app wide event called OVERLAY:HUD:HIDE (this can be customized)

About:

Created by Raul Riera, http://raulriera.com

About

A simple Overlay HUD Module for Titanium following CommonJS best practices

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published