Разработка:modlibs/jquery — различия между версиями
Ilya (обсуждение | вклад) (Описан плагин jquery) |
Ilya (обсуждение | вклад) (→API) |
||
(не показана 1 промежуточная версия этого же участника) | |||
Строка 8: | Строка 8: | ||
Плагин содержит в себе папку lib, которая содержит в себе папки "js" и "css". | Плагин содержит в себе папку lib, которая содержит в себе папки "js" и "css". | ||
− | Папка js содержит в себе ядро и UI-виджеты, а также дополнительные плагины (если они понадобятся). Скрипты библиотеки представлены в двух вариантах: обычные (для откадки) и сжатые (для использования в рабочей системе). Какие именно файлы подключать (для разработки или для работы системы) | + | Папка js содержит в себе ядро и UI-виджеты, а также дополнительные плагины (если они понадобятся). Скрипты библиотеки представлены в двух вариантах: обычные (для откадки) и сжатые (для использования в рабочей системе). Какие именно файлы подключать (для разработки или для работы системы) указывается в настройках плагина |
Папка css содержит в себе парки с темами оформления jquery. Текущая тема задается в настройках плагина. | Папка css содержит в себе парки с темами оформления jquery. Текущая тема задается в настройках плагина. | ||
+ | |||
+ | == Плагины == | ||
+ | Все плагины, которые подключаются к jquery должны находится в папке '''modlibs/jquery/plugins/название_плагина/'''. | ||
+ | Названием плагина в данном случае является собственное внутреннее имя плагина внутри системы. Плагин может содержать в себе js и css-файлы. Каждый плагин активируется при помощи функции jquery_plugin_init() | ||
+ | |||
= API = | = API = | ||
Строка 21: | Строка 26: | ||
=== jquery_init() === | === jquery_init() === | ||
Обратиться к плагину nvg и подключить все необходимые js-файлы и текущую тему. Файлы должны подключаться независимо от имени, чтобы при обновлении библиотеки не приходилось ничего менять в php-коде. | Обратиться к плагину nvg и подключить все необходимые js-файлы и текущую тему. Файлы должны подключаться независимо от имени, чтобы при обновлении библиотеки не приходилось ничего менять в php-коде. | ||
+ | |||
+ | === jquery_plugin_init() === | ||
+ | Подключить плагин jquery. Функция обращается к плагину nvg и подключает все нужные js и css файлы. | ||
+ | |||
+ | Параметры: | ||
+ | * $name - имя плагина jquery | ||
= Обновление = | = Обновление = |
Текущая версия на 17:04, 21 октября 2011
Плагин | |
Название | nvg |
Тип | modlibs |
Содержание
Описание
Эта modlib-библиотека создана как обертка для подключения библиотеки jquery.
Структура папок
Плагин содержит в себе папку lib, которая содержит в себе папки "js" и "css".
Папка js содержит в себе ядро и UI-виджеты, а также дополнительные плагины (если они понадобятся). Скрипты библиотеки представлены в двух вариантах: обычные (для откадки) и сжатые (для использования в рабочей системе). Какие именно файлы подключать (для разработки или для работы системы) указывается в настройках плагина
Папка css содержит в себе парки с темами оформления jquery. Текущая тема задается в настройках плагина.
Плагины
Все плагины, которые подключаются к jquery должны находится в папке modlibs/jquery/plugins/название_плагина/. Названием плагина в данном случае является собственное внутреннее имя плагина внутри системы. Плагин может содержать в себе js и css-файлы. Каждый плагин активируется при помощи функции jquery_plugin_init()
API
jquery_version()
Версия jquery, которая находится в плагине.
jquery_ui_version()
Версия UI которая находится в плагине.
jquery_init()
Обратиться к плагину nvg и подключить все необходимые js-файлы и текущую тему. Файлы должны подключаться независимо от имени, чтобы при обновлении библиотеки не приходилось ничего менять в php-коде.
jquery_plugin_init()
Подключить плагин jquery. Функция обращается к плагину nvg и подключает все нужные js и css файлы.
Параметры:
- $name - имя плагина jquery
Обновление
Для того чтобы обновить библиотеку - нужно просто заменить старые версии скриптов и стилей новыми. При обновлении UI и плагинов нужно проследить, чтобы
- Версия UI была совместима с версией ядра
- Версии плагинов совместимы с версией ядра
- Версия темы оформления совместима с версией UI