nxbdi / fuelux

Extends Twitter Bootstrap with additional lightweight JavaScript controls. Easy to install, customize, update, and optimize. All functionality covered by live documentation and unit tests.

Fuel UX extends Twitter Bootstrap with additional lightweight JavaScript controls. Other benefits include easy installation into web projects, integrated scripts for customizing Bootstrap and Fuel UX, simple updates, and solid optimization for deployment. All functionality is covered by live documentation and unit tests.

Features

Fuel UX provides all of the styles and plugins from the revolutionary Twitter Bootstrap project, with the following additions:

• Fuel UX JavaScript controls (with unit tests) see them live
  • Combobox - combines input and dropdown for easy and flexible data selection
  • Datagrid - renders data in a table with paging, sorting, and searching
  • Pillbox - manages selected items with color-coded text labels
  • Search - combines input and button for integrated search interaction
  • Spinner - provides convenient numeric input with increment and decrement buttons

* One-step installation and updates through [volo](https://github.com/volojs/volo) * [AMD](http://requirejs.org/docs/whyamd.html) compatibility for modular structure and deployment optimization * [Grunt](https://github.com/cowboy/grunt)-based build script to easily create custom distribution files * Namespaced CSS (just add a `fuelux` class) for safe use on existing sites

Getting Started

• git clone git://github.com/ExactTarget/fuelux.git
• Default Fuel UX files for production use are located in the dist directory
• To customize, modify the JS and LESS files under src then run grunt to regenerate your dist directory (more below)

Documentation and Examples

To see some work ExactTarget has made available to our client base, please check out [Fuel UX] (http://code.exacttarget.com/devcenter/fuel-ux) on our [Developer Community] (http://code.exacttarget.com/devcenter/home)

Live docs and demos can be found at http://exacttarget.github.com/fuelux

Release History

Version 2.0.1 2012-10-05

• Fix loader.js (used for non-AMD pages) to be synchronous

Version 2.0.0 2012-09-28

• First public release of Fuel UX

Contributing

Before writing code, we suggest you search for issues or create a new one to confirm where your contribution fits into our roadmap.

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

More about Contributing to Fuel UX

Important notes

Please don't edit files in the dist directory as they are generated via grunt. You'll find source code in the src directory!

While grunt can run the included unit tests via PhantomJS, this isn't a substitute for the real thing. Please be sure to test the test/*.html unit test file(s) in real browsers as well.

More about Installing grunt and PhantomJS

The Fuel UX Philosophy

Our aim is to provide a suite of related but independent projects that help web developers integrate, manage, and customize quality libraries and utilities to more efficiently develop, maintain, test, and distribute their projects. Any improvements or fixes we make to the open source projects we use will be contributed upstream if they are useful to the rest of the community.

Acknowledgements

We are grateful to the maintainers, contributors, and sponsors of the following technologies which make FuelUX possible:

• jQuery (Library for DOM, events, animation, and AJAX)

• Twitter Bootstrap (Modern UI components and interactions)

• LESS and recess (Stylesheet definition and management)

• RequireJS and volo (Tools for managing modular JavaScript)

• grunt (Build tool for JavaScript projects)

##Authors

Adam Alexander

• http://twitter.com/adamalex
• http://github.com/adamalex

Matt Beard

• http://github.com/mbeard

Bryan Kohlmeier

• http://github.com/bkohlmeier

Kevin Parkerson

• http://github.com/kevinparkerson

Christopher McCulloh

• http://github.com/cmcculloh

David Waltz

• https://github.com/dwaltz

Copyright and license

Copyright (c) 2012 ExactTarget

Licensed under the MIT License (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the COPYING file.

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.