Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class Bootstrap - list of methods

Utility class for Bootstrap elements.
Package: Joomla\CMS\HTML\Helpers
Copyright: (C) 2012 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/HTML/Helpers/Bootstrap.php
Project: Joomla

Method Summary

public static void
(mixed $selector = '')

Add javascript support for Bootstrap alerts
Parameters
  • string $selector Common class for the alerts
Returns
  • void
Since
  • 3.0
-
  • \Exception
Show source code of this method: alert Source Code

public static void
(mixed $selector = '')

Add javascript support for Bootstrap buttons
Parameters
  • string $selector Common class for the buttons
Returns
  • void
Since
  • 3.1
-
  • \Exception
Show source code of this method: button Source Code

public static void
(mixed $selector = '', mixed $params = [])

Add javascript support for Bootstrap carousels
Parameters
  • string $selector Common class for the carousels.
  • array $params An array of options for the carousel.
Returns
  • void
Since
  • 3.0
-
  • \Exception
Show source code of this method: carousel Source Code

public static void
(mixed $selector = '', mixed $params = [])

Add javascript support for Bootstrap collapse
Parameters
  • string $selector Common class for the collapse
  • string[] $params Additional parameters - see below
Returns
  • void
Since
  • 4.0.0
-
  • \Exception
Show source code of this method: collapse Source Code

public static void
(mixed $selector = '', mixed $params = [])

Add javascript support for Bootstrap dropdowns
Parameters
  • string $selector Common class for the dropdowns
  • array $params The options for the dropdowns
Returns
  • void
Since
  • 4.0.0
Show source code of this method: dropdown Source Code

public static void
(mixed $selector = '', mixed $options = [])

Add javascript support for Bootstrap modal
Parameters
  • string $selector The ID selector for the modal.
  • array $options An array of options for the modal.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: modal Source Code

public static void
(mixed $selector = '', mixed $options = [])

Add javascript support for Bootstrap offcanvas
Parameters
  • string $selector The ID selector for the offcanvas.
  • array $options An array of options for the offcanvas.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: offcanvas Source Code

public static void
(mixed $selector = '', mixed $options = [])

Add javascript support for Bootstrap popovers
Parameters
  • string $selector Selector for the popover
  • array $options The options for the popover
Returns
  • void
Since
  • 3.0
Show source code of this method: popover Source Code

public static void
(mixed $selector = '', mixed $options = [])

Add javascript support for Bootstrap Scrollspy
Parameters
  • string $selector The ID selector for the ScrollSpy element.
  • array $options An array of options for the ScrollSpy.
Returns
  • void
Since
  • 3.0
Show source code of this method: scrollspy Source Code

public static void
(mixed $selector = '', mixed $options = [])

Add javascript support for Bootstrap tab
Parameters
  • string $selector Common class for the tabs
  • array $options Options for the tabs
Returns
  • void
Since
  • 4.0.0
-
  • \Exception
Show source code of this method: tab Source Code

public static void
(mixed $selector = '', mixed $options = [])

Add javascript support for Bootstrap tooltips
Parameters
  • string $selector The ID selector for the tooltip.
  • array $options An array of options for the tooltip.
Returns
  • void
Since
  • 3.0
Show source code of this method: tooltip Source Code

public static void
(mixed $selector = '', mixed $options = [])

Add javascript support for Bootstrap toasts
Parameters
  • string $selector Common class for the toasts
  • array $options Options for the toasts
Returns
  • void
Since
  • 4.0.0
-
  • \Exception
Show source code of this method: toast Source Code

public static void
(mixed $debug = null)

Method to load the ALL the Bootstrap Components
Parameters
  • mixed $debug Is debugging mode on? [optional]
Returns
  • void
Since
  • 3.0
Deprecated
  • 5.0
Show source code of this method: framework Source Code

public static void
(mixed $includeMainCss = true, mixed $direction = 'ltr', mixed $attribs = [])

Loads CSS files needed by Bootstrap
Parameters
  • bool $includeMainCss If true, main bootstrap.css files are loaded
  • string $direction rtl or ltr direction. If empty, ltr is assumed
  • array $attribs Optional array of attributes to be passed to HTMLHelper::_('stylesheet')
Returns
  • void
Since
  • 3.0
Show source code of this method: loadCss Source Code

public static string
(mixed $selector = 'myAccordian', mixed $options = [])

Add javascript support for Bootstrap accordions and insert the accordion
Parameters
  • string $selector The ID selector for the tooltip. Expects a valid ID without the #!
  • array $options An array of options for the tooltip.
Returns
  • string HTML for the accordion
Since
  • 3.0
Show source code of this method: startAccordion Source Code

public static string
()

Close the current accordion
Returns
  • string HTML to close the accordion
Since
  • 3.0
Show source code of this method: endAccordion Source Code

public static string
(mixed $selector, mixed $text, mixed $id, mixed $class = '')

Begins the display of a new accordion slide.
Parameters
  • string $selector Identifier of the accordion group.
  • string $text Text to display.
  • string $id Identifier of the slide.
  • string $class Class of the accordion group.
Returns
  • string HTML to add the slide
Since
  • 3.0
Show source code of this method: addSlide Source Code

public static string
()

Close the current slide
Returns
  • string HTML to close the slide
Since
  • 3.0
Show source code of this method: endSlide Source Code

public static string
(mixed $selector = 'modal', mixed $options = [], mixed $body = '')

Method to render a Bootstrap modal
Parameters
  • string $selector The ID selector for the modal. Expects a valid ID without the #!
  • array $options An array of options for the modal.
  • string $body Markup for the modal body. Appended after the `<iframe>` if the URL option is set
Returns
  • string HTML markup for a modal
Since
  • 3.0
Show source code of this method: renderModal Source Code

public static string
(mixed $selector = 'myTab', mixed $params = [])

Creates a tab pane
Parameters
  • string $selector The pane identifier. Expects a valid ID without the #!
  • array $params The parameters for the pane
Returns
  • string
Since
  • 3.1
Show source code of this method: startTabSet Source Code

public static string
()

Close the current tab pane
Returns
  • string HTML to close the pane
Since
  • 3.1
Show source code of this method: endTabSet Source Code

public static string
(mixed $selector, mixed $id, mixed $title)

Begins the display of a new tab content panel.
Parameters
  • string $selector Identifier of the panel. Expects a valid ID without the #!
  • string $id The ID of the div element. Expects a valid ID without the #!
  • string $title The title text for the new UL tab
Returns
  • string HTML to start a new panel
Since
  • 3.1
Show source code of this method: addTab Source Code

public static string
()

Close the current tab content panel
Returns
  • string HTML to close the pane
Since
  • 3.1
Show source code of this method: endTab Source Code

Properties Summary

protected static array
$loaded
Since
  • 3.0

Tags Summary

Since
3.0