Child pages
  • Tutorial Template

Documentation for a historical release of Infusion: 1.3
Please view the Infusion Documentation site for the latest documentation.
If you're looking for Fluid Project coordination, design, communication, etc, try the Fluid Project Wiki.

Skip to end of metadata
Go to start of metadata

This documentation refers to the latest trunk version of the <Component> code.

This page will walk you through an example of adding the Fluid <Component> component to an HTML file.

This is a panel that can be used for tips, notes, etc.

This tutorial assumes that:

  • you are already familiar with HTML, Javascript and CSS
  • you are familiar with what the <Component> is and does
  • now you just want to know how to add it to your file.

For more general information about the <Component>, see <main component page>. For technical API documentation, see <Component> API.

Tutorial: How to Use the <Component>

Scenario

<Describe the real-world scenario that is the basis of the tutorial.> This tutorial will show you how to use the Fluid <Component> for this.

There are four basic steps to adding the <Component> to your application:

  • Step 0: Download and install the Fluid Infusion library
  • Step 1: Prepare your markup
  • Step 2: Write the script
  • Step 3: Add the script to your HTML
  • Step 4: Apply styles

The rest of this tutorial will explain each of these steps in detail.

On This Page
Still need help?

Join the infusion-users mailing list and ask your questions there.


Step 0: Download and install the Fluid Infusion library

  1. Download a copy of the Fluid Infusion component library from:
  2. Unpack the zip file you just downloaded, and place the resulting folder somewhere convenient for your development purposes.
    The folder will have the release number in it's name (e.g. fluid-0.4/). The rest of this tutorial will use fluid-0.4 in its examples, but if you downloaded a different version, you'll have to adjust.

Step 1: Prepare your markup

Let's assume that you're starting with an HTML file, called filename...

initial html here

In a browser window, this might look something like this:

<screenshot of page here>

The <Component> needs to know about the 'container' of .... In this case, <...> would be the container... We'll attach unique IDs each of these so that we'll be able to identify them to the <Component>:

modified html here

That's all - these are the only changes you need to make to your HTML.


Step 2: Write the script

You'll need to create a file, say filename, to contain your initialization script - the script you write to apply the <Component> to your <stuff>.

In this file, write a function that <...>:

jQuery(document).ready(function () {
    initialization code here
});

<explain the function>

Important note

<any caveats about selectors, and the fact that any selector will do, not just the one in the example.>


Step 3: Add the script to your HTML

You'll need to add your initialization script, along with the Fluid library, to you HTML file. In the header of the file, link to the Javascript files with <script> tags:

<script type="text/javascript" src="Fluid-all.js"></script>
<script type="text/javascript" src="<filename>.js"></script>

That's it! That's all you need to do to add the <...> functionality to your document.

BUT: If you look at the file in a browser now, it doesn't look any different than it looked before - there's no way to tell that <...>. That's what the styles are for.


Step 4: Apply styles

There are a number of "interesting moments" that happen while <...>. These include, for example, <...>

Important note

The styles in the example below are just that: examples. You are free to create whatever styles you like <...>. The important thing to understand is

  • what the interesting moments are, and
  • what the names of the styles for those moments are

  • No labels