API UIkit library

The library is an additional class for the common HTML helper Joomla! and is an independent standalone extension.

The use of functions consists of a standard call to HTMLHelper with the transfer of the name of the library function to it in the uikit3. namespace and a number of additional optional parameters.


# Connecting basic UIkit framework files.

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

Regardless of the settings, it always includes the main UIkit script file.

Input parameters:
(bool) $icons – enable (true) or not (false) UIkit icon file, default true
(bool) $css – enable (true) or not (false) UIkit stylesheet, default true
(bool) $rtl – connect the RTL version (true) or the LTR version (false) of the UIkit stylesheet, default false
(bool) $min – connect minified (true) or uncompressed (false) versions of connected UIkit files (the parameter affects all connected files), default true

Usage example (with default settings):

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

# Connecting the UIkit framework script main file.

js($min = true): void

Input parameters:
(bool) $min – connect minified (true) or uncompressed (false) version of the file, default true

Usage example (with default settings):

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

# Connecting the UIkit Framework Icon File.

icons($min = true): void

Input parameters:
(bool) $min – connect minified (true) or uncompressed (false) version of the file, default true

Usage example (with default settings):

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

# Connecting the UIkit Framework Style File.

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

Input parameters:
(bool) $rtl – connect the RTL version (true) or the LTR version (false) of the UIkit stylesheet, default false
(bool) $min – connect minified (true) or uncompressed (false) version of the file, default true

Usage example (with default settings):

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