Git Product home page Git Product logo

trimethyl's Introduction

Trimethyl

Titanium Alloy

Alloy-Titanium framework made in Caffeina

A collection of very useful modules to work with Appcelerator Titanium and Alloy.

Most of these modules are proxy object for Titanium API and some of these add features missing or expose functions usefuls for UI normalization.

image

Installation

To install this framework, you have to copy it to your app/lib directory.

Stable installation

Download the latest release and unzip in app/lib/T

Or, open your Terminal app, move to your Titanium project, and simply type:

wget https://github.com/CaffeinaLab/Trimethyl/archive/1.2.2.tar.gz -O T.tar.gz;
mkdir -p app/lib/T;
tar -xvf T.tar.gz -C app/lib/T --strip-components=1

Master installation

If you want to install the master version directly from GitHub, just clone this repository:

git clone [email protected]:CaffeinaLab/Trimethyl.git app/lib/T

The master version coulb be unstable, so use at your risk.

Configuration

Each module reads from the config.json its configuration.

For example, the module named X, will read the Alloy.CFG.T.X object.

You can customize the options passed for each modules, editing your config.json file:

{
	...
	"T":{
		"X": {
			...
		},
		...
	}
	...

Initialization

In your app/alloy.js file, on the first line:

require('T/trimethyl');

Or, if you want to provide an helper to load the Trimethyl modules, write:

function T(name) { return require('T/'+name); }
T('trimethyl');

Requiring T will bootstrap some important framework files, set prototypes, TSS vars and Alloy.Globals vars.

CommonJS Modules

To require a module, just call

var X = require('T/X'); /* or T('X') */

where X is the module that you want to use.

Please refer to the documentation for full-usage.

Each module read the Alloy.CFG.T.__MODULENAME__ properties in your config.json file to configure itself.

NON-CommonJS modules

There are some modules that can be used too in your XML Alloy files, like:

  • XP.UI: Provide cross-platforms UI elements to handle differences between platforms
  • UI: Provide new UI elements that missing from some platforms

Please refer to the documentation for full-usage.

License

Copyright 2014 Caffeina

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

trimethyl's People

Contributors

kopiro avatar fokkezb avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.