API библиотеки UIkit

Библиотека представляет собой дополнительный класс для общего хелпера HTML Joomla! и является независимым самостоятельным обновляемым расширением.

Использование функций состоит в стандартном вызове HTMLHelper с передачей ему имени функции библиотеки в пространстве имён uikit3. и ряда дополнительных опциональных параметров.


# Подключение базовых файлов фреймворка UIkit.

framework($icons = true, $css = true, $rtl = false, $min = true): void

Независимо от параметров всегда подключает основной файл скриптов UIkit.

Входные параметры:
(bool) $icons – подключать (true) или не подключать (false) файл иконок UIkit, true по умолчанию
(bool) $css – подключать (true) или не подключать (false) файл стилей UIkit, true по умолчанию
(bool) $rtl – подключать RTL-версию (true) или LTR-версию (false) файла стилей UIkit, false по умолчанию
(bool) $min – подключать минифицированные (true) или несжатые (false) версии подключаемых файлов UIkit (параметр влияет на все подключаемые файлы), true по умолчанию

Пример использования (с параметрами по умолчанию):

\Joomla\CMS\HTML\HTMLHelper::_('uikit3.framework', true, true, false, true);

# Подключение файла основного скрипта фреймворка UIkit.

js($min = true): void

Входные параметры:
(bool) $min – подключать минифицированную (true) или несжатую (false) версию файла, true по умолчанию

Пример использования (с параметрами по умолчанию):

\Joomla\CMS\HTML\HTMLHelper::_('uikit3.js', true);

# Подключение файла иконок фреймворка UIkit.

icons($min = true): void

Входные параметры:
(bool) $min – подключать минифицированную (true) или несжатую (false) версию файла, true по умолчанию

Пример использования (с параметрами по умолчанию):

\Joomla\CMS\HTML\HTMLHelper::_('uikit3.icons', true);

# Подключение файла стилей фреймворка UIkit.

css($rtl = false, $min = true): void

Входные параметры:
(bool) $rtl – подключать RTL-версию (true) или LTR-версию (false) файла стилей UIkit, false по умолчанию
(bool) $min – подключать минифицированную (true) или несжатую (false) версию файла, true по умолчанию

Пример использования (с параметрами по умолчанию):

\Joomla\CMS\HTML\HTMLHelper::_('uikit3.css', false, true);