Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 1.25 KB

README.md

File metadata and controls

55 lines (44 loc) · 1.25 KB

Flexi - A fluid slider carousel with jQuery

Example Usage

To use Flexi, you will need to include the jQuery library and the Flexi source file on your page:

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>
<script src="/path/to/jquery.flexi.js"></script>

The following is the expected HTML structure:

<parent> <----------------------| Parent Element
  <child> <--- Child Element ---|
  <child>
  <child>
</parent>

An example of this could be:

<div id="mycarousel">
  <img src="/path/to/image" />
  <img src="/path/to/image" />
  <img src="/path/to/image" />
  <img src="/path/to/image" />
</div>

After the required HTML markup has been setup, you must also setup Flexi. Example of a default Flexi setup:

<script type="text/javascript">
  $(function(){
    $('#mycarousel').flexi();
  });
</script>

Flexi does not require any CSS to work. You may include your own CSS styles to customize the Flexi carousel.

The following is the CSS used in the demo:

.flexi-wrapper {
  padding: 10px;
  background: #EEEEEE;
  border-radius: 5px;
  box-shadow: 0 0 7px #A0A0A0;
}