# Titanium.UI.Shortcut
Manage application shortcuts.
# 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
# items READONLY
List dynamic shortcuts.
Array of shortcut items that were added to the app via the add method.
# staticItems READONLY
List current pinned/static shortcuts.
# Methods
# add
Adds a shortcut item to the application.
Parameters
Name | Type | Description |
---|---|---|
item | Titanium.UI.ShortcutItem | Titanium.UI.ShortcutItem to add. |
Returns
- Type
- void
# getById
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
# remove
Removes the given shortcut item from the application.
Parameters
Name | Type | Description |
---|---|---|
item | Titanium.UI.ShortcutItem | Titanium.UI.ShortcutItem to remove. |
Returns
- Type
- void
# Events
# click
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. |