/infusion

Infusion combines JavaScript, CSS, HTML and user-centered design, rolling them all into a single package that sits on top of the popular jQuery toolkit. Infusion includes ready-to-use components as well as a framework to build your own.

Primary LanguageJavaScriptOtherNOASSERTION

##What Is Infusion?##

Infusion is a different kind of JavaScript framework. Our approach is to leave you in control-- it's your interface, using your markup, your way. Infusion is accessible and very, very configurable.

Infusion includes:

  • an application framework for developing flexible stuff with JavaScript and jQuery
  • a collection of accessible UI components
  • a lightweight CSS framework

##Where Can I See Infusion Components?##

http://fluidproject.org/products/infusion/infusion-demos/

##How Do I Get Infusion?##

You can checkout and fork Infusion on github:

https://github.com/fluid-project/infusion

See How Do I Create an Infusion Package?, for details on creating custom packages of Infusion.

##Who Makes Infusion, and How Can I Help?##

The Fluid community is an international group of designers, developers, and testers who focus on a common mission: improving the user experience and accessibility of the open web.

The best way to join the Fluid Community is to jump in to any of our community activities. Visit our "Get Involved" page for links to our mailing lists, chat room, wiki, etc.:

http://fluidproject.org/getinvolved/

##How Do I Create an Infusion Package?##

Strictly speaking, Infusion can be used directly from source (i.e. by including each individual required file). However, for simplicity and performance reasons, you may wish to create a concatenated, minified file. The Grunt build options described below will also allow you to remove any unneeded features or libraries that you may already have in your project.

###Dependencies###

All other dependencies will be installed by running the following from the project root:

npm install

###Package Types###

####Infusion All Build####

Will include all of Infusion. The source files packaged along with the single concatenated js file will include all of the demos and unit tests. This is a good choice if you are trying to learn Infusion.

grunt

#####Custom Build#####

Will only include the modules you request, and all of their dependencies, minus any that are explicitely excluded. Unlike the "all" build, none of the demos or tests are included with a custom package.

grunt custom

###Build Options###

####--source####

value: true (Boolean) the value can be ommited if --source is the last flag specified

By default all packages are minified. This option will allow you to maintain the readable spacing and comments.

grunt --source=true

grunt custom --source=true

####--include####

value: "module(s)" (String) only available to custom packages

The --include option takes in a comma-separated string of the Modules to be included in a custom package. If omitted, all modules will be included (demos and tests will not be included).

grunt custom --include="inlineEdit, uiOptions"

####--exclude####

value: "module(s)" (String) only available to custom packages

The exclude option takes in a comma-separated string of the Modules to be excluded from a custom package. The --exclude option takes priority over --include.

grunt custom --exclude="jQuery"

grunt custom --include="framework" --exclude="jQuery"

####--name####

value: "custom suffix" (String) only available to custom packages

By default, custom packages are given a name with the form infusion-custom-.zip and the concatenated js file is called infusion-custom.js. By supplying the --name option, you can replace "custom" with any other valid string you like.

grunt custom --name="myPackage"    # this produces infusion-myPackage.js

###Modules###

####Framework Modules####

  • enhancement
  • framework
  • fss
  • preferences
  • renderer

####Component Modules####

  • inlineEdit
  • pager
  • progress
  • reorderer
  • slidingPanel
  • tableOfContents
  • tabs
  • textfieldSlider
  • tooltip
  • uiOptions
  • undo
  • uploader

####External Libraries####

  • fastXmlPull
  • fonts
  • jQuery
  • jQueryScrollToPlugin
  • jQueryTouchPunchPlugin
  • jQueryUICore
  • jQueryUIWidgets
  • json
  • swfobject
  • swfupload