AdminThemeUikit class

Settings specific to default theme

AdminThemeUikit

Hookable methods

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the AdminThemeUikit class also inherits all the methods and properties of: AdminThemeFramework, AdminTheme, WireData and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
AdminThemeUikit::getHeadJS()
string

Get Javascript that must be present in the document <head>

 
string

Get the URL to the ProcessWire or brand logo (or <img> tag)

 
AdminThemeUikit::getLogoURL()
string

Get the URL to the ProcessWire or brand logo

 
AdminThemeUikit::getThemeInfo()
array

Get info for theme style

 
AdminThemeUikit::getUikitCSS()
string

Get the primary Uikit CSS URL to use

AdminThemeUikit::path()
string

Get disk path to this admin theme

 
AdminThemeUikit::renderAddNewButton()
string

Render the populated “Add New” head button, or blank when not applicable

 
AdminThemeUikit::renderBreadcrumbs()
string

Render a list of breadcrumbs (list items), excluding the containing <ul>

AdminThemeUikit::renderExtraMarkup(string $for)
mixed string

Render an extra markup region

 
AdminThemeUikit::renderNotices($notices)
string array

Render runtime notices div#notices

 
AdminThemeUikit::renderPrimaryNavItems()
string

Render all top navigation items, ready to populate in ul#prnav

 
AdminThemeUikit::renderQuickTreeLink()
string

Render link that opens the quick page-tree panel

 
AdminThemeUikit::renderSidebarNavItems()
string

Render sidebar navigation that uses uk-nav

 
AdminThemeUikit::renderUserNavItems()
string

Render navigation for the “user” menu

 
AdminThemeUikit::renderUserNavLabel()
string

Render label for user masthead dropdown nav item

 
AdminThemeUikit::testNotices()
bool

Test all notice types

 
AdminThemeUikit::testUikit()
None

Test all Uikit v3 features using current admin CSS

 
AdminThemeUikit::url()
string

Get URL to this admin theme

 
AdminThemeUikit::wired()
None 

Properties

NameReturnSummary 
AdminThemeUikit::cardTypes array Inputfield class names that should always use the card option. 
AdminThemeUikit::configPhpHash string Hash used internally to detect changes to $config->AdminThemeUikit settings. 
AdminThemeUikit::cssURL string URL to custom CSS file, relative to PW installation root.  
AdminThemeUikit::cssVersion int Current version number of core CSS/LESS files 
AdminThemeUikit::defaultCustomCss string Custom CSS rules string
DEFAULT: ''		 
AdminThemeUikit::defaultCustomCssFile string URL to custom CSS file, relative to installation root
DEFAULT: ''		 
AdminThemeUikit::defaultMainColor string Main color or 'custom'
DEFAULT: 'red'		 
AdminThemeUikit::defaultMainColorCustom string Main custom color hex code when defaultMainColor=custom
DEFAULT: '#eb1d61'		 
AdminThemeUikit::defaultMainColorCustomDark string Same as above but when used, applies only to dark mode.  
AdminThemeUikit::defaultStyleName string Style name, one of 'dark', 'light' or 'auto'
DEFAULT: 'auto'		 
AdminThemeUikit::defaultToggles array Toggles for specific behaviors
DEFAULT: []		 
AdminThemeUikit::groupNotices bool int Whether or not notices should be grouped by type 
AdminThemeUikit::inputSize string Size for input/select elements. One of "s" for small, "m" for medium (default), or "l" for large.  
AdminThemeUikit::isEditor bool Does current user have page-edit permission? 
AdminThemeUikit::isLoggedIn bool Is current user logged in? 
AdminThemeUikit::isSuperuser bool Is current user a superuser? 
AdminThemeUikit::layout string Layout type (blank=default, sidenav=multi-pane, sidenav-tree=left-tree, sidenav-tree-alt=right-tree) 
AdminThemeUikit::logoAction int Logo click action (0=admin root page list, 1=offcanvas nav) 
AdminThemeUikit::logoURL string URL to custom logo, relative to PW installation root.  
AdminThemeUikit::maxWidth int Maximum layout width in pixels, or 0 for no max .
DEFAULT: 1600		 
AdminThemeUikit::noBorderTypes array Inputfield class names that should always use the noBorder option (when 100% width). 
AdminThemeUikit::offsetTypes array Inputfield class names that should always use the offset option. 
AdminThemeUikit::themeInfos array where theme style files are located 
AdminThemeUikit::themeName string One of blank (original) or name of theme style 
AdminThemeUikit::toggleBehavior int (0=Standard, 1=Consistent) 
AdminThemeUikit::ukGrid bool int When true, use uk-width classes for Inputfields (rather than CSS percentages).  
AdminThemeUikit::useOffset bool Use offset/margin for all Inputfields? 
AdminThemeUikit::userLabel string Text containing user {vars} to use for user label in masthead
DEFAULT: "{Name}"		 

Additional methods and properties

In addition to the methods and properties above, AdminThemeUikit also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.253