Titanium SDK

# Titanium.UI.Shortcut

Manage application shortcuts.

Availability
9.1.0
9.1.0
9.2.0
Extends
Titanium.Proxy

# Overview

Allows the creation of application shortcuts, which can be detected using the click event from Titanium.UI.Shortcut.

On iOS, shortcuts are only supported on a 3D Touch compatible device. Use the Titanium.UI.iOS.forceTouchSupported property to see if it's supported.

# Examples

# Simple Shortcut Example

Create a shortcut item and detect its click with the click event.

const win = Ti.UI.createWindow({ backgroundColor: 'grey' });

// Listen for shortcut item clicks from the end-user.
Ti.UI.Shortcut.addEventListener('click', e => {
    // Event's "item" property indicates which shortcut item was clicked on.
    console.log(`id: ${e.item.id}`);

    // Set background to 'blue' when a shortcut was clicked on.
    win.backgroundColor = 'blue';
});

// Button to add a shortcut item.
const btn = Ti.UI.createButton({ title: 'ADD SHORTCUT' });
btn.addEventListener('click', () => {
    const shortcutItem = Ti.UI.createShortcutItem({
        id: 'test_shortcut',
        title: 'TEST',
        description: 'DESCRIPTION'
    });
    Ti.UI.Shortcut.add(shortcutItem);
});
win.add(btn);

win.open();

# Properties

# apiName READONLY

Availability
9.1.0
9.1.0
9.2.0
apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability
9.1.0
9.1.0
9.2.0
bubbleParent :Boolean

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

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

# items READONLY

Availability
9.1.0
9.1.0
9.2.0
items :Array<Titanium.UI.ShortcutItem>

List dynamic shortcuts.

Array of shortcut items that were added to the app via the add method.

# lifecycleContainer

Availability
9.1.0
lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

# staticItems READONLY

Availability
9.1.0
9.1.0
9.2.0
staticItems :Array<Titanium.UI.ShortcutItem>

List current pinned/static shortcuts.

# Methods

# add

Availability
9.1.0
9.1.0
9.2.0
add(item) → void

Adds a shortcut item to the application.

Parameters

Name Type Description
item Titanium.UI.ShortcutItem

Returns

Type
void

# addEventListener

Availability
9.1.0
9.1.0
9.2.0
addEventListener(name, callback) → void

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

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# applyProperties

Availability
9.1.0
9.1.0
9.2.0
applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# fireEvent

Availability
9.1.0
9.1.0
9.2.0
fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name Type Description
name String

Name of the event.

event Dictionary

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

Returns

Type
void

# getById

Availability
9.1.0
9.1.0
9.2.0
getById(id) → Titanium.UI.ShortcutItem

Fetches a shortcut item by its unique string identifier.

Returns a shortcut item with a matching string id. Returns null if a match was not found.

Parameters

Name Type Description
id String

Identifier of shortcut item to obtain.

Returns

Type
Titanium.UI.ShortcutItem

# remove

Availability
9.1.0
9.1.0
9.2.0
remove(item) → void

Removes the given shortcut item from the application.

Parameters

Name Type Description
item Titanium.UI.ShortcutItem

Returns

Type
void

# removeAll

Availability
9.1.0
9.1.0
9.2.0
removeAll() → void

Removes all shortcut items from the application.

Returns

Type
void

# removeEventListener

Availability
9.1.0
9.1.0
9.2.0
removeEventListener(name, callback) → void

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

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

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

Returns

Type
void

# Events

# click

Availability
9.1.0
9.1.0
9.2.0

Fired when a Titanium.UI.ShortcutItem was clicked on.

Properties

Name Type Description
item Titanium.UI.ShortcutItem

The shortcut item clicked.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

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

cancelBubble Boolean

Set to true to stop the event from bubbling.

Contents