/
Fluid WebRTC Component

Fluid WebRTC Component

Jul 29, 2013

Setup: 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-0.4/fluid-components/js/Fluid-all.js"></script> <script type="text/javascript" src="<filename>.js"></script>

NOTE that the Fluid-all.js file is minified - all of the whitespace has been removed, so it isn't really human-readable. If you're using the source distribution and you want to be able to debug the code, you'll want to include each of the required files individually. This would look like this:

<script type="text/javascript" src="fluid-0.4/fluid-components/js/jquery/jquery-1.2.6.js"></script> <script type="text/javascript" src="fluid-0.4/fluid-components/js/jquery/jquery.keyboard-a11y.js"></script> ...other files, if necessary... <script type="text/javascript" src="fluid-0.4/fluid-components/js/jquery/jARIA.js"></script> <script type="text/javascript" src="fluid-0.4/fluid-components/js/fluid/Fluid.js"></script> <script type="text/javascript" src="fluid-0.4/fluid-components/js/fluid/<Component>.js"></script> <script type="text/javascript" src="<filename>.js"></script>

But all of these individual files are not necessary to make it work - the Fluid-all.js file has everything you need.

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