Текущая версия: 0.9
Popapilus это jQuery плагин для создания попапов: модальные окна, хинты и т.д.
Зависимости: jQuery >= 1.7.1. Протестировано также с 1.10.2, 2.0.3.
В отличии от большинства плагинов для создания модальных окон, popapilus создает свое окно и получает контент в качестве параметра метода show. Простейшее использование с параметрами по умолчанию:
popapilus = $.popapilus();
popapilus.show('<h1>Hello world!</h1>');
Использование: $.popapilus([options])
Описание: Создает Popapilus объект для последующей работы с ним.
Возвращаемое значение: Popapilus объект
Параметры:
options - хэш-объект, настройки отображения попапа. Включает в себя как настройки инициализации, которые потом не изменить для этого объекта, так и настроки, которые будут использоваться по умолчанию для настроек, задаваемых в параметре метода show().
-
css_class: string : CSS класс для блока попапа. Если в одном приложении несколько раз используете popapilus, то можно использовать данную опцию для того, чтобы задавать разные стили для разных окон с помощью css стилей. Значение по умолчанию:'popapilus'. -
no_overlay: boolean : Флаг, запрещающий создавать блок оверлея. Если эта опция будет включена, то для этого Popapilus объекта будет бесполезно пытаться открыть модальное окно. Значение по умолчанию:false. -
overlay_css_class: string : CSS класс для блока оверлея. Если в одном приложении несколько раз используете popapilus, то можно использовать данную опцию для того, чтобы задавать разные стили для разных оверлеев с помощью css стилей. Значение по умолчанию:'popapilus_overlay'. -
overlay_z_index: number : Значение css параметра z-index для оверлея. Значение по умолчанию:3998.
Не забывайте, что можно тут же, в параметре options задавать значения по умолчанию для всех открываемых этим Popapilus объектом, окон. Список параметров вы найдете ниже, в описании параметра show_options метода show.
Использование: popapulus.isVisible()
Описание: Возвращает true, если попап открыт.
Возвращаемое значение: булево
Использование: popapulus.hide()
Описание: Закрывает открытый попап.
Возвращаемое значение: ничего
Использование: popapulus.showOverlay()
Описание: Показывает только оверлей, без попапа, но только если в параметрах указана модальность.
Возвращаемое значение: ничего
Использование: popapulus.setData( data )
Описание: Добавляет содержание попапа.
Возвращаемое значение: ничего
Параметры:
data - HTML-строка или DOM элемент или массив jQuery.
Использование: popapulus.show([data][, show_options])
Описание: Открывает попап.
Возвращаемое значение: ничего
Параметры:
data - HTML-строка или DOM элемент или массив jQuery.
show_options - хэш-объект, настройки отображения попапа. Эти же опции можно задавать при инициализации объекта, они будут использованы в качестве опций по умолчанию для всех открываемых попап окон этим Popapilus объектом.
-
autoclose_time: number (in ms) : Время до автоматического закрытия попапа. Если 0, то попап не закрывается самостоятельно. Значение по умолчанию:0. -
bottom: string : Значение css параметра bottom для блока попапа. Нет смысла использовать, если если параметрыcenteredиfixedустановлены в true. Значение по умолчанию: null. -
centered: boolean : Флаг того, что открытое окно нужно располагать по центру. Горизонтальное центрирование работает всегда, а вертикальное только если значением опцииfixedустановлено true. Значение по умолчанию: true. -
close_on_overlay_click: boolean : Флаг, указывающий на то, что при клике на overlay будет закрыто окно попапа. Значение по умолчанию: true. -
fixed: boolean : Флаг указывает на то, какое позиционирование будет у окна попапа. Если значение опции true, то css свойство position попапа будет задано fixed, иначе absolute. Значение по умолчанию: true. -
height: string : Значение css параметра height для блока попапа. Если null - значение не устанавливается. Рекомендуется задавать это значение с помощью css стилей, если оно не менятся в ходе работы приложения. Значение по умолчанию: null. -
ignore_close_btn: boolean : По умолчанию, при клике на DOM элемент с CSS классомclose, находящимся внутри попапа, срабатывает функция hide(). Установка этого параметра в false отключает эту возможность. -
left: string : Значение css параметра left для блока попапа. Работает только если опция centered установлена в false. Если null - значение не устанавливается. Рекомендуется задавать это значение с помощью css стилей, если оно не менятся в ходе работы приложения. Значение по умолчанию: null. -
modal: boolean : Флаг, указывающий на то,будет ли окно открыто модально (с использование оверлея) или нет. Если при инициализации опция no_overlay была установлена в true, то модально окно не откроется в любом случае. Значение по умолчанию: true. -
overlay_show_animation_speed: number (in ms) : Время в миллисекундах исползуемое для длительности анимации появления оверлея при модальном открытии окна. Значение по умолчанию: 0. -
right: string : Значение css параметра right для блока попапа. Работает только если опция centered установлена в false. Если null - значение не устанавливается. Рекомендуется задавать это значение с помощью css стилей, если оно не менятся в ходе работы приложения. Значение по умолчанию: null. -
show_animation_speed: number : Время в миллисекундах исползуемое для длительности анимации появления блока попапа при модальном открытии окна. Значение по умолчанию: 0. -
top: string : Значение css параметра top для блока попапа. Нет смысла использовать, если если параметрыcenteredиfixedустановлены в true. Значение по умолчанию: null. -
width: string : Значение css параметра width для блока попапа. Если null - значение не устанавливается. Рекомендуется задавать это значение с помощью css стилей, если оно не менятся в ходе работы приложения. Значение по умолчанию: null. -
z_index: number : Значение css параметра z-index для блока попапа. Значение по умолчанию:3999.
Пишите мне, не стесняйтесь на [email protected] если будут вопросы или предложения. Ну и не забывайте что об ошибках можно писать в раздел Issues.