TiCrouton

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #android #machine-learning #linux #docker #macos #nodejs #awesome #awesome-list #security #ios

(★ 27)

Titanium Module for Crouton

TiCrouton Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TiCrouton [![Titanium](http://www-static.appcelerator.com/badges/titanium-git-badge-sq.png)](http://www.appcelerator.com/titanium/)

## IMPORTANT
[Crouton](https://github.com/keyboardsurfer/Crouton) was marked as *DEPRECATED*. Since this module is based on that library I'll stop further development.

## About
TiCrouton is a Titanium module for [Crouton](https://github.com/keyboardsurfer/Crouton) - a replacement for Android Toast notifications.

![demo](https://raw.githubusercontent.com/manumaticx/TiCrouton/master/documentation/ticrouton.gif)

## Quick Start

### Installation [![gitTio](http://gitt.io/badge.png)](http://gitt.io/component/de.manumaticx.crouton)
Download the latest distribution ZIP-file and consult the [Titanium Documentation](http://docs.appcelerator.com/titanium/latest/#!/guide/Using_a_Module) on how install it, or simply use the [gitTio CLI](http://gitt.io/cli):

`$ gittio install de.manumaticx.crouton`

### Usage
```javascript
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](example/app.js).

## 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
	* color
	* duration (as ms)
	* activity

`.makeText( text , style )`
* __text__: String
* __style__: int (one of _Crouton.STYLE_INFO_, _Crouton.STYLE_ALERT_, _Crouton.STYLE_CONFIRM_)

_returns [Crouton](#crouton)_

`.make( options )`
* __options__: Object
	* text
	* style
	* color
	* duration (as ms)
	* activity

_returns [Crouton](#crouton)_

`.hide( crouton )` hides a Crouton by reference
* __crouton__: [Crouton](#crouton)

`.cancelAllCroutons( )` cancels all pending Croutons

### Crouton

##### Methods

* `.show( )` shows the Crouton
* `.hide( )` hides the Crouton
* `.cancel( )` cancels the Crouton

##### Events

* `show` gets fired when the Crouton shows
* `finish` gets fired when the Crouton hides

## License
	The MIT License (MIT)

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.

TiCrouton

TiCrouton Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

TiCrouton

TiCrouton Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README