A simple jQuery image viewing plugin.
- Supports options
- Supports methods
- Supports events
- Supports touch
- Supports move
- Supports zoom
- Supports rotation
- Supports scale (flip)
- Supports keyboard
- Cross-browser support
dist/
├── viewer.css ( 8 KB)
├── viewer.min.css ( 7 KB)
├── viewer.js (43 KB)
└── viewer.min.js (19 KB)
Four quick start options are available:
- Download the latest release.
- Clone the repository:
git clone https://github.com/fengyuanchen/viewer.git
. - Install with NPM:
npm install imageviewer
. - Install with Bower:
bower install imageviewer
.
Include files:
<script src="/path/to/jquery.js"></script><!-- jQuery is required -->
<link href="/path/to/viewer.css" rel="stylesheet">
<script src="/path/to/viewer.js"></script>
Initialize with $.fn.viewer
method.
<!-- a block container is required -->
<div>
<img class="image" src="picture.jpg" alt="Picture">
</div>
<div>
<ul class="images">
<li><img src="picture.jpg" alt="Picture"></li>
<li><img src="picture-2.jpg" alt="Picture 2"></li>
<li><img src="picture-3.jpg" alt="Picture 3"></li>
</ul>
</div>
// View one image
$('.image').viewer();
// View some images
$('.images').viewer();
Only available in modal mode.
Esc
: Exit full screen or stop play.←
: View the previous image.→
: View the next image.↑
: Zoom in the image.↓
: Zoom out the image.Ctrl + 0
: Zoom out to initial size.Ctrl + 1
: Zoom in to natural size.
You may set viewer options with $().viewer(options)
.
If you want to change the global default options, You may use $.fn.viewer.setDefaults(options)
.
- Type:
Boolean
- Default:
false
Enable inline mode.
- Type:
Boolean
- Default:
true
Show the button on the top-right of the viewer.
- Type:
Boolean
- Default:
true
Show the navbar.
- Type:
Boolean
- Default:
true
Show the title.
The title comes from the
alt
attribute of an image element or the image name parsed from URL.
- Type:
Boolean
- Default:
true
Show the toolbar.
- Type:
Boolean
- Default:
true
Show the tooltip with image ratio (percentage) when zoom in or zoom out
- Type:
Boolean
- Default:
true
Enable to move the image.
- Type:
Boolean
- Default:
true
Enable to zoom the image.
- Type:
Boolean
- Default:
true
Enable to rotate the image.
- Type:
Boolean
- Default:
true
Enable to scale the image.
- Type:
Boolean
- Default:
true
Enable CSS3 Transition for some special elements.
- Type:
Boolean
- Default:
true
Enable to request full screen when play.
Requires the browser supports Full Screen API.
- Type:
Boolean
- Default:
true
Enable keyboard support.
- Type:
Number
- Default:
5000
Define interval of each image when playing.
- Type:
Number
- Default:
0.1
Define the ratio when zoom the image by wheeling mouse.
- Type:
Number
- Default:
0.01
Define the min ratio of the image when zoom out.
- Type:
Number
- Default:
100
Define the max ratio of the image when zoom in.
- Type:
Number
- Default:
2015
Define the CSS z-index
value of viewer in modal mode.
- Type:
Number
- Default:
0
Define the CSS z-index
value of viewer in inline mode.
- Type:
String
orFunction
- Default:
'src'
Define where to get the original image URL for viewing.
If it is a string, it should be one of the attributes of each image element. If it is a function, it will be called on each image and should return a valid image URL.
- Type:
Function
- Default:
null
A shortcut of the "build.viewer" event.
- Type:
Function
- Default:
null
A shortcut of the "built.viewer" event.
- Type:
Function
- Default:
null
A shortcut of the "show.viewer" event.
- Type:
Function
- Default:
null
A shortcut of the "shown.viewer" event.
- Type:
Function
- Default:
null
A shortcut of the "hide.viewer" event.
hidden
- Type:
Function
- Default:
null
A shortcut of the "hidden.viewer" event.
As there is an asynchronous process when load the image(s), you should call most of the methods after shown (modal mode) or built (inline mode), except "show" (modal mode) and "destroy".
// Modal mode
$().viewer({
shown: function () {
$().viewer('method', argument1, , argument2, ..., argumentN);
}
}
// Inline mode
$().viewer({
built: function () {
$().viewer('method', argument1, , argument2, ..., argumentN);
}
}
Show the viewer.
Only available in modal mode.
hide the viewer.
Only available in modal mode.
- index (optional):
- Type:
Number
- Default:
0
- The index of the image for viewing
- Type:
View one of the images with image's index.
$().viewer('view', 1); // View the second image
View the previous image.
View the next image.
-
offsetX:
- Type:
Number
- Default:
0
- Moving size (px) in the horizontal direction
- Type:
-
offsetY (optional):
- Type:
Number
- Moving size (px) in the vertical direction.
- If not present, its default value is
offsetX
- Type:
Move the image.
$().viewer('move', 1);
$().viewer('move', -1, 0); // Move left
$().viewer('move', 1, 0); // Move right
$().viewer('move', 0, -1); // Move up
$().viewer('move', 0, 1); // Move down
-
ratio:
- Type:
Number
- Zoom in: requires a positive number (ratio > 0)
- Zoom out: requires a negative number (ratio < 0)
- Type:
-
hasTooltip (optional):
- Type:
Boolean
- Default:
false
- Show tooltip
- Type:
Zoom the image.
$().viewer('zoom', 0.1);
$().viewer('zoom', -0.1);
-
ratio:
- Type:
Number
- Requires a positive number (ratio > 0)
- Type:
-
hasTooltip (optional):
- Type:
Boolean
- Default:
false
- Show tooltip
- Type:
Zoom the image to a special ratio.
$().viewer('zoomTo', 0); // Zoom to zero size (0%)
$().viewer('zoomTo', 1); // Zoom to natural size (100%)
- degree:
- Type:
Number
- Rotate right: requires a positive number (degree > 0)
- Rotate left: requires a negative number (degree < 0)
- Type:
Rotate the image.
Requires CSS3 2D Transforms support (IE 9+).
$().viewer('rotate', 90);
$().viewer('rotate', -90);
- degree:
- Type:
Number
- Type:
Rotate the image to a special angle.
Requires CSS3 2D Transforms support (IE 9+).
$().viewer('rotateTo', 0); // Reset to zero degree
$().viewer('rotateTo', 360); // Rotate a full round
-
scaleX:
- Type:
Number
- Default:
1
- The scaling factor to apply on the abscissa of the image
- When equal to
1
it does nothing.
- Type:
-
scaleY (optional):
- Type:
Number
- The scaling factor to apply on the ordinate of the image
- If not present, its default value is
scaleX
.
- Type:
Scale the image.
Requires CSS3 2D Transforms support (IE 9+).
$().viewer('scale', -1); // Flip both horizontal and vertical
$().viewer('scale', -1, 1); // Flip horizontal
$().viewer('scale', 1, -1); // Flip vertical
- scaleX:
- Type:
Number
- Default:
1
- The scaling factor to apply on the abscissa of the image
- When equal to
1
it does nothing
- Type:
Scale the abscissa of the image.
Requires CSS3 2D Transforms support (IE 9+).
$().viewer('scaleX', -1); // Flip horizontal
- scaleY:
- Type:
Number
- Default:
1
- The scaling factor to apply on the ordinate of the image
- When equal to
1
it does nothing
- Type:
Scale the ordinate of the image.
Requires CSS3 2D Transforms support (IE 9+).
$().viewer('scaleY', -1); // Flip vertical
Play the images.
Stop play.
Enter modal mode.
only available in inline mode.
Exit modal mode.
only available in inline mode.
Show the current ratio of the image with percentage.
Requires the
tooltip
option set totrue
.
Toggle the image size between its natural size and initial size.
Reset the image to its initial state.
Destroy the viewer and remove the instance.
This event fires when a viewer instance start to build.
This event fires when a viewer instance has built.
This event fires when a viewer element start to show.
only available in modal mode.
This event fires when a viewer element has shown.
only available in modal mode.
This event fires when a viewer element start to hide.
only available in modal mode.
hidden.viewer
This event fires when a viewer element has hidden.
only available in modal mode.
If you have to use other plugin with the same namespace, just call the $.fn.viewer.noConflict
method to revert to it.
<script src="other-plugin.js"></script>
<script src="viewer.js"></script>
<script>
$.fn.viewer.noConflict();
// Code that uses other plugin's "$().viewer" can follow here.
</script>
- Chrome (latest 2)
- Firefox (latest 2)
- Internet Explorer 8+
- Opera (latest 2)
- Safari (latest 2)
As a jQuery plugin, you also need to see the jQuery Browser Support.
Released under the MIT license.