# fuelux **Repository Path**: rioli/fuelux ## Basic Information - **Project Name**: fuelux - **Description**: Extends Twitter Bootstrap with additional lightweight JavaScript controls. Easy to install, customize, update, and optimize. All functionality covered by live documentation and unit tests. - **Primary Language**: JavaScript - **License**: BSD-3-Clause - **Default Branch**: master - **Homepage**: http://getfuelux.com/ - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2017-06-19 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README - [Sanity Checks](#sanity-checks) - [Documentation](#documentation) - [Contributing](#contributing) - [Obtaining Fuel UX](#obtaining-fuel-ux) - [NPM](#npm) - [Bower](#bower) - [Volo](#volo) - [Github](#github) - [Using](#using-fuel-ux) - [Required fuelux class](#required-fuelux-class) - [Required Dependencies](#required-dependencies) - [What's included](#whats-included) - [AMD support](#amd-support) - [Bugs and Feature Requests](#bugs-and-feature-requests) - [Previous releases](#previous-releases) - [Community](#community) - [Philosophy](#philosophy) - [Copyright and License](#copyright-and-license) # Sanity Checks [![Greenkeeper badge](https://badges.greenkeeper.io/ExactTarget/fuelux.svg)](https://greenkeeper.io/) [Fuel UX](http://getfuelux.com/) [![Bower version](https://badge.fury.io/bo/fuelux.svg)](http://badge.fury.io/bo/fuelux) [![npm version](https://badge.fury.io/js/fuelux.svg)](https://www.npmjs.com/package/fuelux) [![Build Status](https://api.travis-ci.org/ExactTarget/fuelux.svg?branch=master)](http://travis-ci.org/ExactTarget/fuelux) [![devDependency Status](https://david-dm.org/exacttarget/fuelux/dev-status.svg)](https://david-dm.org/exacttarget/fuelux#info=devDependencies) [![Selenium Test Status](https://saucelabs.com/browser-matrix/fuelux.svg)](https://saucelabs.com/u/fuelux) Fuel UX extends [Bootstrap 3](https://github.com/twbs/bootstrap) with additional lightweight JavaScript controls. It is actively maintained by [members of Salesforce Marketing Cloud,](https://github.com/orgs/ExactTarget/people) with the support and involvement of the community. More thorough documentation and guides available at # Documentation Fuel UX documentation is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at . More details on setting up Jekyll and running docs locally can be found [in our CONTRIBUTING.md documentation](https://github.com/exacttarget/fuelux/blob/master/CONTRIBUTING.md#running-gh-pages-locally). # Contributing Please read the [CONTRIBUTING.md](CONTRIBUTING.md) first. # Obtaining Fuel UX NPM is the recommended method for obtaining Fuel UX. ``` npm install fuelux ``` You can also use on of the following methods: - [Bower](https://github.com/bower/bower) `bower install fuelux` (update with `bower update fuelux`). - [Volo](https://github.com/volojs/volo) `volo add fuelux` (update with `volo add -f fuelux`). - Clone via git `git clone https://github.com/ExactTarget/fuelux/` - Cloning the repository ensures you can apply future updates to Fuel UX easily, but requires to you manage its [dependencies](#dependencies) on your own. - Download a [.zip archive](http://www.fuelcdn.com/fuelux/3.16.0/fuelux.zip). # Using Fuel UX Fuel UX can be used with an existing page via CDN or installed in a project. Read the [Getting started page](http://getfuelux.com/getting-started.html) for more detailed information on the framework contents, templates, examples, and more. ## Required fuelux class Add `fuelux` class to the portion of the page using Fuel UX, usually the body. ``` ``` ## Required Dependencies Fuel UX is dependent upon [Bootstrap 3](https://github.com/twbs/bootstrap) and [jQuery](https://github.com/jquery/jquery). If you installed by cloning the repo or by downloading a .zip archive, you'll also want to grab these dependencies, as it won't work without them. - [jQuery](https://github.com/jquery/jquery) - [Bootstrap 3](https://github.com/twbs/bootstrap) For other methods of managing dependencies consider [AMD support via require](#amd-support). Ensure all the dependencies are included on the page (eg, such as using the CDN as shown below). ``` ``` ## What's included The code you want is in `dist/`. We provide compiled CSS and JS (like `fuelux.*`), as well as compiled and minified CSS and JS (like `fuelux.min.*`) in the `dist` folder. Icons are provided as fonts. ``` fuelux/ ├── css/ │ ├── fuelux.css │ ├── fuelux.min.css ├── js/ │ ├── fuelux.js │ └── fuelux.min.js └── fonts/ ├── fuelux.eot ├── fuelux.svg ├── fuelux.ttf └── fuelux.woff ``` ## AMD support We recommend only loading the controls you need (eg `fuelux/checkbox`). If using AMD (such as [RequireJS](http://requirejs.org)), reference the FuelUX directory in your paths configuration, wherever it is located: ```javascript require.config({ paths: { 'fuelux': 'http://www.fuelcdn.com/fuelux/3.16.0/' //... } }); ``` Then list any individual fuel ux controls needed as dependencies within your application modules: ```javascript define(function(require) { var spinbox = require('fuelux/spinbox'); //... }); ``` In instances where you require every module from Fuel UX, you can use `fuelux/all` instead of listing each module individually. Fuel UX also supports placing components in their own `