Skip to content
Titanium SDK
Version13.3.0

You are reading 13.3.0. See this page in 13.4.1.

Titanium.UI.Android.Snackbar

viewAndroidsince 11.1.0

Extends Titanium.UI.ViewTitanium.Proxy

Snackbars provide brief messages about app processes at the bottom of the screen.

Android
Android

For design guidelines, see Material design: Snackbars

Examples

Show a Snackbar

Display a Snackbar with an action button.

const win = Ti.UI.createWindow();
const btn = Ti.UI.createButton({
  title: 'show message'
});
btn.addEventListener('click', function() {
  snack.show();
});

const snack = Ti.UI.Android.createSnackbar({
  message: 'Hello Snackbar!',
  length: Ti.UI.Android.Snackbar.LENGTH_INDEFINITE,
  action: 'click me'
});
snack.addEventListener('click', function(e) {
  console.log(e.action);
});

win.add([btn, snack]);
win.open();

Properties 27

action

Stringsince 10.2.0

Text of the right hand action button

apiName

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

Indicates if the proxy will bubble an event to its parent.

Default: true

elevation

Numbersince 5.0.0Android 5+

Inherited from Titanium.UI.View

Base elevation of the view relative to its parent in pixels.

length

Numbersince 10.2.0

Display time of the Snackbar

Use with on of the constants: Ti.UI.Android.Snackbar.LENGTH_SHORT, Ti.UI.Android.Snackbar.LENGTH_LONG or Ti.UI.Android.Snackbar.LENGTH_INDEFINITE

Default: LENGTH_SHORT

LENGTH_LONG

Numberread-only

Use with length to specify the display time.

LENGTH_SHORT

Numberread-only

Use with length to specify the display time.

message

Stringsince 10.2.0

Text of Snackbar

rotation

Numbersince Android 5.4.0, iPhone 12.3.0, iPad 12.3.0

Inherited from Titanium.UI.View

Clockwise 2D rotation of the view in degrees.

tooltip

Stringsince 12.1.0iOS 15.0+

Inherited from Titanium.UI.View

The default text to display in the control's tooltip.

touchFeedback

Booleansince 6.1.0

Inherited from Titanium.UI.View

A material design visual construct that provides an instantaneous visual confirmation of touch point.

Default: false

Methods 10

Inherited from Titanium.Proxy

Adds the specified callback as an event listener for the named event.

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

Callback function to invoke when the event is fired.

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

Parameters
ParametersTypeDescription
nameString

Name of the event.

event?Dictionary

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

getViewById

since 6.1.0

Inherited from Titanium.UI.View

Returns the matching view of a given view ID.

Parameters
ParametersTypeDescription
idString

The ID of the view that should be returned. Use the id property in your views to enable it for indexing in this method.

Inherited from Titanium.UI.View

Hides this view.

Parameters
ParametersTypeDescription
options?AnimatedOptions

Animation options for Android only. Since SDK 5.1.0 and used only on Android 5.0+

Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in { animated: false }

insertAt

since 3.3.0

Inherited from Titanium.UI.View

Inserts a view at the specified position in the children array.

Parameters
ParametersTypeDescription
paramsViewPositionOptions

Pass an object that specifies the view to insert and optionally at which position (defaults to end)

2 fields
position? Number

Position in the children array of the view element to replace.

view Titanium.UI.View

View to insert. Required.

Inherited from Titanium.Proxy

Removes the specified callback as an event listener for the named event.

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.

replaceAt

since 3.3.0

Inherited from Titanium.UI.View

Replaces a view at the specified position in the children array.

Parameters
ParametersTypeDescription
paramsViewPositionOptions

Pass an object with the view to insert and the position of the view to replace. In this case the position property is required.

2 fields
position? Number

Position in the children array of the view element to replace.

view Titanium.UI.View

View to insert. Required.

Show the Snackbar

Events 2

Fired when the action button is clicked

Event properties
Event propertiesTypeDescription
actionString

The text of the action button.

rotate

since 12.7.0

Inherited from Titanium.UI.View

Fired when the device detects a two finger rotation.

Event properties
Event propertiesTypeDescription
rotateNumber

Rotation in degrees.