fengyuanchen/viewerjs

fengyuanchen/viewerjs sits at 8.2k stars on GitHub, written primarily in JavaScript. JavaScript image viewer.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Snapshot
Top contributors
Show top contributors
Viewer.js
JavaScript image viewer.
- Website
- jquery-viewer - A jQuery plugin wrapper for Viewer.js.
Table of Contents
- Features
- Main Files
- Getting Started
- Keyboard Support
- Options
- Methods
- Static Methods
- Events
- Browser Support
- Contributing
- Versioning
- License
Features
- Supports 61 options
- Supports 23 methods
- Supports 17 events
- Supports modal and inline modes
- Supports touch
- Supports move
- Supports zoom
- Supports rotation
- Supports scale (flip)
- Supports keyboard
- Supports image magnification
- Cross-browser support
Main Files
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 the browser:
<link href="/path/to/viewer.css" rel="stylesheet">
<script src="/path/to/viewer.js"></script>
The cdnjs project provides CDN support for Viewer.js CSS and JavaScript. You can find the links here.
Usage
Syntax
new Viewer(element[, options])
-
element
- Type:
HTMLElement - The target image, or a container of images, to view.
- Type:
-
options (optional)
- Type:
Object - The configuration options. Check out the available options.
- Type:
Alternatively, you may use Viewer.create(element[, options]).
Example
<!-- a block container is required -->
<div>
<img id="image" src="picture.jpg" alt="Picture">
</div>
<div>
<ul id="images">
<li><img src="picture-1.jpg" alt="Picture 1"></li>
<li><img src="picture-2.jpg" alt="Picture 2"></li>
<li><img src="picture-3.jpg" alt="Picture 3"></li>
</ul>
</div>
// You should import the CSS file.
// import 'viewerjs/dist/viewer.css';
import Viewer from 'viewerjs';
// View an image.
const viewer = new Viewer(document.getElementById('image'), {
inline: true,
viewed() {
viewer.zoomTo(1);
},
});
// Then show the image by clicking it, or call `viewer.show()`.
// View a list of images.
// Note: all images within the container will be found by calling `element.querySelectorAll('img')`.
const gallery = new Viewer(document.getElementById('images'));
// Then show one image by clicking 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.Tab: Switch the focus state on the buttons in the viewer.Enter: Trigger the click event handler on the button.←: 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.
⬆ back to top
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:
BooleanorString - Default:
true
Enable the modal backdrop, specify static for the backdrop that will not close the modal on click.
button
- Type:
Boolean - Default:
true
Show the button on the top-right of the viewer.
navbar
- Type:
BooleanorNumberorStringorObject - Default:
true - Options:
0orfalse: hide the navbar1ortrue: 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 pixelssmall: show thumbnails at 24px tall.medium: show thumbnails at 32px tall.large: show thumbnails at 40px tall.Object: configure the navbar with the following properties:show(BooleanorNumber): specify the visibility of the navbar.size(String): specify the thumbnail size:small,medium, orlarge.position(String): specify the navbar position:top,right,bottom(default), orleft.visibleItemCount(Number): specify the number of thumbnail items to render around the active item. The default is calculated from the container width and the width of one thumbnail item, or from the container height and the height of one thumbnail item for theleftandrightpositions.
Specify the visibility of the navbar.
When setting a size, thumbnails use a $9 / 16$ width-to-height ratio.
navbar: {
show: true,
size: 'large',
position: 'bottom',
}
When positioned on the left or right, thumbnails are arranged vertically and use a $16 / 9$ width-to-height ratio.
navigation
-
Type:
BooleanorNumberorObject -
Default:
false -
Options:
0orfalse: hide the navigation buttons.1ortrue: show the navigation buttons.2: show the navigation buttons only when the screen width is greater than 768 pixels.3: show the navigation buttons only when the screen width is greater than 992 pixels.4: show the navigation buttons only when the screen width is greater than 1200 pixels.{ prev: Boolean | Number | Object, next: Boolean | Number | Object }: show or hide each navigation button.{ prev: { show: Boolean | Number, size: String }, next: { show: Boolean | Number, size: String } }: customize each navigation button.- Available sizes:
small(32px),medium(40px, default), andlarge(48px).
Show the previous and next buttons on the left and right sides of the viewer.
For example:
new Viewer(image, {
navigation: {
prev: {
size: 'large',
},
next: {
show: 2,
size: 'small',
},
},
});
title
- Type:
BooleanorNumberorFunctionorArray - Default:
true - Options:
0orfalse: hide the title1ortrueorFunctionorArray: 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 indicates the visibility; the second element customizes the title content
Specify the visibility and content of the title.
The name comes from the
altattribute of an image element or the image name parsed from its URL.
For example, title: 4 equals to:
new Viewer(image, {
title: [4, (image, imageData) => `${image.alt} (${imageData.naturalWidth} × ${imageData.naturalHeight})`]
});
toolbar
- Type:
BooleanorNumberorObject - Default:
true - Options:
0orfalse: hide the toolbar.1ortrue: 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.{ position: String }: specify the toolbar position:top,right,bottom(default), orleft.- Available built-in keys: "zoomIn", "zoomOut", "oneToOne", "reset", "prev", "play", "next", "rotateLeft", "rotateRight", "flipHorizontal", "flipVertical".
- Available built-in sizes: "small", "medium" (default) and "large".
Specify the visibility and layout of the toolbar and its buttons.
For example, toolbar: 4 equals to:
new Viewer(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,
position: 'bottom',
},
});
see more for custom toolbar.
className
- Type:
String - Default:
''
Custom class name(s) to add to the viewer's root element.
container
- Type:
ElementorString - Default:
'body' - An element or a valid selector for Document.querySelector
Container to place the viewer in the modal mode.
Only available when the
inlineoption is set tofalse.
filter
- Type:
Function - Default:
null
Filter the images for viewing (should return true if the image is viewable, return false to ignore the image).
For example:
new Viewer(image, {
filter(image) {
return image.complete;
},
});
Note that images without the
srcattribute set will be ignored by default.
fullscreen
- Type:
BooleanorFullscreenOptions - Default:
true
Enable to request full screen when play.
Requires the browser supports Fullscreen API.
inheritedAttributes
- Type:
Array - Default:
['crossOrigin', 'decoding', 'isMap', 'loading', 'referrerPolicy', 'sizes', 'srcset', 'useMap']
Define the extra attributes to inherit from the original image.
Note that the basic attributes
srcandaltwill always inherit from the original image.
initialCoverage
- Type:
Number - Default:
0.9
Define the initial coverage of the viewing image. It must be a positive number between 0 (0%) and 1 (100%).
initialViewIndex
- Type:
Number - Default:
0
Define the initial index of the image for viewing.
Also used as the default parameter value of the
viewmethod.
inline
- Type:
Boolean - Default:
false
Enable inline mode.
autoplay
- Type:
Boolean - Default:
true
Enable to automatically cycle the images when playing.
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.
focus
- Type:
Boolean - Default:
true
Focus the active item in the navbar when initialized.
Requires the
keyboardoption set totrue.
loading
- Type:
Boolean - Default:
true
Indicate if showing a loading spinner when loading the image or not.
loop
- Type:
Boolean - Default:
true
Indicate if enabling 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.
preload
- Type:
Boolean - Default:
true
Enable to preload the next or previous image before viewing it.
minWidth
- Type:
Number - Default: 200
Define the minimum width of the viewer.
Only available in inline mode (set the
inlineoption totrue).
minHeight
- Type:
Number - Default: 100
Define the minimum height of the viewer.
Only available in inline mode (set the
inlineoption totrue).
movable
- Type:
Boolean - Default:
true
Enable to move the image.
magnifier
- Type:
BooleanorObject - Default:
false - Options:
size(Number): the size of the magnifier in pixels. Defaults to100.zoomRatio(Number): the magnification ratio. Defaults to2.opacity(Number): the opacity of the magnifier, from0to1. Defaults to1.
Show a magnifier over the image when hovering in fullscreen mode. The magnifier is disabled on touch screens.
For example:
new Viewer(image, {
magnifier: {
size: 120,
zoomRatio: 3,
opacity: 0.8,
},
});
rotatable
- Type:
Boolean - Default:
true
Enable to rotate the image.
rotateOnGesture
- Type:
Boolean - Default:
true
Enable to rotate the current image with gesture events, such as a two-finger gesture on Mac Safari.
rotateOnTouch
- Type:
Boolean - Default:
true
Enable to rotate the current image with a two-finger gesture on a touch screen.
scalable
- Type:
Boolean - Default:
true
Enable to scale the image.
zoomable
- Type:
Boolean - Default:
true
Enable to zoom the image.
zoomOnGesture
- Type:
Boolean - Default:
true
Enable to zoom the current image with gesture events, such as a pinch gesture on Mac Safari.
zoomOnTouch
- Type:
Boolean - Default:
true
Enable to zoom the current image by dragging on the touch screen.
zoomOnWheel
- Type:
Boolean | String - Default:
true
Enable to zoom the image by wheeling the mouse.
Set to a modifier key name (ctrl, shift, alt, meta), or a combination joined with + (e.g. ctrl+shift), to only zoom when the given modifier key(s) are held down while wheeling. Otherwise, wheeling falls back to sliding when slideOnWheel is enabled.
slideOnTouch
- Type:
Boolean - Default:
true
Enable to slide to the next or previous image by swiping on the touch screen.
slideOnWheel
- Type:
Boolean | String - Default:
true
Enable to slide to the next or previous image by wheeling the mouse.
Set to a modifier key name (ctrl, shift, alt, meta), or a combination joined with + (e.g. ctrl+shift), to only slide when the given modifier key(s) are held down while wheeling.
Takes effect over the navbar, and also over the rest of the viewer when zoomOnWheel doesn't take effect for that wheel event.
toggleOnDblclick
- Type:
Boolean - Default:
true
Indicate whether to toggle the image size between its natural size and initial size when double-clicking the image.
In other words, call the toggle method automatically when the image is double-clicked.
Requires
dblclickevent support.
tooltip
- Type:
Boolean - Default:
true
Show the tooltip with image ratio (percentage) when zooming in or zooming out.
transition
- Type:
BooleanorObject - Default:
true
Enable CSS3 transitions for some special elements.
When passing an object, set a supported action to false to disable only its transition. The supported actions are show, hide, view, move, zoom, rotate, scale, play, and tooltip.
new Viewer(image, {
transition: {
hide: false,
view: false,
zoom: false,
},
});
zIndex
- Type:
Number - Default:
2015
Define the CSS z-index value of the viewer in modal mode.
zIndexInline
- Type:
Number - Default:
0
Define the CSS z-index value of the viewer in inline mode.
zoomRatio
- Type:
Number - Default:
0.1
Define the ratio when zooming the image by wheeling the mouse.
minZoomRatio
- Type:
NumberorFunction - Default:
0.01
Define the min ratio of the image when zooming out.
If it is a function, it receives the current image and image data, and should return the minimum ratio:
new Viewer(image, {
minZoomRatio(image, imageData) {
return imageData.naturalWidth > 2000 ? 0.1 : 0.01;
},
});
maxZoomRatio
- Type:
NumberorFunction - Default:
100
Define the max ratio of the image when zooming in.
If it is a function, it receives the current image and image data, and should return the maximum ratio:
new Viewer(image, {
maxZoomRatio(image, imageData) {
return imageData.naturalWidth > 2000 ? 2 : 10;
},
});
url
- Type:
StringorFunction - 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:
<img src="picture.jpg?size=160">
new Viewer(image, {
url(image) {
return image.src.replace('?size=160', '');
},
});
ready
- Type:
Function - Default:
null
Shortcut of the ready event.
show
- Type:
Function - Default:
null
Shortcut of the show event.
shown
- Type:
Function - Default:
null
Shortcut of the shown event.
hide
- Type:
Function - Default:
null
Shortcut of the hide event.
hidden
- Type:
Function - Default:
null
Shortcut of the hidden event.
view
- Type:
Function - Default:
null
Shortcut of the view event.
viewed
- Type:
Function - Default:
null
Shortcut of the viewed event.
move
- Type:
Function - Default:
null
Shortcut of the move event.
moved
- Type:
Function - Default:
null
Shortcut of the moved event.
rotate
- Type:
Function - Default:
null
Shortcut of the rotate event.
rotated
- Type:
Function - Default:
null
Shortcut of the rotated event.
scale
- Type:
Function - Default:
null
Shortcut of the scale event.
scaled
- Type:
Function - Default:
null
Shortcut of the scaled event.
zoom
- Type:
Function - Default:
null
Shortcut of the zoom event.
zoomed
- Type:
Function - Default:
null
Shortcut of the zoomed event.
play
- Type:
Function - Default:
null
Shortcut of the play event.
playing
- Type:
Function - Default:
null
Shortcut of the playing event.
stop
- Type:
Function - Default:
null
Shortcut of the stop event.
⬆ back to top
Methods
All methods support chain composition.
As there are some asynchronous processes when starting the viewer, you should call a method only when it is available. See the following lifecycle:
new Viewer(image, {
ready() {
// 2 methods are available here: "show" and "destroy".
},
shown() {
// 9 methods are available here: "hide", "view", "prev", "next", "play", "stop", "full", "exit" and "destroy".
},
viewed() {
// All methods are available here except "show".
this.viewer.zoomTo(1).rotateTo(180);
}
});
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 theinitialViewIndexoption) - The index of the image for viewing
- Type:
View one of the images with the image index. If the viewer is hidden, it will be shown first.
viewer.view(1); // 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(x[, y = x])
-
x:
- Type:
Number - The moving distance in the horizontal direction.
- Type:
-
y (optional):
- Type:
Number - The moving distance in the vertical direction.
- If not present, its default value is
x
- Type:
Move the image with relative offsets.
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
moveTo(x[, y = x])
-
x:
- Type:
Number - The new position in the horizontal direction.
- Type:
-
y (optional):
- Type:
Number - The new position in the vertical direction.
- If not present, its default value is
x.
- Type:
Move the image to an absolute point.
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.rotate(90);
viewer.rotate(-90);
rotateTo(degree)
- degree:
- Type:
Number
- Type:
Rotate the image to an absolute degree.
viewer.rotateTo(0); // Reset to zero degree
viewer.rotateTo(360); // 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
1it 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.scale(-1); // Flip both horizontal and vertical
viewer.scale(-1, 1); // Flip horizontal
viewer.scale(1, -1); // Flip vertical
scaleX(scaleX)
- scaleX:
- Type:
Number - Default:
1 - The scaling factor to apply on the abscissa of the image
- When equal to
1it does nothing
- Type:
Scale the abscissa of the image.
viewer.scaleX(-1); // Flip horizontal
scaleY(scaleY)
- scaleY:
- Type:
Number - Default:
1 - The scaling factor to apply on the ordinate of the image
- When equal to
1it does nothing
- Type:
Scale the ordinate of the image.
viewer.scaleY(-1); // Flip vertical
zoom(ratio[, showTooltip[, pivot]])
-
ratio:
- Type:
Number - Zoom in: requires a positive number (ratio > 0)
- Zoom out: requires a negative number (ratio < 0)
- Type:
-
showTooltip (optional):
- Type:
Boolean - Default:
false - Indicates whether to show the tooltip.
- Type:
-
pivot (optional):
- Type:
Object - Default:
null - Schema:
{ x: Number, y: Number } - The pivot point coordinate for zooming.
- Type:
Zoom the image with a relative ratio
viewer.zoom(0.1);
viewer.zoom(-0.1);
zoomTo(ratio[, showTooltip[, pivot]])
-
ratio:
- Type:
Number - Requires a positive number (ratio > 0)
- Type:
-
showTooltip (optional):
- Type:
Boolean - Default:
false - Indicates whether to show the tooltip.
- Type:
-
pivot (optional):
- Type:
Object - Default:
null - Schema:
{ x: Number, y: Number } - The pivot point coordinate for zooming.
- Type:
Zoom the image to an absolute ratio.
viewer.zoomTo(0); // Zoom to zero size (0%)
viewer.zoomTo(1); // Zoom to natural size (100%)
// Zoom to 50% from the center of the window.
viewer.zoomTo(0.5, false, {
x: window.innerWidth / 2,
y: window.innerHeight / 2,
});
play([fullscreen])
- fullscreen (optional):
- Type:
BooleanorFullscreenOptions - Default:
false - Indicates whether to request fullscreen.
- Type:
Play the images.
stop()
Stop play.
full()
Enter the modal mode.
Only available in inline mode.
exit()
Exit the modal mode.
Only available in inline mode.
tooltip()
Show the current ratio of the image by percentage.
Requires the
tooltipoption set totrue.
toggle()
Toggle the image size between its current size and natural size.
Used by the
toggleOnDblclickoption.
reset()
Reset the image to its initial state.
update([options])
Update the viewer instance when the source images changed (added, removed, or sorted), or update the options while the viewer is open.
If you load images dynamically (with XMLHTTPRequest), you can use this method to add the new images to the viewer instance.
viewer.update({
slideOnTouch: false,
});
destroy()
Destroy the viewer and remove the instance.
⬆ back to top
Static Methods
create(element[, options])
Create a new Viewer instance without using the new operator.
const viewer = Viewer.create(image, {
inline: true,
});
setDefaults(options)
Change the global default options for subsequently created Viewer instances. Instance options override these defaults.
Viewer.setDefaults({
inline: true,
});
noConflict
If you have to use another viewer with the same namespace, call the Viewer.noConflict static method to revert to it.
<script src="other-viewer.js"></script>
<script src="viewer.js"></script>
<script>
Viewer.noConflict();
// Code that uses other `Viewer` can follow here.
</script>
⬆ back to top
Events
All events can access the viewer instance with this.viewer in its handler.
Be careful to use these events with other components which have the same event names, e.g.: Bootstrap's modal.
let viewer;
image.addEventListener('viewed', function () {
console.log(this.viewer === viewer);
// > true
});
viewer = new Viewer(image);
ready
- event.bubbles:
true - event.cancelable:
true - event.detail:
null
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
- event.bubbles:
true - event.cancelable:
true - event.detail.originalEvent:
- Type:
Eventornull
- Type:
This event fires when the viewer modal starts to show.
Only available in modal mode.
shown
- event.bubbles:
true - event.cancelable:
true - event.detail: the same as the
showevent.
This event fires when the viewer modal has shown.
Only available in modal mode.
hide
- event.bubbles:
true - event.cancelable:
true - event.detail.originalEvent:
- Type:
Eventornull
- Type:
This event fires when the viewer modal starts to hide.
Only available in modal mode.
hidden
- event.bubbles:
true - event.cancelable:
false - event.detail: the same as the
hideevent.
This event fires when the viewer modal has hidden.
Only available in modal mode.
view
- event.bubbles:
true - event.cancelable:
true - 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:
- event.detail.originalImage:
- Type:
HTMLImageElement - The original image.
- Type:
- event.detail.originalEvent:
- Type:
Eventornull
- Type:
This event fires when a viewer starts to show (view) an image.
viewed
- event.bubbles:
true - event.cancelable:
false - event.detail: the same as the
viewevent.
This event fires when a viewer has shown (viewed) an image.
move
- event.bubbles:
true - event.cancelable:
true - event.detail.x:
- Type:
Number - The new position in the horizontal direction.
- Type:
- event.detail.y:
- Type:
Number - The new position in the vertical direction.
- Type:
- event.detail.oldX:
- Type:
Number - The old position in the horizontal direction.
- Type:
- event.detail.oldY:
- Type:
Number - The old position in the vertical direction.
- Type:
- event.detail.originalEvent:
- Type:
Eventornull - Options:
pointermove,touchmove, andmousemove.
- Type:
This event fires when a viewer starts to move an image.
moved
- event.bubbles:
true - event.cancelable:
false - event.detail: the same as the
moveevent.
This event fires when a viewer has moved an image.
rotate
- event.bubbles:
true - event.cancelable:
true - event.detail.degree:
- Type:
Number - The new rotation degrees.
- Type:
- event.detail.oldDegree:
- Type:
Number - The old rotation degrees.
- Type:
- event.detail.originalEvent:
- Type:
Eventornull
- Type:
This event fires when a viewer starts to rotate an image.
rotated
- event.bubbles:
true - event.cancelable:
false - event.detail: the same as the
rotateevent.
This event fires when a viewer has rotated an image.
scale
- event.bubbles:
true - event.cancelable:
true - event.detail.scaleX:
- Type:
Number - The new scaling factor in the horizontal direction.
- Type:
- event.detail.scaleY:
- Type:
Number - The new scaling factor in the vertical direction.
- Type:
- event.detail.oldScaleX:
- Type:
Number - The old scaling factor in the horizontal direction.
- Type:
- event.detail.oldScaleY:
- Type:
Number - The old scaling factor in the vertical direction.
- Type:
- event.detail.originalEvent:
- Type:
Eventornull
- Type:
This event fires when a viewer starts to scale an image.
scaled
- event.bubbles:
true - event.cancelable:
false - event.detail: the same as the
scaleevent.
This event fires when a viewer has scaled an image.
zoom
- event.bubbles:
true - event.cancelable:
true - event.detail.ratio:
- Type:
Number - The new (next) ratio of the image (
imageData.width / imageData.naturalWidth).
- Type:
- event.detail.oldRatio:
- Type:
Number - The old (current) ratio of the image.
- Type:
- event.detail.originalEvent:
- Type:
Eventornull - Options:
wheel,pointermove,touchmove, andmousemove.
- Type:
This event fires when a viewer starts to zoom (in or out) an image.
zoomed
- event.bubbles:
true - event.cancelable:
false - event.detail: the same as the
zoomevent.
This event fires when a viewer has zoomed (in or out) an image.
play
- event.bubbles:
true - event.cancelable:
true - event.detail.originalEvent:
- Type:
Eventornull
- Type:
This event fires when the viewer starts to play.
You can abort the playing process by calling
event.preventDefault().
playing
- event.bubbles:
true - event.cancelable:
true - 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:
- event.detail.originalImage:
- Type:
HTMLImageElement - The original image.
- Type:
- event.detail.originalEvent:
- Type:
Eventornull
- Type:
This event fires when a viewer starts to play (cycle) an image.
You can abort the cycling process by calling
event.preventDefault().
stop
- event.bubbles:
true - event.cancelable:
true - event.detail.originalEvent:
- Type:
Eventornull
- Type:
This event fires when the viewer starts to stop.
You can abort the stopping process by calling
event.preventDefault().
⬆ back to top
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.
License
MIT © Chen Fengyuan
⬆ back to top
Related repositories
Sharp is a Node-API module that wraps libvips, making it the practical choice when you need to process images in a Node.js environment without the overhead of a full ImageMagick installation. The README claims 4x-5x faster resizing compared to ImageMagick and GraphicsMagick, and it handles the tricky parts correctly: ICC colour profiles, alpha transparency, and auto-orientation all work without surprises. Beyond simple resizing, it covers rotation, extraction, compositing, and gamma correction — useful for building image pipelines that would otherwise require multiple tools stitched together. One concrete upside for local development: most macOS, Windows, and Linux machines need no extra system libraries to run it.
JavaScript image gallery for mobile and desktop, modular, framework independent
Immich is a self-hosted photo and video management app written mostly in TypeScript: a NestJS backend, a SvelteKit web client, and Flutter mobile apps. It backs up photos automatically from your phone, clusters faces, indexes content with CLIP embeddings for text search, and plots shots on a map — the feature set Google Photos users expect, running on a server you own instead of a vendor's cloud. It's licensed AGPL-3.0 and sits at 109,695 GitHub stars.
three.js (mrdoob/three.js) is an open-source JavaScript library for real-time 3D graphics in the browser, released under the MIT license. It renders through built-in WebGL and WebGPU renderers, with SVG and CSS3D renderers shipped as separate addons. It's the library behind the scene-graph API shown in its own README example: a camera, a geometry, a material, and a mesh composed into a scene and redrawn each frame through an animation loop.
Quick answers
How active is development on fengyuanchen/viewerjs?
The most recent commit recorded on fengyuanchen/viewerjs was 4 months ago, based on the GitHub push timestamp. The repository has 1.2k forks — one of the better signals of community interest.
How many stars does fengyuanchen/viewerjs have?
fengyuanchen/viewerjs has 8.2k GitHub stars — refresh the page for the live number, or check github.com/fengyuanchen/viewerjs. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What else is in the Image Tools space?
fengyuanchen/viewerjs is tracked by TopGit under the Image Tools category, alongside 4 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What language is fengyuanchen/viewerjs written in?
fengyuanchen/viewerjs is written primarily in JavaScript. GitHub's language field is based on the largest share of bytes in the default branch.
What topics is fengyuanchen/viewerjs associated with?
GitHub's repository topics for fengyuanchen/viewerjs: "image", "image-viewer", "javascript", "viewer". TopGit's editorial category is Image Tools.
Where do I read more about fengyuanchen/viewerjs?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/fengyuanchen/viewerjs is the definitive source.
Why is fengyuanchen/viewerjs categorized under Image Tools?
TopGit places fengyuanchen/viewerjs in the Image Tools category based on its GitHub topics and description (tagged: "image", "image-viewer", "javascript"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Want a second opinion on viewerjs?
Ask an AI that can read this page — one click and you get its take on viewerjs.