This documentation is currently being moved to our new documentation site.

Please view or edit the documentation there, instead.

If you're looking for Fluid Project coordination, design, communication, etc, try the Fluid Project Wiki.

Set up your environment

Background

If you haven't already, it might be helpful to read our Developer Introduction to Infusion Framework before starting this tutorial.

Set Up Directory Structure

For this tutorial we'll assume this component is being created for your own use, not as a contribution to Infusion. If you do want to contribute your component to Infusion, the directory set-up and requirements will be a little different and is explained in Contributing Code.

Let's suppose you're creating a component that will display a bar graph of some data. First, set up your file folders in the following structure.

Create:

  • A top level directory called "webapp"
  • Two directories within it called "bargraph" and "shared"
  • A directory called "sample-data" within bargraph
  • Two directories within shared called "css" and "js"
  • A directory within css called "fss"
  • A directory within js called "infusion"

Your directories should now appear like the following:

Screen shot of directories

Add Infusion

A lot of the functionality of our component will be driven by Infusion code, so we'll need to add these dependencies to our component.

  • Download the latest release of Fluid Infusion and unzip it.
  • Copy the contents of the src/webapp/framework/fss/ into our shared/css/fss directory. 
  • Copy the MyInfusion.js file into js/infusion