Joomla! API

Download
Launch

Bootstrap

Utility class for Bootstrap elements.

abstract
since

3.0
package

Joomla CMS

Methods

addSlide

Begins the display of a new accordion slide.

addSlide( selector,  text,  id,  class = '') :
static
since

3.0

Arguments

selector

stringIdentifier of the accordion group.

text

stringText to display.

id

stringIdentifier of the slide.

class

stringClass of the accordion group.

Response

stringHTML to add the slide

addTab

Begins the display of a new tab content panel.

addTab( selector,  id,  title) :
static
since

3.1

Arguments

selector

stringIdentifier of the panel. Expects a valid ID without the #!

id

stringThe ID of the div element. Expects a valid ID without the #!

title

stringThe title text for the new UL tab

Response

stringHTML to start a new panel

alert

Add javascript support for Bootstrap alerts

alert( selector = '') :
static
throws

Exception
since

3.0

Arguments

selector

stringCommon class for the alerts

Response

void

button

Add javascript support for Bootstrap buttons

button( selector = '') :
static
throws

Exception
since

3.1

Arguments

selector

stringCommon class for the buttons

Response

void

carousel

Add javascript support for Bootstrap carousels

carousel( selector = '', mixed||string|int params = []) :
static
throws

Exception
since

3.0

Arguments

selector

stringCommon class for the carousels.

params

array<string|int, mixed>An array of options for the carousel.

Response

void

collapse

Add javascript support for Bootstrap collapse

collapse( selector = '', string||string|int params = []) :
static
throws

Exception
since

4.0.0

Arguments

selector

stringCommon class for the collapse

params

array<string|int, string>Additional parameters - see below

Response

void

dropdown

Add javascript support for Bootstrap dropdowns

dropdown( selector = '', mixed||string|int params = []) :
static
since

4.0.0

Arguments

selector

stringCommon class for the dropdowns

params

array<string|int, mixed>The options for the dropdowns

Response

void

endAccordion

Close the current accordion

endAccordion() :
static
since

3.0

Response

stringHTML to close the accordion

endSlide

Close the current slide

endSlide() :
static
since

3.0

Response

stringHTML to close the slide

endTab

Close the current tab content panel

endTab() :
static
since

3.1

Response

stringHTML to close the pane

endTabSet

Close the current tab pane

endTabSet() :
static
since

3.1

Response

stringHTML to close the pane

framework

Method to load the ALL the Bootstrap Components

framework( debug = null) :
static deprecated

If debugging mode is on an uncompressed version of Bootstrap is included for easier debugging.

since

3.0
deprecated

4.0 will be removed in 6.0 Will be removed without replacement Load the different scripts with their individual method calls

Arguments

debug

mixedIs debugging mode on? [optional]

Response

void

loadCss

Loads CSS files needed by Bootstrap

loadCss( includeMainCss = true,  direction = 'ltr', mixed||string|int attribs = []) :
static
since

3.0

Arguments

includeMainCss

boolIf true, main bootstrap.css files are loaded

direction

stringrtl or ltr direction. If empty, ltr is assumed

attribs

array<string|int, mixed>Optional array of attributes to be passed to HTMLHelper::_('stylesheet')

Response

void

modal

Add javascript support for Bootstrap modal

modal( selector = '', mixed||string|int options = []) :
static
since

4.0.0

Arguments

selector

stringThe ID selector for the modal.

options

array<string|int, mixed>An array of options for the modal.

Response

void

offcanvas

Add javascript support for Bootstrap offcanvas

offcanvas( selector = '', mixed||string|int options = []) :
static
since

4.0.0

Arguments

selector

stringThe ID selector for the offcanvas.

options

array<string|int, mixed>An array of options for the offcanvas.

Response

void

popover

Add javascript support for Bootstrap popovers

popover( selector = '', mixed||string|int options = []) :
static

Use element's Title as popover content

since

3.0

Arguments

selector

stringSelector for the popover

options

array<string|int, mixed>The options for the popover

Response

void

renderModal

Method to render a Bootstrap modal

renderModal( selector = 'modal', mixed||string|int options = [],  body = '') :
static
since

3.0

Arguments

selector

stringThe ID selector for the modal. Expects a valid ID without the #!

options

array<string|int, mixed>An array of options for the modal.

body

stringMarkup for the modal body. Appended after the <iframe> if the URL option is set

Response

stringHTML markup for a modal

scrollspy

Add javascript support for Bootstrap Scrollspy

scrollspy( selector = '', mixed||string|int options = []) :
static
since

3.0

Arguments

selector

stringThe ID selector for the ScrollSpy element.

options

array<string|int, mixed>An array of options for the ScrollSpy.

Response

void

startAccordion

Add javascript support for Bootstrap accordions and insert the accordion

startAccordion( selector = 'myAccordian', mixed||string|int options = []) :
static
since

3.0

Arguments

selector

stringThe ID selector for the tooltip. Expects a valid ID without the #!

options

array<string|int, mixed>An array of options for the tooltip.

Response

stringHTML for the accordion

startTabSet

Creates a tab pane

startTabSet( selector = 'myTab', mixed||string|int params = []) :
static
since

3.1

Arguments

selector

stringThe pane identifier. Expects a valid ID without the #!

params

array<string|int, mixed>The parameters for the pane

Response

string

tab

Add javascript support for Bootstrap tab

tab( selector = '', mixed||string|int options = []) :
static
throws

Exception
since

4.0.0

Arguments

selector

stringCommon class for the tabs

options

array<string|int, mixed>Options for the tabs

Response

void

toast

Add javascript support for Bootstrap toasts

toast( selector = '', mixed||string|int options = []) :
static
throws

Exception
since

4.0.0

Arguments

selector

stringCommon class for the toasts

options

array<string|int, mixed>Options for the toasts

Response

void

tooltip

Add javascript support for Bootstrap tooltips

tooltip( selector = '', mixed||string|int options = []) :
static

Add a title attribute to any element in the form title="title::text"

since

3.0

Arguments

selector

stringThe ID selector for the tooltip.

options

array<string|int, mixed>An array of options for the tooltip.

Response

void

Properties

loaded

Array containing information for loaded files

static
since

3.0

Type(s)

array<string|int, mixed>
  • \ Joomla
  • \ CMS
  • \ HTML
  • \ Helpers
  • \ Bootstrap