Viewer.js
JavaScript image viewer.
- Website
- jquery-viewer - A jQuery plugin wrapper for Viewer.js.
Table of contents
- Features
- Main
- Getting started
- Keyboard support
- Options
- Methods
- Events
- No conflict
- Browser support
- Contributing
- Versioning
- License
Features
- Supports 42 options
- Supports 23 methods
- Supports 9 events
- Supports modal and inline modes
- Supports touch
- Supports move
- Supports zoom
- Supports rotation
- Supports scale (flip)
- Supports keyboard
- Cross-browser support
Main
dist/├── viewer.css├── viewer.min.css (compressed)├── viewer.js (UMD)├── viewer.min.js (UMD, compressed)├── viewer.common.js (CommonJS, default)└── viewer.esm.js (ES Module)
Getting started
Installation
npm install viewerjs
In browser:
The cdnjs provides CDN support for Viewer.js's CSS and JavaScript. You can find the links here.
Usage
Syntax
element options
-
element
- Type:
HTMLElement
- The target image or container of images for viewing.
- Type:
-
options (optional)
- Type:
Object
- The options for viewing. Check out the available options.
- Type:
Example
<!-- a block container is required -->
// You should import the CSS file.// import 'viewerjs/dist/viewer.css';; // View an imageconst viewer = document inline: true { viewer; };// Then, show the image by click it, or call `viewer.show()`. // View a list of imagesconst gallery = document;// Then, show one image by click it, or call `gallery.show()`.
Keyboard support
Only available in modal mode.
Esc
: Exit full screen or close the viewer or exit modal mode or stop play.Space
: 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.
Options
You may set viewer options with new Viewer(image, options)
.
If you want to change the global default options, You may use Viewer.setDefaults(options)
.
backdrop
- Type:
Boolean
orString
- Default:
true
Enable a modal backdrop, specify static
for a backdrop which doesn't close the modal on click.
button
- Type:
Boolean
- Default:
true
Show the button on the top-right of the viewer.
navbar
- Type:
Boolean
orNumber
- Default:
true
- Options:
0
orfalse
: hide the navbar1
ortrue
: show the navbar2
: show the navbar only when the screen width is greater than 768 pixels3
: show the navbar only when the screen width is greater than 992 pixels4
: show the navbar only when the screen width is greater than 1200 pixels
Specify the visibility of the navbar.
title
- Type:
Boolean
orNumber
orFunction
orArray
- Default:
true
- Options:
0
orfalse
: hide the title1
ortrue
orFunction
orArray
: show the title2
: show the title only when the screen width is greater than 768 pixels3
: show the title only when the screen width is greater than 992 pixels4
: show the title only when the screen width is greater than 1200 pixelsFunction
: customize the title content[Number, Function]
: the first element indicate the visibility, the second element customize the title content
Specify the visibility and the content of the title.
The name comes from the
alt
attribute of an image element or the image name parsed from URL.
For example, title: 4
equals to:
image title: 4 ` ( × )`;
toolbar
- Type:
Boolean
orNumber
orObject
- Default:
true
- Options:
0
orfalse
: hide the toolbar.1
ortrue
: show the toolbar.2
: show the toolbar only when the screen width is greater than 768 pixels.3
: show the toolbar only when the screen width is greater than 992 pixels.4
: show the toolbar only when the screen width is greater than 1200 pixels.{ key: Boolean | Number }
: show or hide the toolbar.{ key: String }
: customize the size of the button.{ key: Function }
: customize the click handler of the button.{ key: { show: Boolean | Number, size: String, click: Function }
: customize each property of the button.- Available keys: "zoomIn", "zoomOut", "oneToOne", "reset", "prev", "play", "next", "rotateLeft", "rotateRight", "flipHorizontal" and "flipVertical".
- Available sizes: "small", "medium" (default) and "large".
Specify the visibility and layout of the toolbar its buttons.
For example, toolbar: 4
equals to:
image toolbar: zoomIn: 4 zoomOut: 4 oneToOne: 4 reset: 4 prev: 4 play: show: 4 size: 'large' next: 4 rotateLeft: 4 rotateRight: 4 flipHorizontal: 4 flipVertical: 4 ;
className
- Type:
String
- Default:
''
Custom class name(s) to add to the viewer's root element.
container
- Type:
Element
orString
- Default:
'body'
- An element or a valid selector for Document.querySelector
The container to put the viewer in modal mode.
Only available when the
inline
option is set tofalse
.
filter
- Type:
Function
- Default:
null
Filter the images for viewing (should return true
if the image is viewable).
For example:
image { return imagecomplete; };
fullscreen
- Type:
Boolean
- Default:
true
Enable to request full screen when play.
Requires the browser supports Full Screen API.
initialViewIndex
- Type:
Number
- Default:
0
Define the initial index of image for viewing.
Also used as the default parameter value of the
view
method.
inline
- Type:
Boolean
- Default:
false
Enable inline mode.
interval
- Type:
Number
- Default:
5000
The amount of time to delay between automatically cycling an image when playing.
keyboard
- Type:
Boolean
- Default:
true
Enable keyboard support.
loading
- Type:
Boolean
- Default:
true
Indicate if show a loading spinner when load image or not.
loop
- Type:
Boolean
- Default:
true
Indicate if enable loop viewing or not.
If the current image is the last one, then the next one to view is the first one, and vice versa.
minWidth
- Type:
Number
- Default: 200
Define the minimum width of the viewer.
Only available in inline mode (set the
inline
option totrue
).
minHeight
- Type:
Number
- Default: 100
Define the minimum height of the viewer.
Only available in inline mode (set the
inline
option totrue
).
movable
- Type:
Boolean
- Default:
true
Enable to move the image.
rotatable
- Type:
Boolean
- Default:
true
Enable to rotate the image.
scalable
- Type:
Boolean
- Default:
true
Enable to scale the image.
zoomable
- Type:
Boolean
- Default:
true
Enable to zoom the image.
zoomOnTouch
- Type:
Boolean
- Default:
true
Enable to zoom the current image by dragging on the touch screen.
zoomOnWheel
- Type:
Boolean
- Default:
true
Enable to zoom the image by wheeling mouse.
slideOnTouch
- Type:
Boolean
- Default:
true
Enable to slide to the next or previous image by swiping on the touch screen.
toggleOnDblclick
- Type:
Boolean
- Default:
true
Indicate if toggle the image size between its natural size and initial size when double click on the image or not.
In other words, call the toggle
method automatically when double click on the image.
Requires
dblclick
event support.
tooltip
- Type:
Boolean
- Default:
true
Show the tooltip with image ratio (percentage) when zoom in or zoom out.
transition
- Type:
Boolean
- Default:
true
Enable CSS3 Transition for some special elements.
zIndex
- Type:
Number
- Default:
2015
Define the CSS z-index
value of viewer in modal mode.
zIndexInline
- Type:
Number
- Default:
0
Define the CSS z-index
value of viewer in inline mode.
zoomRatio
- Type:
Number
- Default:
0.1
Define the ratio when zoom the image by wheeling mouse.
minZoomRatio
- Type:
Number
- Default:
0.01
Define the min ratio of the image when zoom out.
maxZoomRatio
- Type:
Number
- Default:
100
Define the max ratio of the image when zoom in.
url
- 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 should return a valid image URL.
For example:
image { return imagesrc; };
ready
- Type:
Function
- Default:
null
A shortcut of the ready
event.
show
- Type:
Function
- Default:
null
A shortcut of the show
event.
shown
- Type:
Function
- Default:
null
A shortcut of the shown
event.
hide
- Type:
Function
- Default:
null
A shortcut of the hide
event.
hidden
- Type:
Function
- Default:
null
A shortcut of the hidden
event.
view
- Type:
Function
- Default:
null
A shortcut of the view
event.
viewed
- Type:
Function
- Default:
null
A shortcut of the viewed
event.
zoom
- Type:
Function
- Default:
null
A shortcut of the zoom
event.
zoomed
- Type:
Function
- Default:
null
A shortcut of the zoomed
event.
Methods
All methods allow chain composition.
As there are some asynchronous processes when start the viewer, you should call a method only when it is available, see the following lifecycle:
image { // 2 methods are available here: "show" and "destroy". } { // 9 methods are available here: "hide", "view", "prev", "next", "play", "stop", "full", "exit" and "destroy". } { // All methods are available here except "show". thisviewer; };
show([immediate])
- immediate (optional):
- Type:
Boolean
- Default:
false
- Indicates if show the viewer immediately or not.
- Type:
Show the viewer.
Only available in modal mode.
hide([immediate])
- immediate (optional):
- Type:
Boolean
- Default:
false
- Indicates if hide the viewer immediately or not.
- Type:
hide the viewer.
Only available in modal mode.
view([index])
- index (optional):
- Type:
Number
- Default:
0
(inherits from theinitialViewIndex
option) - The index of the image for viewing
- Type:
View one of the images with image's index. If the viewer is not shown, will show the viewer first.
viewer; // View the second image
prev([loop=false])
- loop (optional):
- Type:
Boolean
- Default:
false
- Indicate if turn to view the last one when it is the first one at present.
- Type:
View the previous image.
next([loop=false])
- loop (optional):
- Type:
Boolean
- Default:
false
- Indicate if turn to view the first one when it is the last one at present.
- Type:
View the next image.
move(offsetX[, offsetY])
-
offsetX:
- Type:
Number
- 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 with relative offsets.
viewer;viewer; // Move leftviewer; // Move rightviewer; // Move upviewer; // Move down
moveTo(x[, y])
-
x:
- Type:
Number
- The
left
value of the image
- Type:
-
y (optional):
- Type:
Number
- The
top
value of the image - If not present, its default value is
x
.
- Type:
Move the image to an absolute point.
zoom(ratio[, hasTooltip])
-
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 with a relative ratio
viewer;viewer;
zoomTo(ratio[, hasTooltip])
-
ratio:
- Type:
Number
- Requires a positive number (ratio > 0)
- Type:
-
hasTooltip (optional):
- Type:
Boolean
- Default:
false
- Show tooltip
- Type:
Zoom the image to an absolute ratio.
viewer; // Zoom to zero size (0%)viewer; // Zoom to natural size (100%)
rotate(degree)
- degree:
- Type:
Number
- Rotate right: requires a positive number (degree > 0)
- Rotate left: requires a negative number (degree < 0)
- Type:
Rotate the image with a relative degree.
viewer;viewer;
rotateTo(degree)
- degree:
- Type:
Number
- Type:
Rotate the image to an absolute degree.
viewer; // Reset to zero degreeviewer; // Rotate a full round
scale(scaleX[, scaleY])
-
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.
viewer; // Flip both horizontal and verticalviewer; // Flip horizontalviewer; // Flip vertical
scaleX(scaleX)
- 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.
viewer; // Flip horizontal
scaleY(scaleY)
- 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.
viewer; // Flip vertical
play([fullscreen])
- fullscreen (optional):
- Type:
Boolean
- Default:
false
- Indicate if request fullscreen or not.
- Type:
Play the images.
stop()
Stop play.
full()
Enter modal mode.
Only available in inline mode.
exit()
Exit modal mode.
Only available in inline mode.
tooltip()
Show the current ratio of the image with percentage.
Requires the
tooltip
option set totrue
.
toggle()
Toggle the image size between its natural size and initial size.
Used by the
toggleOnDblclick
option.
reset()
Reset the image to its initial state.
update()
Update the viewer instance when the source images changed (added, removed or sorted).
If you load images dynamically (with XMLHTTPRequest), you can use this method to add the new images to the viewer instance.
destroy()
Destroy the viewer and remove the instance.
Events
All events can access the viewer instance with this.viewer
in its handler.
Be careful to use these events in other component which has the same event names, e.g.: Bootstrap's modal.
let viewer; image; viewer = image;
ready
This event fires when a viewer instance is ready for viewing.
In modal mode, this event will not be triggered until you click on one of the images.
show
This event fires when the viewer modal starts to show.
Only available in modal mode.
shown
This event fires when the viewer modal has shown.
Only available in modal mode.
hide
This event fires when the viewer modal starts to hide.
Only available in modal mode.
hidden
This event fires when the viewer modal has hidden.
Only available in modal mode.
view
-
event.detail.originalImage:
- Type:
HTMLImageElement
- The original image.
- Type:
-
event.detail.index:
- Type:
Number
- The index of the original image.
- Type:
-
event.detail.image:
- Type:
HTMLImageElement
- The current image (a clone of the original image).
- Type:
This event fires when a viewer starts to show (view) an image.
viewed
- event.detail: the same as the
view
event.
This event fires when a viewer has shown (viewed) an image.
zoom
-
event.detail.originalEvent:
- Type:
Event
- Options:
wheel
,touchmove
.
- Type:
-
event.detail.oldRatio:
- Type:
Number
- The old (current) ratio of the image.
- Type:
-
event.detail.ratio:
- Type:
Number
- The new (next) ratio of the image (
imageData.width / imageData.naturalWidth
).
- Type:
This event fires when a viewer starts to zoom (in or out) an image.
zoomed
- event.detail: the same as the
zoom
event.
This event fires when a viewer has zoomed (in or out) an image.
No conflict
If you have to use other viewer with the same namespace, just call the Viewer.noConflict
static method to revert to it.
Browser support
- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Opera (latest)
- Edge (latest)
- Internet Explorer 9+
Contributing
Please read through our contributing guidelines.
Versioning
Maintained under the Semantic Versioning guidelines.