/modal

A modal element with a transparent overlay

Primary LanguageJavaScript

Overview

A modal is a UI component that pops up when specified, covering its parent element until it is dismissed.

Usage

Default modal, initializing as visible and dismissable by clicking outside the modal:

<x-modal>
	Place content markup here
</x-modal>

Modal that darkens the parent element that it is covering when visible:

<x-modal overlay>
	Place content markup here
</x-modal>

Modal that initializes as hidden:

<x-modal hidden>
	Place content markup here
</x-modal>

Modal that allows pressing the ESC key to dismiss itself:

<x-modal hide-triggers="esc">
	Place content markup here
</x-modal>

Modal that is dismissed when the user clicks on the overlay that surrounds the modal:

<x-modal hide-triggers="tap">
	Place content markup here
</x-modal>

Methods

hide

Dismisses the modal popup.

show

Dismisses the modal popup.

toggle

Alternates the visibility status of the modal popups.

Events

reveal

When a x-modal element receives the reveal event, it will show the modal.

Create X-Tag Components

Guide for creating X-Tag Components

Use X-Tag Components

Using X-Tag components in your applications