Bootstrap
Utility class for Bootstrap elements.
since |
3.0 |
---|---|
package |
Joomla CMS |
Methods
addSlide
Begins the display of a new accordion slide.
addSlide( selector, text, id, class = '') :
since |
3.0 |
---|
Arguments
- selector
string
Identifier of the accordion group.- text
string
Text to display.- id
string
Identifier of the slide.- class
string
Class of the accordion group.
Response
string
HTML to add the slide
addTab
Begins the display of a new tab content panel.
addTab( selector, id, title) :
since |
3.1 |
---|
Arguments
- selector
string
Identifier of the panel. Expects a valid ID without the #!- id
string
The ID of the div element. Expects a valid ID without the #!- title
string
The title text for the new UL tab
Response
string
HTML to start a new panel
alert
Add javascript support for Bootstrap alerts
alert( selector = '') :
throws |
|
---|---|
since |
3.0 |
Arguments
- selector
string
Common class for the alerts
Response
void
button
Add javascript support for Bootstrap buttons
button( selector = '') :
throws |
|
---|---|
since |
3.1 |
Arguments
- selector
string
Common class for the buttons
Response
void
carousel
Add javascript support for Bootstrap carousels
carousel( selector = '', mixed||string|int params = []) :
throws |
|
---|---|
since |
3.0 |
Arguments
- selector
string
Common 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 = []) :
throws |
|
---|---|
since |
4.0.0 |
Arguments
- selector
string
Common 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 = []) :
since |
4.0.0 |
---|
Arguments
- selector
string
Common class for the dropdowns- params
array<string|int, mixed>
The options for the dropdowns
Response
void
endAccordion
Close the current accordion
endAccordion() :
since |
3.0 |
---|
Response
string
HTML to close the accordion
endSlide
Close the current slide
endSlide() :
since |
3.0 |
---|
Response
string
HTML to close the slide
endTab
Close the current tab content panel
endTab() :
since |
3.1 |
---|
Response
string
HTML to close the pane
endTabSet
Close the current tab pane
endTabSet() :
since |
3.1 |
---|
Response
string
HTML to close the pane
framework
Method to load the ALL the Bootstrap Components
framework( debug = null) :
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
mixed
Is debugging mode on? [optional]
Response
void
loadCss
Loads CSS files needed by Bootstrap
loadCss( includeMainCss = true, direction = 'ltr', mixed||string|int attribs = []) :
since |
3.0 |
---|
Arguments
- includeMainCss
bool
If true, main bootstrap.css files are loaded- direction
string
rtl 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 = []) :
since |
4.0.0 |
---|
Arguments
- selector
string
The 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 = []) :
since |
4.0.0 |
---|
Arguments
- selector
string
The 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 = []) :
Use element's Title as popover content
since |
3.0 |
---|
Arguments
- selector
string
Selector 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 = '') :
since |
3.0 |
---|
Arguments
- selector
string
The ID selector for the modal. Expects a valid ID without the #!- options
array<string|int, mixed>
An array of options for the modal.- body
string
Markup for the modal body. Appended after the<iframe>
if the URL option is set
Response
string
HTML markup for a modal
scrollspy
Add javascript support for Bootstrap Scrollspy
scrollspy( selector = '', mixed||string|int options = []) :
since |
3.0 |
---|
Arguments
- selector
string
The 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 = []) :
since |
3.0 |
---|
Arguments
- selector
string
The ID selector for the tooltip. Expects a valid ID without the #!- options
array<string|int, mixed>
An array of options for the tooltip.
Response
string
HTML for the accordion
startTabSet
Creates a tab pane
startTabSet( selector = 'myTab', mixed||string|int params = []) :
since |
3.1 |
---|
Arguments
- selector
string
The 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 = []) :
throws |
|
---|---|
since |
4.0.0 |
Arguments
- selector
string
Common 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 = []) :
throws |
|
---|---|
since |
4.0.0 |
Arguments
- selector
string
Common 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 = []) :
Add a title attribute to any element in the form title="title::text"
since |
3.0 |
---|
Arguments
- selector
string
The 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
since |
3.0 |
---|
Type(s)
array<string|int, mixed>