Bootstrap
Utility class for Bootstrap elements.
since |
3.0 |
---|---|
package |
Joomla CMS |
Methods
addSlide
Begins the display of a new accordion slide.
addSlide(string selector, string text, string id, string class = '') : string
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(string selector, string id, string title) : string
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(string selector = '') : void
throws |
|
---|---|
since |
3.0 |
Arguments
- selector
string
Common class for the alerts
button
Add javascript support for Bootstrap buttons
button(string selector = '') : void
throws |
|
---|---|
since |
3.1 |
Arguments
- selector
string
Common class for the buttons
carousel
Add javascript support for Bootstrap carousels
carousel(string selector = '', array params = []) : void
throws |
|
---|---|
since |
3.0 |
Arguments
- selector
string
Common class for the carousels.- params
array
An array of options for the carousel.
collapse
Add javascript support for Bootstrap collapse
collapse(string selector = '', string[] params = []) : void
throws |
|
---|---|
since |
4.0.0 |
Arguments
- selector
string
Common class for the collapse- params
string[]
Additional parameters - see below
dropdown
Add javascript support for Bootstrap dropdowns
dropdown(string selector = '', array params = []) : void
since |
4.0.0 |
---|
Arguments
- selector
string
Common class for the dropdowns- params
array
The options for the dropdowns
endAccordion
Close the current accordion
endAccordion() : string
since |
3.0 |
---|
Response
string
HTML to close the accordion
endSlide
Close the current slide
endSlide() : string
since |
3.0 |
---|
Response
string
HTML to close the slide
endTab
Close the current tab content panel
endTab() : string
since |
3.1 |
---|
Response
string
HTML to close the pane
endTabSet
Close the current tab pane
endTabSet() : string
since |
3.1 |
---|
Response
string
HTML to close the pane
framework
Method to load the ALL the Bootstrap Components
framework(mixed debug = null) : void
If debugging mode is on an uncompressed version of Bootstrap is included for easier debugging.
since |
3.0 |
---|---|
deprecated |
5.0 |
Arguments
- debug
mixed
Is debugging mode on? [optional]
loadCss
Loads CSS files needed by Bootstrap
loadCss(bool includeMainCss = true, string direction = 'ltr', array attribs = []) : void
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
Optional array of attributes to be passed to HTMLHelper::_('stylesheet')
modal
Add javascript support for Bootstrap modal
modal(string selector = '', array options = []) : void
since |
4.0.0 |
---|
Arguments
- selector
string
The ID selector for the modal.- options
array
An array of options for the modal.
offcanvas
Add javascript support for Bootstrap offcanvas
offcanvas(string selector = '', array options = []) : void
since |
4.0.0 |
---|
Arguments
- selector
string
The ID selector for the offcanvas.- options
array
An array of options for the offcanvas.
popover
Add javascript support for Bootstrap popovers
popover(string selector = '', array options = []) : void
Use element's Title as popover content
since |
3.0 |
---|
Arguments
- selector
string
Selector for the popover- options
array
The options for the popover
renderModal
Method to render a Bootstrap modal
renderModal(string selector = 'modal', array options = [], string body = '') : string
since |
3.0 |
---|
Arguments
- selector
string
The ID selector for the modal. Expects a valid ID without the #!- options
array
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(string selector = '', array options = []) : void
since |
3.0 |
---|
Arguments
- selector
string
The ID selector for the ScrollSpy element.- options
array
An array of options for the ScrollSpy.
startAccordion
Add javascript support for Bootstrap accordions and insert the accordion
startAccordion(string selector = 'myAccordian', array options = []) : string
since |
3.0 |
---|
Arguments
- selector
string
The ID selector for the tooltip. Expects a valid ID without the #!- options
array
An array of options for the tooltip.
Response
string
HTML for the accordion
startTabSet
Creates a tab pane
startTabSet(string selector = 'myTab', array params = []) : string
since |
3.1 |
---|
Arguments
- selector
string
The pane identifier. Expects a valid ID without the #!- params
array
The parameters for the pane
Response
string
tab
Add javascript support for Bootstrap tab
tab(string selector = '', array options = []) : void
throws |
|
---|---|
since |
4.0.0 |
Arguments
- selector
string
Common class for the tabs- options
array
Options for the tabs
toast
Add javascript support for Bootstrap toasts
toast(string selector = '', array options = []) : void
throws |
|
---|---|
since |
4.0.0 |
Arguments
- selector
string
Common class for the toasts- options
array
Options for the toasts
tooltip
Add javascript support for Bootstrap tooltips
tooltip(string selector = '', array options = []) : void
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
An array of options for the tooltip.