Wiki Markup | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Include Page | ||||
---|---|---|---|---|
|
...
Step 1: Prepare your markup
We'll start with an HTML file called pop-up-progress.html
. This page contains one thing, a big button that says,
Wiki Markup |
---|
{html}<button id="showButton">Do something...</button>{html} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
<div id="main">
<p>
<button id="showButton">Do something...</button>
</p>
</div>
{code}
|
Now
...
we
...
need
...
to
...
add
...
the
...
markup
...
that
...
describes
...
the
...
Progress
...
component.
...
The most basic Progress component is made up of a bar and an indicator. You can include other markup in your Progress but you must include these two elements. (Although the bar does not have to be visible.)
Our Tutorial example contains a few other elements.
The HTML looks like this:
Code Block | ||||
---|---|---|---|---|
| ||||
<div class="container" id="main">
<p>
<button id="showButton">Do something...</button>
</p>
<div class="flc-progress progress-pop-up">
<h3>Current Progress</h3>
<div class="flc-progress-bar progress-bar">
<div class="flc-progress-indicator progress-indicator">
</div>
</div>
<p class="flc-progress-label progress-label">
0% Complete
</p>
</div>
</div>
{code}
|
In
...
the
...
code
...
above,
...
the
...
indicator
...
element
...
is
...
contained
...
within
...
the
...
progress
...
bar
...
element.
...
While
...
this
...
is
...
typical,
...
it
...
is
...
not
...
required.
...
The
...
indicator
...
and
...
the
...
progress
...
bar
...
can
...
be
...
marked
...
up
...
quite
...
independently
...
of
...
each
...
other.
...
The
...
only
...
requirement
...
is
...
that
...
there
...
be
...
both
...
an
...
indicator
...
element
...
and
...
a
...
bar
...
element
...
as
...
the
...
width
...
of
...
the
...
progress
...
bar
...
determines
...
the
...
final,
...
100%,
...
width
...
for
...
the
...
indicator.
...
...
Step 2:
...
Write
...
the
...
script
...
For
...
this
...
tutorial,
...
we'll
...
assume
...
that
...
you're
...
putting
...
your
...
Progress
...
initialization
...
and
...
control
...
code
...
into
...
a
...
file
...
named
...
progress-sample.js
...
.
...
In
...
your
...
own
...
integration
...
you
...
may
...
want
...
to
...
add
...
your
...
Progress
...
code
...
to
...
an
...
existing
...
Javascript
...
file
...
in
...
your
...
application.
...
In
...
your
...
file,
...
write
...
a
...
function
...
to
...
initialize
...
the
...
Progress
...
component:
...
Code Block | ||||
---|---|---|---|---|
| ||||
var myProgress; // you'll need to refer to this later
jQuery(document).ready(function () {
myProgress = fluid.progress("#main");
});
{code}
|
The
...
code
...
above
...
is
...
so
...
simple
...
because
...
in
...
this
...
example
...
we
...
chose
...
to
...
use
...
the
...
defaults
...
already
...
defined
...
for
...
the
...
Progress
...
component.
...
All
...
we
...
had
...
to
...
do
...
is
...
tell
...
Progress
...
where
...
to
...
find
...
all
...
it's
...
parts
...
– inside
...
a
...
container
...
with
...
an
...
id
...
of
...
main
...
.
...
Progress
...
knows
...
to
...
look
...
for
...
a
...
displayElement
...
with
...
a
...
class
...
of
...
flc-progress
...
,
...
and
...
a
...
progressBar
...
with
...
a
...
class
...
of
...
flc-progress-bar
...
,
...
etc.
...
Let's
...
make
...
a
...
small
...
change
...
to
...
the
...
default
...
options.
...
Let's
...
change
...
the
...
default
...
speed
...
for
...
updating
...
the
...
Progress
...
indicator
...
element.
...
We'll
...
make
...
it
...
run
...
a
...
bit
...
slower
...
and
...
a
...
bit
...
smoother
...
than
...
the
...
default.
...
Like
...
so:
...
Code Block | ||||
---|---|---|---|---|
| ||||
jQuery(document).ready(function () {
myProgress = fluid.progress("#main", {
speed: 1000 // the default is 200, quite fast
});
});
{code}
|
Finally
...
we
...
need
...
to
...
wire
...
up
...
our
...
"do
...
something"
...
button
...
to
...
call
...
our
...
anIllusionOfProgress
...
function:
...
Code Block | ||||
---|---|---|---|---|
| ||||
$("#showButton").click(function () {
anIllusionOfProgress(myProgress, 0, 20);
});
{code}
|
A
...
full
...
description
...
of
...
the
...
public
...
methods
...
of
...
Progress
...
can
...
be
...
found
...
in
...
the
...
...
...
.
...
Step 3:
...
Add
...
the
...
scripts
...
to
...
your
...
HTML
...
You'll
...
need
...
to
...
add
...
your
...
script
...
and
...
the
...
Fluid
...
library
...
to
...
your
...
HTML
...
file.
...
In
...
the
...
header
...
of
...
the
...
file,
...
link
...
to
...
the
...
Javascript
...
files
...
with
...
<script>
...
tags:
...
Code Block | ||||
---|---|---|---|---|
| ||||
<script type="text/javascript" src="infusion-1./InfusionAll.js"></script>
<script type="text/javascript" src="js/progress-sample.js"></script>
{code}
{color:red}NOTE{color} that the {{ |
NOTE that the InfusionAll.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:
...
Include Page | ||||
---|---|---|---|---|
|
But all of these individual files are not necessary to make it work - the InfusionAll.js
file has everything you need.
...
Anchor | ||||
---|---|---|---|---|
|
Step 4: Apply styles
Your progress won't look or behave like a Progress Bar without some styling. The Progress component does not come with default CSS for styling since you can build so many different kinds of progress bars with it.
For this example we're using a set of styles expressed in the progress-sample.css file from the Pop-up Progress standalone demo.
A few things to note about how we've styled the Progress elements in this example:
Code Block | ||||
---|---|---|---|---|
| ||||
#main {
position: relative; /* ensures the enclosed elements are positioned relative to the container */
}
.progress-bar {
text-align: left; /* pins the indicator to the left in IE */
}
.progress-indicator {
height: 16px; /* the height of the interior object will determine the
height of it's parent, in this case */
}
{code}
{panel:borderStyle=outset| borderColor=#566b30| bgColor=#D3E3C4}*A brief pitch for the Fluid Skinning System and {{ |
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
A brief pitch for the Fluid Skinning System and : *Styling your progress and your page will be made much easier if you take advantage of the [ ], especially the {{
which helps avoid cross-browser CSS inconsistencies. {panel} ---- |
...