Skip to content

TerjeUrnes/ImageViewer-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simple fullscreen image viewer.
In pure vanilla JavaScript with no dependencies.
It finds the images on the page. Ether all images or only those that is marked.

v1.0.0

Image Viewer JS

Screenshot

How to use

Just include the file imageviewer.js and make a instance of the class ImageViewer. And include the icons folder or use your own icons, see under customization possibilities.

new ImageViewer();

The instance have to be created after the page is finish loading.

Image Scraping: All images

The default is to collect tagged images. To collect all set SELECT_ALL_IMAGES to true.

new ImageViewer({
    "select_all_images": "true"
})

Image Scraping: Marked images

A image is marked if the image element has a mark or if a parent element is marked. To mark is to ether add an attribute or a class. Default attribute is data-gallery and default class is gallery.

<div class="img-styling" data-gallery>
    <img src="mother-and-child.jpg">
    <img src="father-and-child.jpg">
</div>
<div class="img-styling">
    <img src="mother-and-child.jpg" class="gallery">
    <img src="father-and-child.jpg" data-gallery>
</div>

To change the marks change the GALLERY_MARK_ATTRIBUTE or / and GALLERY_MARK_CLASS.

new ImageViewer({
    "gallery_mark_attribute": "data-flowerimages",
    "gallery_mark_class": "images"
})

Customization possibilities

Description Key Default Other
Background color and alpha BACKGROUND_COLOR "#0009"
Background blur BACKGROUND_BLUR "15px"
Frame size IMAGE_MARGIN "2em 3em"
Arrows for moving between images NAVIGATION_CONTROLS "visible" "hidden"
Icon Key Path
Left arrow LEFT_NAVIGATION_ARROW "icons/caret-left-solid.svg"
Right arrow RIGHT_NAVIGATION_ARROW "icons/caret-right-solid.svg"
new ImageViewer({
    "background_color": "hotpink",
    "image_margin": "0",
    "left_navigation_arrow": "previous-button.png",
    "right_navigation_arrow": "next-button.png"
})