npm install t3js[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
T3 is a client-side JavaScript framework for building large-scale web applications. Its design is based on the principles of Scalable JavaScript Application Architecture, specifically:
* Enforcing loose coupling between components
* Making dependencies explicit
* Providing extension points to allow for unforeseen requirements
* Abstracting away common pain points
* Encouraging progressive enhancement
The approaches taken in T3 have been battle-hardened through continuous production use at Box since 2013, where we use T3 along with jQuery, jQuery UI, and several other third-party libraries and frameworks.
T3 is different from most JavaScript frameworks. It's meant to be a small piece of an overall architecture that allows you to build scalable client-side code.
T3 is explicitly not an MVC framework. It's a framework that allows the creation of loosely-coupled components while letting you decide what other pieces you need for your web application. You can use T3 with other frameworks like Backbone or React, or you can use T3 by itself. If you decide you want model and views, in whatever form, you can still use them with T3.
T3 is made to be unopinionated while prescribing how some problems might be solved. Our goal here is not to create a single framework that can do everything for you, but rather, to provide some structure to your client-side code that allows you to make good choices. Then, you can add in other libraries and frameworks to suit your needs.
T3 allows you to define functionality using just three component types:
1. Services are utility libraries that provide additional capabilities to your application. You can think of services as tools in a toolbox that you use to build an application. They intended to be reusable pieces of code such as cookie parsing, Ajax communication, string utilities, and so on.
2. Modules represent a particular DOM element on a page and manage the interaction inside of that element. It's a module's job to respond to user interaction within its boundaries. Your application is made up of a series of modules. Modules may not interact directly with other modules, but may do so indirectly.
3. Behaviors are mixins for modules and are used primarily to allow shared declarative event handling for modules without duplicating code. If, for instance, you use a particular attribute to indicate a link should use Ajax navigation instead of full-page navigation, you can share that functionality amongst multiple modules.
We've found that by using a combination of these three component types, we're able to create compelling, progressively-enhanced user experiences.
To include T3 in a web page, you can use RawGit.
The last published release:
``
`
You may also use bower to install t3js:
`
bower install t3js
T3 2.0.0 was released on November 18th, 2015 with some major changes. To upgrade, please see these instructions.
Your T3 front-end is made up of modules, so the first step is to indicate which modules are responsible for which parts of the page. You can do that by using the data-module attribute and specifying the module ID, such as:
`html`
Box
This example specifies the module header should manage this particular part of the page. The module header is then defined as:
`js
Box.Application.addModule('header', function(context) {
return {
onclick: function(event, element, elementType) {
if (elementType === 'welcome-btn') {
alert('Welcome, T3 user!');
} else {
alert('You clicked outside the button.');
}
}
};
});
`
This is a very simple module that has an onclick handler. T3 automatically wires up specified event handlers so you don't have to worry about using event delegation or removing event handlers when they are no longer needed. The onclick handler receives a DOM-normalized event object that can be used to get event details. When the button is clicked, a message is displayed. Additionally, clicking anywhere inside the module will display a different message. Event handlers are tied to the entire module area, so there's no need to attach multiple handlers of the same type.
The last step is to initialize the T3 application:
`js`
Box.Application.init();
This call starts all modules on the page (be sure to include both the T3 library and your module code before calling init()). We recommend calling init() as soon as possible after your JavaScript is loaded. Whether you do that onload, earlier, or later, is completely up to you.
There are more extensive tutorials and examples on our website.
T3 is tested and known to work in the following browsers:
* Internet Explorer 9 and higher
* Firefox (latest version)
* Chrome (latest version)
* Safari (latest version)
With the exception of Internet Explorer, T3 will continue to support the current and previous one version of all major browsers.
The main purpose of sharing T3 is to continue its development, making it faster, more efficient, and easier to use.
* config - configuration files for the projectdist
* - browser bundles (this directory is updated automatically with each release)lib
* - the source code as individual filestests
* - the test code
In order to get started contributing to T3, you'll need to be familiar and have installed:
1. Git
1. npm
1. Node.js or IO.js
Following the instructions in the contributor guidelines to setup a local copy of the T3 repository.
Once you clone the T3 git repository, run the following inside the t3js directory:
`
$ npm i
This sets up all the dependencies that the T3 build system needs to function.
Note: You'll need to do this periodically when pulling the latest code from our repository as dependencies might change. If you find unexpected errors, be sure to run npm i again to ensure your dependencies are up-to-date.
After that, you can run all tests by running:
`
$ npm test
This will start by linting the code and then running all unit tests.
The following build commands are available:
1. npm test - runs all linting and uni testsnpm run lint
1. - runs all lintingnpm run dist
1. - creates the browser bundles and places them in /dist`
We provide a custom version of T3 built with jQuery that is compatible with older browsers such as IE8.
The Box web application currently supports IE8 with a planned end-of-life of December 31, 2015. We will be dropping T3 support for IE8 at the same time.
Need to contact us directly? Email t3js@box.com with your questions or comments.
Copyright 2015 Box, Inc. All rights reserved.
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.
[npm-image]: https://img.shields.io/npm/v/t3js.svg?style=flat-square
[npm-url]: https://npmjs.org/package/t3js
[travis-image]: https://img.shields.io/travis/box/t3js/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/box/t3js