h1. What's this?

A plugin that allows you to create modal windows on the fly. You can put text, forms, images, iframes or any other HTML element in it. It can be made to make a rest of the screen inactive or just be placed like a normal window.

h2. Installation/Usage

modal-window-prototype includes Prototype Javascript framework. New versions can be obtained from the links provided below.

To use include all the files @lib@ folder and the @src@ folder.

To load @modal.js@, add the following to the HEAD of your page or optionally to the end of the BODY to increase efficiency and loading time -

To create a new modal window you'll need to create an instance of the class and pass the element to the @show()@ method to display it in the modal window.

The boolean value passed to the function is to show the overlay that'll hide the rest of the window. Set it to false to make the window appear normally.

h2. The Distribution

All the files related to modal-window-prototype are in the @src@ folder. The files that its dependent on is in the @lib@ folder.

To get started and see the basic usage see the test folder. It has examples and usage of the different options provided by modal-window-prototype.

h2. License

Modal Window for Prototype, "modal-window-prototype" is licensed under the terms of the MIT license.

h2. Dependencies