wtc-modal-view 2.0.0

A simple, unopinionated modal class.

src/wtc-modal-view.js

new Modal()

A Modal class which can display programatically-generated content, or pull in content from an existing DOM node.

Examples

const myModal = new Modal();
const triggerButton = document.querySelector('trigger');

myModal.optionalClass = "modal--myModal";
myModal.content = '<p>Some sample content!</p>';
myModal.focusOnClose = triggerButton;

triggerButton.addEventListener('click', () => {
  myModal.open();
});

Returns

• Void

Modal.close()

Closes modal, removes content and optional class, and shifts user focus back to triggering element, if specified.

Returns

• Void

open()

Opens modal, adds content and optional CSS class

Returns

• Void

focusFirstElement()

Shifts focus to the first element inside the content

Returns

• Void

focusLastElement()

Shifts focus to the last element inside the content

Returns

• Void

focusOnClose()

Gets the element that will be focused when the modal closes

Returns

• HTMLElement

focusOnClose(element)

Sets the element that will be focused when the modal closes

Parameters

Returns

• Void

onOpen()

Gets the function that is called when the modal opens

Returns

• Function

onOpen(callback)

Sets the function that is called when the modal opens

Parameters

Returns

• Void

onClose()

Get the function that is called when the modal closes

Returns

• Function

onClose(callback)

Sets the function that is called when the modal closes

Parameters

Returns

• Void

optionalClass(className)

Sets an optional class name on the modal for custom styling

Parameters

Returns

• Void

optionalClass(optionalClass)

Gets the optional class name

Parameters

Returns

• Void

closeButtonContent(content)

Sets the content of the close button, useful for localizing

Parameters

Returns

• Void

content(content)

Sets the content of the modal

Parameters

Returns

• Void

Documentation generated with doxdox.