This is a simple jQuery plugin that is meant to emulate the classic xeyes program. While it doesn’t have many native uses, some very creative people managed to incorporate it into their projects. If you have any questions or need help using this script, contact @felix_mc.
Additional documentation here.
The plugin requires two block level elements, the eye and the iris. For the plugin to work properly, it also requires that they each have proper dimensions defined using CSS.
<div class="eyeball">
<div class="iris"></div>
</div>
.eyeball {
width: 110px;
height: 150px;
background: #fff;
margin-right: 10px;
}
.iris {
width: 25px;
height: 25px;
background: #000;
}
Finally, to initialize the plugin, simply call the js function on the iris element:
$('.iris').xeyes();
The plugin will automatically assume that its immidiate parent will be used as the eyeball element. The eyeball class was only required for the styling.
All of the following are optional. You can use them to further customize this plugin.
padding: refers to the distance in pixels between the iris and the edge of the eyeball, similar to padding in CSS. The default value is 0. Example
position: refers to the initial position the iris should be in prior to following the mouse. The following string values are supported: center, top, bottom, left, right, topLeft, topRight, bottomLeft, bottomRight. A number can also be provided, which will be interpreted as an angle in degrees at which to point the eyes at. Lastly, a javascript object with x and y properties as integers is also accepted. The properties will be used to offset the iris from the center of the eye. The default value is “center”. Example 1 Example 2 Example 3
reset: a boolean value that determines whether the eyes should return to their initial position when the mouse exits the trigger. The default value is false. In the following example, the initial position is set to topRight and the trigger is set to the red box. When you hover over the red box, the eyes should follow the mouse. However, when the mouse leaves the red box, they will return to the top right position. Example
trigger: refers to the html element that triggers the eyes to follow the cursor. By default this is window, meaning that the eyes will follow the cursor everywhere on a page. Acceptable value for this parameter are any valid jQuery selector strings as well as any jQuery wrapped set returned by the jQuery selector. In other words, both ".trigger" and $(".trigger") are valid options that will have the same result. In the following example the trigger is set to be the red box. Example
radius: determines the shape of the iris movement. It supports two string values circular and natural. natural makes the iris follow the natural shape of eye, while circular forces the path of the iris to be a perfect circle. The default value is natural. Below is an example of circular. Example