Modal window/popup which main purpose is to open as image galery. But it can handle also other type of content like Youtube, Vimeo or HTML5 videos, iframes, custom HTML content or HTML content from some existing element on the page. It can recognize type of media from the source url. If it is not possible to recognize media type, default type is iframe. You can force media type by medium parameter (see examples below).
Using npm
$ npm install @superkoders/modal
Using yarn
$ yarn add @superkoders/modal
There are two methods exported: initModal and createModal. First one adds click listeners to each element in given context which matches modalSelector option (by default '[data-modal]'). It returns array of modal instances created. Second one is for creating custom modal instance.
import { initModal } from '@superkoders/modal';
// use default options
initModal();
// or set some custom options
initModal({
customWrapperClass: 'my-custom-modal',
closeOnBgClick: true,
});
The easiest way is to do it with an a tag using its href attribute as an url for modal.
<a href="https://www.youtube.com/watch?v=RhMYBfF7-hE" data-modal>Open Youtube video in the modal</a>
If you want to use some other element like button, you need to specify url in the data-modal attribute.
<button data-modal='{"url": "https://www.youtube.com/watch?v=RhMYBfF7-hE"}'>Open Youtube video in the modal</button>
In this case, there are no triggers which open modal. Once you create an instance, you need to open it by yourself. Also you need to pass modal items, where only mandatory property is url. In our example below the modal will have two items, first is some image, second is some video.
import { createModal } from '@superkoders/modal';
const items = [
{
url: 'url/to/some/image.jpg'
},
{
url: 'url/to/some/video.mp4'
}
]
// create instance
const customModal = createModal(items, {
customWrapperClass: 'my-custom-modal',
closeOnBgClick: true,
});
// open modal
customModal.methods.open();
// go to next slide
customModal.methods.next();
// close modal
customModal.methods.close();
These options you can adjust during initialization.
Context element, in which to search for modal items (triggers)
Default value: document
Element, which is used as a parent for modal element in DOM
Default value: document.body
Element selector, which is used for modal triggers
Default value: '[data-modal]'
Element selector, which is used to close the modal
Default value: '.js-modal-close'
Custom CSS class, which is added to the modal element
Default value: undefined
It determines if modal items are shown in a loop
Default value: false
It determines if modal will close after background click
Default value: undefined
Plugins array to initialize
Default value: undefined
It determines if the navigation (arrows, bullets) is hidden or not
Default value: undefined
Any data which you can use for example in plugins
Default value: undefined
String which represents an icon for close button, it can be also HTML code
Default value: '×'
String which represents an icon for previous button, it can be also HTML code
Default value: '←'
String which represents an icon for next button, it can be also HTML code
Default value: '→'
String which represents an icon for loader, it can be also HTML code
Default value: '<span class="b-modal__loader-icon"><span>↺</span></span>'
It determines if modal element will be removed from DOM after close
Default value: false
Enables or disables focus trap.
Default value: true
Focus trap custom options. See Focus trap package page for more info Default value:
{
allowOutsideClick: true,
}
Enables or disables swipe slide change on touch devices.
Default value: true
Modal title for assistive technologies.
Default value: undefined
Method which builds the modal HTML structure, not really necessary to change if you use grid for CSS
Default value:
(modal, {
ariaLabel,
header,
titleElem,
descElem,
content,
prevElem,
nextElem,
navElem,
loader,
bg,
}) => {
const wrapper = document.createElement('div');
wrapper.classList.add('b-modal__wrapper');
if (ariaLabel) {
modal.setAttribute('aria-labelledby', ariaLabel.id);
modal.appendChild(ariaLabel);
}
wrapper.appendChild(header);
wrapper.appendChild(titleElem);
wrapper.appendChild(descElem);
wrapper.appendChild(content);
wrapper.appendChild(prevElem);
wrapper.appendChild(nextElem);
wrapper.appendChild(navElem);
modal.appendChild(wrapper);
modal.appendChild(loader);
modal.appendChild(bg);
}
Method for header template
Default value:
(options) => `
<button type="button" class="b-modal__close ${ModalClasses.CLOSE}">
<span class="b-modal__close-text u-vhide">Close</span>
${options.closeIcon}
</button>
`
Method for title template
Default value:
(text: string) => `<h3>${text}</h3>`
Method for description template
Default value:
(text: string) => `<p>${text}<p>`
Method for previous button template
Default value:
(options) => `<button type="button" class="b-modal__prev-btn ${ModalClasses.PREV_TRIGGER}">${options.prevIcon}</button>`
Method for next button template
Default value:
(options) => `<button type="button" class="b-modal__next-btn ${ModalClasses.NEXT_TRIGGER}">${options.nextIcon}</button>`
Method for navigation (bullets) template
Default value:
(items) =>
items
.map((_item, index) => `<span class="b-modal__nav-item ${ModalClasses.NAV_TRIGGER}" data-modal-index="${index}"></span>`)
.join('')
Method for loader template
Default value:
(options) => `<span class="b-modal__loader-icon"><span>${options.loadIcon}</span></span>`
Method which is used for loading images
Default value:
(src) => {
return new Promise((resolve, reject) => {
let img = new Image();
img.addEventListener('load', () => resolve(img));
img.addEventListener('error', () => {
reject(new Error(`Failed to load image with src: ${src}`));
});
img.draggable = false;
img.src = src;
});
}
Method which is used for fetching content from a server
Default value:
async (url) => await fetch(url).then((response) => response.text())
Handler, which runs after modal is opened
Default value: undefined
Handler, which runs after modal is closed
Default value: undefined
Handler, which runs after modal content is loaded
Default value: undefined
Handler, which runs after modal slide has changed
Default value: undefined
All these parameters is possible to add to data-modal attribute. In case of createModal, these are properties of the modal item object.
Media url. In case of images, it can be an array. Then more images are shown on one slide.
Media type. Posible values in ModalMedium enum exported from @superkoders/modal
Text, which will appear in modal title
Text, which will appear in modal description
Gallery key, which is used for grouping items into one modal. If it is undefined, each modal uses its own popup.
CSS class which will be aplied for modal wrapper element, when modal is opened.
It is possible to add more custom parameters, which can be used in plugins for example.
Plugins enable another modal customization. It has these three parameters:
Init method
Destroy method, it runs after modal redraw (if reInitOnRedraw is set to true) or after modal destroy
It determines, if plugin should be reinitialized after modal redraw.
my-plugin.js
export const myPlugin = {
init: (modal) => {
// do some stuff like add event listeners or add some elements to DOM
},
destroy: (modal) => {
// use when you need to remove some listeners or remove some elements from DOM
},
reInitOnRedraw: true,
}
modal.js
import { initModal } from '@superkoders/modal';
import { myPlugin } from './my-plugin.js';
initModal({
plugins: [myPlugin]
});
- The wrapper element is now a
dialogelement. It has better accessibility. You can check browser support here. If you need to support browser wich don't supportdialogelement, you can use older version (1.7.0). -
scroll-locknpm package has been removed. We prefer to use CSS pure solution. It can be done by addingscrollbar-gutter: stableonhtmlelement andoverflow: clipon body element. For this purpose, classis-modal-openis added tobodywhen dialog is opened. If you prefer to usescroll-lock, you can use older version (1.7.0) - The
dialogelement comes with its own focus trap functionality. This however did not meet our requirements, so we are still usingfocus-trapnpm package for this. If you prefer to use nativedialogfocus trap functionality, you can disable focus trap withenableFocusTrapoption (set it tofalse).
@superkoders/modal uses some functionality from @superkoders/sk-tools. If you are already using @superkoders/sk-tools on your project, check if the version is at least 1.4.0. If not, you need to update the package.