Finding and Downloading Modules
Once a module is downloaded, it must be installed in a specific project or in a shared global location.
- Open Studio.
- Expand the project folder in the Project Explorer view.
- Drag the .zip file from the download location into the current project, placing it at the root of the project. Choose to "Copy Files".
Place the module zip file in the root of the project directory. The Titanium build will automatically extract all registered Titanium modules in the root of the project.
Extract the .zip file into the root of your project. It should extract into the
Modules can be globally installed in the following locations:
Using Your Module
To use your module in a mobile app, follow these steps:
Using the tiapp.xml Editor
Studio has a module section inside the
tiapp.xml editor to greatly simplify the usage of modules. In order to use the module editor:
- Double-click on the
- In the right-hand column, click the + to add a new module. It will show you a list of modules available in your global directory and in your project.
- Once you've added a module, clicking the pencil (edit) icon allows you to switch versions if there are multiple version available.
- If you wish to delete a module, click the x (delete) button to delete the module.
Switching a SDK will re-validate the modules based on their compatibility with the selected SDK. If they are not compatible, they will show warnings as appropriate, allowing you to update as appropriate.
Open the module's .zip file, and look at the folder structure. The path will look like the following:
- Open Studio, and the
tiapp.xmlfile for the project in question.
- Switch to the
In the application's
tiapp.xml, find the
<modules/>node, and replace it with the new
<modules>content. If you already have modules, just add a new node for the new module. Note that the "version" and "platform" attributes are optional. When "version" is not specified, the latest version of the module will be used (as of Titanium SDK 2.0.0), and the "platform" tag is only necessary when using a module that is not available on both platforms.
Use the require function to load the module in the app's code, for example:
- The next time the app is launched or built, the module should be included with the application.