miguelramosfdz / TiCrouton

Titanium Module for Crouton

Home Page:https://github.com/keyboardsurfer/Crouton

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TiCrouton Titanium

About

TiCrouton is a Titanium module for Crouton - a replacement for Android Toast notifications.

demo

Check out the demo from the original library:

demo

Quick Start

Installation gitTio

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

$ gittio install de.manumaticx.crouton

Usage

var Crouton = require('de.manumaticx.crouton');

// simple alert
Crouton.alert("Something went wrong! :-(");

// simple confirm
Crouton.confirm("Something was successful! :-)");

// simple info
Crouton.info("Something I want to let you know.");

There are some more examples in the example.

API

Module

.alert( text )

  • text: String

.confirm( text )

  • text: String

.info( text )

  • text: String

.showText( text , style )

  • text: String
  • style: int (one of Crouton.STYLE_INFO, Crouton.STYLE_ALERT, Crouton.STYLE_CONFIRM)

.show( options)

  • options: Object
    • text
    • style
    • duration (as ms)
    • activity

.makeText( text , style )

  • text: String
  • style: int (one of Crouton.STYLE_INFO, Crouton.STYLE_ALERT, Crouton.STYLE_CONFIRM)

returns Crouton

.make( options )

  • options: Object
    • text
    • style
    • duration (as ms)
    • activity

returns Crouton

.hide( crouton ) hides a Crouton by reference

.cancelAllCroutons( ) cancels all pending Croutons

Crouton

  • .show( ) shows the Crouton
  • .hide( ) hides the Crouton
  • .cancel( ) cancels the Crouton

TODO

  • implement a Crouton Proxy
  • implement make ans makeText methods
  • implement cancelAllCroutons and hide methods
  • implement Events
  • add support for customStyle and customView

License

The MIT License (MIT)

Copyright (c) 2014 Manuel Lehner

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.

About

Titanium Module for Crouton

https://github.com/keyboardsurfer/Crouton

License:MIT License