Quick Start

In this quick start, you'll learn how to add the Carousel widget to an HTML project using HTML markup and jQuery script.

To create a new HTML page in your favorite text editor, add the following code and save the document with an .html extension.
Drop down and copy markup
Paste in your favorite text editor.
Copy Code

<!DOCTYPE HTML> <HTML> <head> </head> <body> </body> </HTML>

Paste in your favorite text editor.	Copy Code
<!DOCTYPE HTML> <HTML> <head> </head> <body> </body> </HTML>

Add links to the dependencies to your HTML page within the <head> tags. Find the latest dependencies in the content delivery network (CDN) file at wijmo cdn.

References	Copy Code
<!--Theme--> <link href="http://cdn.wijmo.com/themes/aristo/jquery-wijmo.css" rel="stylesheet" type="text/css" /> <!--Wijmo Widgets CSS--> <link href="http://cdn.wijmo.com/jquery.wijmo-pro.all.3.20162.99.min.css" rel="stylesheet" type="text/css" /> <!--RequireJs--> <script type="text/javascript" src="http://cdn.wijmo.com/external/require.js"></script>

References

Copy Code

<!--Theme-->
<link href="http://cdn.wijmo.com/themes/aristo/jquery-wijmo.css" rel="stylesheet" type="text/css" />

<!--Wijmo Widgets CSS-->
<link href="http://cdn.wijmo.com/jquery.wijmo-pro.all.3.20162.99.min.css" rel="stylesheet" type="text/css" />

<!--RequireJs-->
<script type="text/javascript" src="http://cdn.wijmo.com/external/require.js"></script>

Add the following markup within the <body> tags to create the widget. The <div> element creates the widget, and we call its id attribute in jQuery to initialize it. The <ul> element adds eight images, each with text captions, to the carousel.

Markup	Copy Code
<div id="carousel"> <ul> <li> <img src="Images\Sports1.png" alt="Sports 1" /> <span>Word Caption 1</span></li> <li> <img src="Images\Sports2.png" alt="Sports 2" /> <span>Word Caption 2</span></li> <li> <img src="Images\Sports3.png" alt="Sports 3" /> <span>Word Caption 3</span></li> <li> <img src="Images\sports4.png" alt="Sports 4" /> <span>Word Caption 4</span></li> <li> <img src="Images\sports5.png" alt="Sports 5" /> <span>Word Caption 5</span></li> <li> <img src="Images\sports6.png" alt="Sports 6" /> <span>Word Caption 6</span></li> <li> <img src="Images\sports7.png" alt="Sports 7" /> <span>Word Caption 7</span></li> <li> <img src="Images\sports8.png" alt="Sports 8" /> <span>Word Caption 8</span></li> </ul> </div>

Markup

Copy Code

<div id="carousel">
  <ul>
    <li>
        <img src="Images\Sports1.png" alt="Sports 1" />
        <span>Word Caption 1</span></li>
    <li>
        <img src="Images\Sports2.png" alt="Sports 2" />
        <span>Word Caption 2</span></li>
    <li>
        <img src="Images\Sports3.png" alt="Sports 3" />
        <span>Word Caption 3</span></li>
    <li>
        <img src="Images\sports4.png" alt="Sports 4" />
        <span>Word Caption 4</span></li>
    <li>
        <img src="Images\sports5.png" alt="Sports 5" />
        <span>Word Caption 5</span></li>
    <li>
        <img src="Images\sports6.png" alt="Sports 6" />
        <span>Word Caption 6</span></li>
    <li>
        <img src="Images\sports7.png" alt="Sports 7" />
        <span>Word Caption 7</span></li>
    <li>
        <img src="Images\sports8.png" alt="Sports 8" />
        <span>Word Caption 8</span></li>
  </ul>
</div>

Within the <head> tags, below the references, add the following script to initialize the widget and set several options.

Only one image shows in the view area (display).
The timer and pager elements are shown (showTimer and showPager).
The carousel loops to the first image when the Next button is selected while on the last image (loop).
Controls are shown when the mouse is over the widget (showControlsOnHover).

Script	Copy Code
<script type="text/javascript"> requirejs.config({ baseUrl: "http://cdn.wijmo.com/amd-js/3.20162.99", paths: { "jquery": "jquery-1.11.1.min", "jquery-ui": "jquery-ui-1.11.0.custom.min", "jquery.ui": "jquery-ui", "jquery.mousewheel": "jquery.mousewheel.min", "globalize": "globalize.min" } }); </script> <script id="scriptInit" type="text/javascript"> require(["wijmo.wijcarousel"], function () { $(document).ready(function () { $("#carousel").wijcarousel({ display: 1, showTimer: true, showPager: true, loop: true, showControlsOnHover: true }); }); }); </script>

Script

Copy Code

<script type="text/javascript">
    requirejs.config({
        baseUrl: "http://cdn.wijmo.com/amd-js/3.20162.99",
            paths: {
                "jquery": "jquery-1.11.1.min",
                "jquery-ui": "jquery-ui-1.11.0.custom.min",
                "jquery.ui": "jquery-ui",
                "jquery.mousewheel": "jquery.mousewheel.min",
                "globalize": "globalize.min"
            }
    });
</script>

<script id="scriptInit" type="text/javascript">
    require(["wijmo.wijcarousel"], function () {
        $(document).ready(function () {
            $("#carousel").wijcarousel({
                display: 1,
                showTimer: true,
                showPager: true,
                loop: true,
                showControlsOnHover: true
            });
        });
    });
</script>

Within the <head> tags, above the script to initialize the widget, set the size of the widget using CSS.
Drop down and copy markup to paste inside the head tags
Style
Copy Code

<style type="text/css"> #carousel { width: 650px; height: 300px; } </style>
Save your HTML file and open it in a browser. The widget appears like the following live widget.

Style	Copy Code
<style type="text/css"> #carousel { width: 650px; height: 300px; } </style>

Reference

showControlsOnHover Option

KO

KO Carousel Binding