Permalink
Fetching contributors…
Cannot retrieve contributors at this time
160 lines (115 sloc) 7.22 KB

Sanity Checks

Fuel UX Bower version npm version Build Status devDependency Status

Selenium Test Status

Fuel UX extends Bootstrap 3 with additional lightweight JavaScript controls. It is actively maintained by members of Salesforce Marketing Cloud, with the support and involvement of the community.

More thorough documentation and guides available at http://getfuelux.com

Documentation

Fuel UX documentation is built with Jekyll and publicly hosted on GitHub Pages at http://getfuelux.com. More details on setting up Jekyll and running docs locally can be found in our CONTRIBUTING.md documentation.

Contributing

Please read the 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 bower install fuelux (update with bower update fuelux).
  • 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 on your own.
  • Download a .zip archive.

Using Fuel UX

Fuel UX can be used with an existing page via CDN or installed in a project.

Read the Getting started page 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.

<body class="fuelux">

Required Dependencies

Fuel UX is dependent upon Bootstrap 3 and 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.

For other methods of managing dependencies consider AMD support via require.

Ensure all the dependencies are included on the page (eg, such as using the CDN as shown below).

<link href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css" rel="stylesheet">
<link href="//www.fuelcdn.com/fuelux/3.15.10/css/fuelux.min.css" rel="stylesheet">

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.js"></script>
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.1/js/bootstrap.min.js"></script>
<script src="//www.fuelcdn.com/fuelux/3.15.10/js/fuelux.min.js"></script>

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), reference the FuelUX directory in your paths configuration, wherever it is located:

require.config({
    paths: {
        'fuelux': 'http://www.fuelcdn.com/fuelux/3.15.10/'
        //...
    }
});

Then list any individual fuel ux controls needed as dependencies within your application modules:

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 <script> tags. Be sure to check component dependencies in the controls documentation and put modules in the correct order if you load them in this method. Errors will appear in the console if you have not loaded dependencies correctly ((Repeater)[http://getfuelux.com/javascript.html#repeater-dependencies] and Scheduler are the only components with dependencies currently).

Bugs and Feature Requests

Have a bug or a feature request? Please first review the open issues, then search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

For additional assistance connect with the community.

Previous releases

Documentation for v2.6 has been made available for the time being while folks transition to Bootstrap 3. You can download 2.6 updates (bug fixes only) from the fuelux2 branch.

Community

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.

Thank you to all those that have submitted issues and contributed to this library.

Copyright and License

Copyright © 2012-2014 Salesforce Marketing Cloud, Inc.

View BSD-3 license.