Bring Bootstrap's components to life with over a dozen custom jQuery plugins. Easily include them all, or one by one.
Overview
Individual or compiled
Plugins can be included individually (using Bootstrap's individual *.js files), or all at once (using bootstrap.js or the minified bootstrap.min.js).
Using the compiled JavaScript
Both bootstrap.js and bootstrap.min.js contain all plugins in a single file. Include only one.
Plugin dependencies
Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs. Also note that all plugins depend on jQuery (this means jQuery must be included before the plugin files). Consult our bower.json to see which versions of jQuery are supported.
Data attributes
You can use all Bootstrap plugins purely through the markup API without writing a single line of JavaScript. This is Bootstrap's first-class API and should be your first consideration when using a plugin.
That said, in some situations it may be desirable to turn this functionality off. Therefore, we also provide the ability to disable the data attribute API by unbinding all events on the document namespaced with data-api. This looks like this:
$(document).off('.data-api')
Alternatively, to target a specific plugin, just include the plugin's name as a namespace along with the data-api namespace like this:
$(document).off('.alert.data-api')
Only one plugin per element via data attributes
Don't use data attributes from multiple plugins on the same element. For example, a button cannot both have a tooltip and toggle a modal. To accomplish this, use a wrapping element.
Syntax for Data Attribute Options
Quotes and apostrophes should be reversed for passing an object through data attributes. While the Wrong example below can be formatted with " HTML character references for the internal quotation marks instead of apostrophes, only use this approach if required by another system. For readability and keystroke brevity, use the Correct example's syntax below.
Fractions must be preceded with a leading zero (e.g., .5 = 0.5)
The last item in the object list must not have a comma following its entry
Programmatic API
We also believe you should be able to use all Bootstrap plugins purely through the JavaScript API. All public APIs are single, chainable methods, and return the collection acted upon.
$('.btn.danger').button('toggle').addClass('fat')
All methods should accept an optional options object, a string which targets a particular method, or nothing (which initiates a plugin with default behavior):
$('#myModal').modal()// initialized with defaults$('#myModal').modal({keyboard:false})// initialized with no keyboard$('#myModal').modal('show')// initializes and invokes show immediately
Each plugin also exposes its raw constructor on a Constructor property: $.fn.popover.Constructor. If you'd like to get a particular plugin instance, retrieve it directly from an element: $('[rel="popover"]').data('popover').
Default settings
You can change the default settings for a plugin by modifying the plugin's Constructor.DEFAULTS object:
$.fn.modal.Constructor.DEFAULTS.keyboard=false// changes default for the modal plugin's `keyboard` option to false
No conflict
Sometimes it is necessary to use Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call .noConflict on the plugin you wish to revert the value of.
varbootstrapButton=$.fn.button.noConflict()// return $.fn.button to previously assigned value$.fn.bootstrapBtn=bootstrapButton// give $().bootstrapBtn the Bootstrap functionality
Events
Bootstrap provides custom events for most plugins' unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex. show) is triggered at the start of an event, and its past participle form (ex. shown) is triggered on the completion of an action.
As of 3.0.0, all Bootstrap events are namespaced.
All infinitive events provide preventDefault functionality. This provides the ability to stop the execution of an action before it starts.
$('#myModal').on('show.bs.modal',function(e){if(!data)returne.preventDefault()// stops modal from being shown})
Sanitizer
Tooltips and Popovers use our built-in sanitizer to sanitize options which accept HTML.
The default whiteList value is the following:
varARIA_ATTRIBUTE_PATTERN=/^aria-[\w-]*$/ivarDefaultWhitelist={// Global attributes allowed on any supplied element below.'*':['class','dir','id','lang','role',ARIA_ATTRIBUTE_PATTERN],a:['target','href','title','rel'],area:[],b:[],br:[],col:[],code:[],div:[],em:[],hr:[],h1:[],h2:[],h3:[],h4:[],h5:[],h6:[],i:[],img:['src','alt','title','width','height'],li:[],ol:[],p:[],pre:[],s:[],small:[],span:[],sub:[],sup:[],strong:[],u:[],ul:[]}
If you want to add new values to this default whiteList you can do the following:
varmyDefaultWhiteList=$.fn.tooltip.Constructor.DEFAULTS.whiteList// To allow table elementsmyDefaultWhiteList.table=[]// To allow td elements and data-option attributes on td elementsmyDefaultWhiteList.td=['data-option']// You can push your custom regex to validate your attributes.// Be careful about your regular expressions being too laxvarmyCustomRegex=/^data-my-app-[\w-]+/myDefaultWhiteList['*'].push(myCustomRegex)
If you want to bypass our sanitizer because you prefer to use a dedicated library, for example DOMPurify, you should do the following:
Browsers without document.implementation.createHTMLDocument
In case of browsers that don't support document.implementation.createHTMLDocument, like Internet Explorer 8, the built-in sanitize function returns the HTML as is.
If you want to perform sanitization in this case, please specify sanitizeFn and use an external library like DOMPurify.
Version numbers
The version of each of Bootstrap's jQuery plugins can be accessed via the VERSION property of the plugin's constructor. For example, for the tooltip plugin:
$.fn.tooltip.Constructor.VERSION// => "3.4.1"
No special fallbacks when JavaScript is disabled
Bootstrap's plugins don't fall back particularly gracefully when JavaScript is disabled. If you care about the user experience in this case, use <noscript> to explain the situation (and how to re-enable JavaScript) to your users, and/or add your own custom fallbacks.
Third-party libraries
Bootstrap does not officially support third-party JavaScript libraries like Prototype or jQuery UI. Despite .noConflict and namespaced events, there may be compatibility problems that you need to fix on your own.
Add-ons
Add-Ons are components that must be loaded separately from the LXCore framework. By separating the components in this manner, the site avoids the bloat of loading unneeded components when they are generally going to be used on a small group of pages. Instructions for each add-on component may be found below.
Detect detect.js
Detect analyzes a client's user agent string to parse the client's operating system.
Loading the Component
Add the following in the page, replacing the "?"s with the appropriate version of LXCore.
Note: OS List Test page contains a list and sample user agent strings for OSs that were found online.
Affix affix.js
Example
The affix plugin toggles position: fixed; on and off, emulating the effect found with position: sticky;. The subnavigation on the right is a live demo of the affix plugin.
Usage
Use the affix plugin via data attributes or manually with your own JavaScript. In both situations, you must provide CSS for the positioning and width of your affixed content.
Note: Do not use the affix plugin on an element contained in a relatively positioned element, such as a pulled or pushed column, due to a Safari rendering bug.
Positioning via CSS
The affix plugin toggles between three classes, each representing a particular state: .affix, .affix-top, and .affix-bottom. You must provide the styles, with the exception of position: fixed; on .affix, for these classes yourself (independent of this plugin) to handle the actual positions.
Here's how the affix plugin works:
To start, the plugin adds .affix-top to indicate the element is in its top-most position. At this point no CSS positioning is required.
Scrolling past the element you want affixed should trigger the actual affixing. This is where .affix replaces .affix-top and sets position: fixed; (provided by Bootstrap's CSS).
If a bottom offset is defined, scrolling past it should replace .affix with .affix-bottom. Since offsets are optional, setting one requires you to set the appropriate CSS. In this case, add position: absolute; when necessary. The plugin uses the data attribute or JavaScript option to determine where to position the element from there.
Follow the above steps to set your CSS for either of the usage options below.
Via data attributes
To easily add affix behavior to any element, just add data-spy="affix" to the element you want to spy on. Use offsets to define when to toggle the pinning of an element.
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-offset-top="200".
Name
type
default
description
offset
number | function | object
10
Pixels to offset from screen when calculating position of scroll. If a single number is provided, the offset will be applied in both top and bottom directions. To provide a unique, bottom and top offset just provide an object offset: { top: 10 } or offset: { top: 10, bottom: 5 }. Use a function when you need to dynamically calculate an offset.
target
selector | node | jQuery element
the window object
Specifies the target element of the affix.
Methods
.affix(options)
Activates your content as affixed content. Accepts an optional options object.
$('#myAffix').affix({offset:15})
.affix('checkPosition')
Recalculates the state of the affix based on the dimensions, position, and scroll position of the relevant elements. The .affix, .affix-top, and .affix-bottom classes are added to or removed from the affixed content according to the new state. This method needs to be called whenever the dimensions of the affixed content or the target element are changed, to ensure correct positioning of the affixed content.
$('#myAffix').affix('checkPosition')
Events
Bootstrap's affix plugin exposes a few events for hooking into affix functionality.
Event Type
Description
affix.bs.affix
This event fires immediately before the element has been affixed.
affixed.bs.affix
This event is fired after the element has been affixed.
affix-top.bs.affix
This event fires immediately before the element has been affixed-top.
affixed-top.bs.affix
This event is fired after the element has been affixed-top.
affix-bottom.bs.affix
This event fires immediately before the element has been affixed-bottom.
affixed-bottom.bs.affix
This event is fired after the element has been affixed-bottom.
Alert messages alert.js
Example alerts
Add dismiss functionality to all alert messages with this plugin.
When using a .close button, it must be the first child of the .alert-dismissible and no text content may come before it in the markup.
Holy guacamole! Best check yo self, you're not looking too good.
Oh snap! You got an error!
Change this and that and try again. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum.
Usage
Just add data-dismiss="alert" to your close button to automatically give an alert close functionality. Closing an alert removes it from the DOM.
To have your alerts use animation when closing, make sure they have the .fade and .in classes already applied to them.
Methods
$().alert()
Makes an alert listen for click events on descendant elements which have the data-dismiss="alert" attribute. (Not necessary when using the data-api's auto-initialization.)
$().alert('close')
Closes an alert by removing it from the DOM. If the .fade and .in classes are present on the element, the alert will fade out before it is removed.
Events
Bootstrap's alert plugin exposes a few events for hooking into alert functionality.
Event Type
Description
close.bs.alert
This event fires immediately when the close instance method is called.
closed.bs.alert
This event is fired when the alert has been closed (will wait for CSS transitions to complete).
$('#myAlert').on('closed.bs.alert',function(){// do something…})
Buttons button.js
Do more with buttons. Control button states or create groups of buttons for more components like toolbars.
<buttontype="button"id="myButton"data-loading-text="Loading..."class="btn btn-primary"autocomplete="off">
Loading state
</button><script>$('#myButton').on('click',function(){var$btn=$(this).button('loading')// business logic...$btn.button('reset')})</script>
Single toggle
Add data-toggle="button" to activate toggling on a single button.
Pre-toggled buttons need .active and aria-pressed="true"
For pre-toggled buttons, you must add the .active class and the aria-pressed="true" attribute to the button yourself.
<buttontype="button"class="btn btn-primary"data-toggle="button"aria-pressed="false"autocomplete="off">
Single toggle
</button>
Checkbox / Radio
Add data-toggle="buttons" to a .btn-group containing checkbox or radio inputs to enable toggling in their respective styles.
Preselected options need .active
For preselected options, you must add the .active class to the input's label yourself.
Visual checked state only updated on click
If the checked state of a checkbox button is updated without firing a click event on the button (e.g. via <input type="reset"> or via setting the checked property of the input), you will need to toggle the .active class on the input's label yourself.
<divclass="btn-group"data-toggle="buttons"><labelclass="btn btn-primary active"><inputtype="radio"name="options"id="option1"autocomplete="off"checked> Radio 1 (preselected)
</label><labelclass="btn btn-primary"><inputtype="radio"name="options"id="option2"autocomplete="off"> Radio 2
</label><labelclass="btn btn-primary"><inputtype="radio"name="options"id="option3"autocomplete="off"> Radio 3
</label></div>
Methods
$().button('toggle')
Toggles push state. Gives the button the appearance that it has been activated.
$().button('reset')
Resets button state - swaps text to original text. This method is asynchronous and returns before the resetting has actually completed.
$().button(string)
Swaps text to any data defined text state.
<buttontype="button"id="myStateButton"data-complete-text="finished!"class="btn btn-primary"autocomplete="off">
...
</button><script>$('#myStateButton').on('click',function(){$(this).button('complete')// button text will be "finished!"})</script>
Carousel carousel.js
A slideshow component for cycling through elements, like a carousel. Nested carousels are not supported.
The carousel component is generally not compliant with accessibility standards. If you need to be compliant, please consider other options for presenting your content.
Transition animations not supported in Internet Explorer 8 & 9
Bootstrap exclusively uses CSS3 for its animations, but Internet Explorer 8 & 9 don't support the necessary CSS properties. Thus, there are no slide transition animations when using these browsers. We have intentionally decided not to include jQuery-based fallbacks for the transitions.
Initial active element required
The .active class needs to be added to one of the slides. Otherwise, the carousel will not be visible.
Lexicon icons not necessary
The .lexicon .lexicon-caret_left and .lexicon .lexicon-caret_right classes are not necessarily needed for the controls. Bootstrap provides .icon-prev and .icon-next as plain unicode alternatives.
Optional captions
Add captions to your slides easily with the .carousel-caption element within any .item. Place just about any optional HTML within there and it will be automatically aligned and formatted.
First slide label
Nulla vitae elit libero, a pharetra augue mollis interdum.
Second slide label
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Third slide label
Praesent commodo cursus magna, vel scelerisque nisl consectetur.
Adding thumbnails to the carousel requires removing the indicator dots and adding a second carousel with a nested grid after the main carousel. As well as, adding the data-thumbnails attribute to the main carousel for functionality and a class of .carousel-thumbnails for proper styling.
The added data attribute needs an id to reference the thumbnail carousel (i.e. data-thumbnails="#carousel-thumbnails"). The left and right indicator controls are optional and hold the same structure as before.
The number of columns of the thumbnail carousel can vary dependant on the design and the number of columns put into the html structure.
Thumbnail Carousel data and href's
The thumbnails data-target attributes must point to the id of the carousel it is indicating for, and the prev and next arrows of the thumbnail carousel must have their href point to the id of the thumbnail carousel they are nested under.
If the data attributes are not setup correctly the carousel will refuse to work.
Carousels require the use of an id on the outermost container (the .carousel) for carousel controls to function properly. When adding multiple carousels, or when changing a carousel's id, be sure to update the relevant controls.
Via data attributes
Use data attributes to easily control the position of the carousel. data-slide accepts the keywords prev or next, which alters the slide position relative to its current position. Alternatively, use data-slide-to to pass a raw slide index to the carousel data-slide-to="2", which shifts the slide position to a particular index beginning with 0.
The data-ride="carousel" attribute is used to mark a carousel as animating starting at page load. It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-interval="".
Name
type
default
description
interval
number
5000
The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
pause
string | null
"hover"
If set to "hover", pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave. If set to null, hovering over the carousel won't pause it.
wrap
boolean
true
Whether the carousel should cycle continuously or have hard stops.
keyboard
boolean
true
Whether the carousel should react to keyboard events.
Methods
.carousel(options)
Initializes the carousel with an optional options object and starts cycling through items.
$('.carousel').carousel({interval:2000})
.carousel('cycle')
Cycles through the carousel items from left to right.
.carousel('pause')
Stops the carousel from cycling through items.
.carousel(number)
Cycles the carousel to a particular frame (0 based, similar to an array).
.carousel('prev')
Cycles to the previous item.
.carousel('next')
Cycles to the next item.
Events
Bootstrap's carousel class exposes two events for hooking into carousel functionality.
Both events have the following additional properties:
direction: The direction in which the carousel is sliding (either "left" or "right").
relatedTarget: The DOM element that is being slid into place as the active item.
All carousel events are fired at the carousel itself (i.e. at the <div class="carousel">).
Event Type
Description
slide.bs.carousel
This event fires immediately when the slide instance method is invoked.
slid.bs.carousel
This event is fired when the carousel has completed its slide transition.
$('#myCarousel').on('slide.bs.carousel',function(){// do something…})
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
<aclass="btn btn-primary"role="button"data-toggle="collapse"href="#collapseExample"aria-expanded="false"aria-controls="collapseExample">
Link with href
</a><buttonclass="btn btn-primary"type="button"data-toggle="collapse"data-target="#collapseExample"aria-expanded="false"aria-controls="collapseExample">
Button with data-target
</button><divclass="collapse"id="collapseExample"><divclass="well">
...
</div></div>
Accordion example
Extend the default collapse behavior to create an accordion with the panel component.
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
<divclass="panel-group"id="accordion"role="tablist"aria-multiselectable="true"><divclass="panel panel-accordion active"><divclass="panel-heading"role="tab"id="headingOne"><divclass="panel-title"><arole="button"data-toggle="collapse"href="#collapseOne"aria-expanded="true"aria-controls="collapseOne"><span>Collapsible Group Item #1</span></a></div></div><divid="collapseOne"class="panel-collapse collapse in"role="tabpanel"aria-labelledby="headingOne"><divclass="panel-body"><p>Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.</p></div><divclass="panel-footer"><arole="button"data-toggle="collapse"href="#collapseOne"aria-expanded="true"aria-controls="collapseOne"><span>collapse</span></a></div></div></div><divclass="panel panel-accordion"><divclass="panel-heading"role="tab"id="headingTwo"><divclass="panel-title"><aclass="collapsed"role="button"data-toggle="collapse"href="#collapseTwo"aria-expanded="false"aria-controls="collapseTwo"><span>Collapsible Group Item #2</span></a></div></div><divid="collapseTwo"class="panel-collapse collapse"role="tabpanel"aria-labelledby="headingTwo"><divclass="panel-body">
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
</div><divclass="panel-footer"><arole="button"data-toggle="collapse"href="#collapseTwo"aria-expanded="true"aria-controls="collapseTwo"><span>collapse</span></a></div></div></div><divclass="panel panel-accordion"><divclass="panel-heading"role="tab"id="headingThree"><divclass="panel-title"><aclass="collapsed"role="button"data-toggle="collapse"href="#collapseThree"aria-expanded="false"aria-controls="collapseThree"><span>Collapsible Group Item #3</span></a></div></div><divid="collapseThree"class="panel-collapse collapse"role="tabpanel"aria-labelledby="headingThree"><divclass="panel-body">
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
</div><divclass="panel-footer"><arole="button"data-toggle="collapse"href="#collapseThree"aria-expanded="true"aria-controls="collapseThree"><span>collapse</span></a></div></div></div></div>
$("#loadAccordion").click(function(){
$("#accordion-frame").html('...add accordion html structure...');
$(document).accordion();
This preferred behavior will allow none, one, or more panels open at a time. You can also limit the number of active panels to one by using data-parent attribute on any collapse link.
<aclass="collapsed"role="button"data-toggle="collapse"data-parent="#accordion"href="#collapseOne"aria-expanded="true"aria-controls="collapseOne">
Collapsible Group Item #1
</a>
It's also possible to swap out .panel-bodys with .list-groups.
Be sure to add aria-expanded to the control element. This attribute explicitly defines the current state of the collapsible element to screen readers and similar assistive technologies. If the collapsible element is closed by default, it should have a value of aria-expanded="false". If you've set the collapsible element to be open by default using the in class, set aria-expanded="true" on the control instead. The plugin will automatically toggle this attribute based on whether or not the collapsible element has been opened or closed.
Additionally, if your control element is targeting a single collapsible element – i.e. the data-target attribute is pointing to an id selector – you may add an additional aria-controls attribute to the control element, containing the id of the collapsible element. Modern screen readers and similar assistive technologies make use of this attribute to provide users with additional shortcuts to navigate directly to the collapsible element itself.
Usage
The collapse plugin utilizes a few classes to handle the heavy lifting:
.collapse hides the content
.collapse.in shows the content
.collapsing is added when the transition starts, and removed when it finishes
These classes can be found in component-animations.less.
Via data attributes
Just add data-toggle="collapse" and a data-target to the element to automatically assign control of a collapsible element. The data-target attribute accepts a CSS selector to apply the collapse to. Be sure to add the class collapse to the collapsible element. If you'd like it to default open, add the additional class in.
To add accordion-like group management to a collapsible control, add the data attribute data-parent="#selector". Refer to the demo to see this in action.
Via JavaScript
Enable manually with:
$('.collapse').collapse()
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-parent="".
Name
type
default
description
parent
selector
false
If a selector is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the panel class)
toggle
boolean
true
Toggles the collapsible element on invocation
Methods
.collapse(options)
Activates your content as a collapsible element. Accepts an optional options object.
$('#myCollapsible').collapse({toggle:false})
.collapse('toggle')
Toggles a collapsible element to shown or hidden. Returns to the caller before the collapsible element has actually been shown or hidden (i.e. before the shown.bs.collapse or hidden.bs.collapse event occurs).
.collapse('show')
Shows a collapsible element. Returns to the caller before the collapsible element has actually been shown (i.e. before the shown.bs.collapse event occurs).
.collapse('hide')
Hides a collapsible element. Returns to the caller before the collapsible element has actually been hidden (i.e. before the hidden.bs.collapse event occurs).
Events
Bootstrap's collapse class exposes a few events for hooking into collapse functionality.
Event Type
Description
show.bs.collapse
This event fires immediately when the show instance method is called.
shown.bs.collapse
This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.collapse
This event is fired immediately when the hide method has been called.
hidden.bs.collapse
This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).
$('#myCollapsible').on('hidden.bs.collapse',function(){// do something…})
Constrainer constrainer.js
Add the data attribute data-constrainer-options to any tag with text content to automatically limit the text by character or word of the element.
Option
Values
Notes
word-count
Number (integer)
Truncates the textual content after the specified number of words.
char-count
Number (integer)
Truncates the textual content after the specified number of characters.
moreText
Text
Replaces the default "..." that displays when any truncation occurs. Also replaces the default "(see more)" link that displays when the expandable option is true and the truncated content is visible.
lessText
Text
Replaces the default "(see less)" link that displays when the expandable option is true and the original content is visible.
showMoreText
Boolean (true is default)
If set to false, this option removes the default "..." that displays when any truncation occurs.
moreTextBefore
Text or HTML Mark-up
Adds the value before moreText. This may be helpful in customizing the moreText mark-up, such as adding a link by opening an anchor tag.
moreTextAfter
Text or HTML Mark-up
Adds the value after moreText. This may be helpful in customizing the moreText mark-up, such as adding a link by closing an anchor tag opened by moreTextBefore.
expandable
Boolean (false is default)
If set to true, this option adds a "(see more)" link after the truncated content that when clicked shows the original content with a "(see less)" link to return to the truncated content.
Examples
Word Limit
Limits the text to 9 words, ignoring extra spaces in the mark-up and any HTML tags and/or escape characters.
data-constrainer-options='{
"word-count": 9
}'
One two three four <p>five six seven</p> eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty
<pdata-constrainer-options='{ "word-count": 9 }'><imgsrc="images/9-to-6.gif">One two <i>three</i> four <p>five six seven</p> eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty</p>
Character Limit
Limits the text to 19 characters (including spaces between words), ignoring extra spaces and any HTML tags and/or escape characters.
data-constrainer-options='{
"char-count": 19
}'
One two three four <p>five six seven</p> eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty
<pdata-constrainer-options='{ "char-count": 19 }'><imgsrc="https://fakeimg.pl/150x75?text=image">One two <i>three</i> four <p>five six seven</p> eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty</p>
Custom moreText
Sets the moreText value to a custom text value (e.g., " (more)").
One two three four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty
<pdata-constrainer-options='{ "char-count": 25, "moreText": " (more)" }'>One two <em><i>three</i></em> four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty</p>
Custom Wrapper for moreText
Sets the 'moreTextBefore' and 'moreTextAfter' values to create a custom design and link.
One two three four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty
<pdata-constrainer-options='{ "char-count": 11, "moreText": " Read More", "moreTextBefore": "<p class=\"text-right margin-bottom-none\"><a href=\"http://www.google.com\">", "moreTextAfter": "</a></p>" }'>One two <em><i>three</i></em> four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty</p>
Expandable
Creates a toggable link to switch back and forth between truncated and original content. The default inline textual links are "(see more)" and "(see less)." They can be customized, if necessary.
One two three four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven
<pdata-constrainer-options='{ "char-count": 24, "expandable": "true" }'>One two <em><i>three</i></em> four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven <ahref="28.html">twenty-eight</a> twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven</p>
Data Action data-action.js
Add the data attribute data-action-options to any tag to automatically add a click behavior for adding a class, removing a class, showing or hiding, toggling a targeted element. The behavior can also redirect to another page.
Option
Values
Notes
handler
click default
hover
Optional
type
hide
show
addclass
removeclass
redirect
toggle
panelOpen
panelClose
panelToggle
Required
target
May be a class or id with '.' or '#' prefix, tag, or combination
Required
targetLocation
self default
closestParent
Optional
targetParent
May be a class or id with '.' or '#' prefix, tag, or combination
Required for targetLocation
class
May be a class or id with '.' or '#' prefix, tag, or combination
Required for addclass or removeclass. Optional for toggle
url
May be a relative or absolute link
Required for redirect
toggleOption
showhide default
custom
Use custom to specify a custom class
Examples
Add or Remove a class on click
The click handler is the default and does not need to be specified in the options.
Note that you will need to click the appropriate button to remove the class after adding it; otherwise, it will remain added.
The hover handler must be specified in the options with "handler": "hover".
Note that the addclass option adds a class upon mouseenter and removes the class upon mouseleave. The removeclass option is the reverse: it removes the class upon mouseenter and adds the class upon mouseleave. This removeclass behavior can result in a lot of additional classes being applied to the target, so it is advised to use it only on items that already have the class applied beforehand.
Adding "type": "redirect" and "url": "[page address]" will enable an element to redirect to the specified URL once someone has clicked on the element.
The hover handler may also be used here, but it has been removed from the examples below to prevent accidental navigation to another page when moving your mouse over the page.
Using the options "targetLocation": "closestParent" and "targetParent": ".parentClassOrId", you can add a class further up the DOM from your target. This is helpful if the item in the DOM does not have a specific class or id to target.
But Théoden was not utterly forsaken. The knights of his house lay slain about him, or else mastered by the madness of their steeds were borne far away. Yet one stood there still: Dernhelm the young, faithful beyond fear; and he wept, for he had loved his lord as a father. Right through the charge Merry had been borne unharmed behind him, until the Shadow came; and then Windfola had thrown them in his terror, and now ran wild upon the plain. Merry crawled on all fours like a dazed beast, and such a horror was on him that he was blind and sick.
'King's man! King's man!' his heart cried within him. 'You must stay by him. As a father you shall be to me, you said.' But his will made no answer, and his body shook. He dared not open his eyes or look up.
Then out of the blackness in his mind he thought that he heard Dernhelm speaking; yet now the voice seemed strange, recalling some other voice that he had known.
'Begone, foul dwimmerlaik, lord of carrion! Leave the dead in peace!'
A cold voice answered: 'Come not between the Nazgyl and his prey! Or he will not slay thee in thy turn. He will bear thee away to the houses of lamentation, beyond all darkness, where thy flesh shall be devoured, and thy shrivelled mind be left naked to the Lidless Eye.'
A sword rang as it was drawn. 'Do what you will; but I will hinder it, if I may.'
'Hinder me? Thou fool. No living man may hinder me!'
Then Merry heard of all sounds in that hour the strangest. It seemed that Dernhelm laughed, and the clear voice was like the ring of steel. 'But no living man am I! You look upon a woman. Éowyn I am, Éomund's daughter.
You stand between me and my lord and kin. Begone, if you be not deathless! For living or dark undead, I will smite you, if you touch him.'
The winged creature screamed at her, but the Ringwraith made no answer, and was silent, as if in sudden doubt. Very amazement for a moment conquered Merry's fear. He opened his eyes and the blackness was lifted from them. There some paces from him sat the great beast, and all seemed dark about it, and above it loomed the Nazgyl Lord like a shadow of despair. A little to the left facing them stood she whom he had called Dernhelm. But the helm of her secrecy, had fallen from her, and her bright hair, released from its bonds, gleamed with pale gold upon her shoulders. Her eyes grey as the sea were hard and fell, and yet tears were on her cheek. A sword was in her hand, and she raised her shield against the horror of her enemy's eyes.
Éowyn it was, and Dernhelm also. For into Merry's mind flashed the memory of the face that he saw at the riding from Dunharrow: the face of one that goes seeking death, having no hope. Pity filled his heart and great wonder, and suddenly the slow-kindled courage of his race awoke. He clenched his hand. She should not die, so fair, so desperate At least she should not die alone, unaided.
The face of their enemy was not turned towards him, but still he hardly dared to move, dreading lest the deadly eyes should fall on him. Slowly, slowly he began to crawl aside; but the Black Captain, in doubt and malice intent upon the woman before him, heeded him no more than a worm in the mud.
Suddenly the great beast beat its hideous wings, and the wind of them was foul. Again it leaped into the air, and then swiftly fell down upon Éowyn, shrieking, striking with beak and claw.
Still she did not blench: maiden of the Rohirrim, child of kings, slender but as a steel-blade, fair but terrible. A swift stroke she dealt, skilled and deadly. The outstretched neck she clove asunder, and the hewn head fell like a stone. Backward she sprang as the huge shape crashed to ruin, vast wings outspread, crumpled on the earth; and with its fall the shadow passed away. A light fell about her, and her hair shone in the sunrise.
Out of the wreck rose the Black Rider, tall and threatening, towering above her. With a cry of hatred that stung the very ears like venom he let fall his mace. Her shield was shivered in many pieces, and her arm was broken; she stumbled to her knees. He bent over her like a cloud, and his eyes glittered; he raised his mace to kill.
<divclass="col-xs-6 margin-bottom-4"><h4class="margin-top-none">Click Examples</h4><div><ahref="#"data-action-options='{ "type": "openPanel", "target": "#data-action-accordion-part1" }'>Open Part 1</a></div><div><ahref="#"data-action-options='{ "type": "closePanel", "target": "#data-action-accordion-part1" }'>Close Part 1</a></div><div><ahref="#"data-action-options='{ "type": "openPanel", "target": "#data-action-accordion-part2" }'>Open Part 2</a></div><div><ahref="#"data-action-options='{ "type": "openPanel", "target": "#data-action-accordion-part3" }'>Open Part 3</a></div><div><ahref="#"data-action-options='{ "type": "togglePanel", "target": "#data-action-accordion-part4" }'>Toggle Part 4</a></div></div><divclass="col-xs-6 margin-bottom-4"><h4class="margin-top-none">Hover Examples</h4><div><ahref="#"data-action-options='{ "handler": "hover", "type": "openPanel", "target": "#data-action-accordion-part1" }'>Open Part 1</a></div><div><ahref="#"data-action-options='{ "handler": "hover", "type": "closePanel", "target": "#data-action-accordion-part1" }'>Close Part 1</a></div><div><ahref="#"data-action-options='{ "handler": "hover", "type": "openPanel", "target": "#data-action-accordion-part2" }'>Open Part 2</a></div><div><ahref="#"data-action-options='{ "handler": "hover", "type": "openPanel", "target": "#data-action-accordion-part3" }'>Open Part 3</a></div><div><ahref="#"data-action-options='{ "handler": "hover", "type": "togglePanel", "target": "#data-action-accordion-part4" }'>Toggle Part 4</a></div></div>
Opening tab panels
Close and Toggle methods do not work for tabs because one tab cannot be closed or toggled unless another one is opened.
But Théoden was not utterly forsaken. The knights of his house lay slain about him, or else mastered by the madness of their steeds were borne far away. Yet one stood there still: Dernhelm the young, faithful beyond fear; and he wept, for he had loved his lord as a father. Right through the charge Merry had been borne unharmed behind him, until the Shadow came; and then Windfola had thrown them in his terror, and now ran wild upon the plain. Merry crawled on all fours like a dazed beast, and such a horror was on him that he was blind and sick.
'King's man! King's man!' his heart cried within him. 'You must stay by him. As a father you shall be to me, you said.' But his will made no answer, and his body shook. He dared not open his eyes or look up.
Then out of the blackness in his mind he thought that he heard Dernhelm speaking; yet now the voice seemed strange, recalling some other voice that he had known.
'Begone, foul dwimmerlaik, lord of carrion! Leave the dead in peace!'
A cold voice answered: 'Come not between the Nazgyl and his prey! Or he will not slay thee in thy turn. He will bear thee away to the houses of lamentation, beyond all darkness, where thy flesh shall be devoured, and thy shrivelled mind be left naked to the Lidless Eye.'
A sword rang as it was drawn. 'Do what you will; but I will hinder it, if I may.'
'Hinder me? Thou fool. No living man may hinder me!'
Then Merry heard of all sounds in that hour the strangest. It seemed that Dernhelm laughed, and the clear voice was like the ring of steel. 'But no living man am I! You look upon a woman. Éowyn I am, Éomund's daughter.
You stand between me and my lord and kin. Begone, if you be not deathless! For living or dark undead, I will smite you, if you touch him.'
The winged creature screamed at her, but the Ringwraith made no answer, and was silent, as if in sudden doubt. Very amazement for a moment conquered Merry's fear. He opened his eyes and the blackness was lifted from them. There some paces from him sat the great beast, and all seemed dark about it, and above it loomed the Nazgyl Lord like a shadow of despair. A little to the left facing them stood she whom he had called Dernhelm. But the helm of her secrecy, had fallen from her, and her bright hair, released from its bonds, gleamed with pale gold upon her shoulders. Her eyes grey as the sea were hard and fell, and yet tears were on her cheek. A sword was in her hand, and she raised her shield against the horror of her enemy's eyes.
Éowyn it was, and Dernhelm also. For into Merry's mind flashed the memory of the face that he saw at the riding from Dunharrow: the face of one that goes seeking death, having no hope. Pity filled his heart and great wonder, and suddenly the slow-kindled courage of his race awoke. He clenched his hand. She should not die, so fair, so desperate At least she should not die alone, unaided.
The face of their enemy was not turned towards him, but still he hardly dared to move, dreading lest the deadly eyes should fall on him. Slowly, slowly he began to crawl aside; but the Black Captain, in doubt and malice intent upon the woman before him, heeded him no more than a worm in the mud.
Suddenly the great beast beat its hideous wings, and the wind of them was foul. Again it leaped into the air, and then swiftly fell down upon Éowyn, shrieking, striking with beak and claw.
Still she did not blench: maiden of the Rohirrim, child of kings, slender but as a steel-blade, fair but terrible. A swift stroke she dealt, skilled and deadly. The outstretched neck she clove asunder, and the hewn head fell like a stone. Backward she sprang as the huge shape crashed to ruin, vast wings outspread, crumpled on the earth; and with its fall the shadow passed away. A light fell about her, and her hair shone in the sunrise.
Out of the wreck rose the Black Rider, tall and threatening, towering above her. With a cry of hatred that stung the very ears like venom he let fall his mace. Her shield was shivered in many pieces, and her arm was broken; she stumbled to her knees. He bent over her like a cloud, and his eyes glittered; he raised his mace to kill.
<divclass="col-xs-6 margin-bottom-4"><h4class="margin-top-none">Click Examples</h4><div><ahref="#"data-action-options='{ "type": "openPanel", "target": "#data-action-tab-part1" }'>Open Part 1</a></div><div><ahref="#"data-action-options='{ "type": "openPanel", "target": "#data-action-tab-part2" }'>Open Part 2</a></div><div><ahref="#"data-action-options='{ "type": "openPanel", "target": "#data-action-tab-part3" }'>Open Part 3</a></div><div><ahref="#"data-action-options='{ "type": "openPanel", "target": "#data-action-tab-part4" }'>Open Part 4</a></div></div><divclass="col-xs-6 margin-bottom-4"><h4class="margin-top-none">Hover Examples</h4><div><ahref="#"data-action-options='{ "handler": "hover", "type": "openPanel", "target": "#data-action-tab-part1" }'>Open Part 1</a></div><div><ahref="#"data-action-options='{ "handler": "hover", "type": "openPanel", "target": "#data-action-tab-part2" }'>Open Part 2</a></div><div><ahref="#"data-action-options='{ "handler": "hover", "type": "openPanel", "target": "#data-action-tab-part3" }'>Open Part 3</a></div><div><ahref="#"data-action-options='{ "handler": "hover", "type": "openPanel", "target": "#data-action-tab-part4" }'>Open Part 4</a></div></div>
Tables with DataTables datatables.js
Settings for a table may be passed through the 'data-datatables-options' data attribute as an object. For help with how to write the syntax of data attribute options, go to Syntax for Data Attribute Options. Options that may be passed are found in DataTables' documentation.
Default Settings
Note: Default dataTable options have been set to the following and do not need to be rewitten for every table unless you need to change one of the options to true/false:
DataTables can be setup to filter specifically by column. Add .inline-header-filters to the table and the initComplete: function to the dataTable options javascript.
<tableid="two-row-header-demo"class="table table-condensed table-bordered table-hover text-small inline-header-filters"summary="This is a summary of what this table contains and does"role="grid"aria-labelledby="two-row-header-demo-grid">
...
</table><!-- Example Javascript for Datatable column filter
$('#two-row-header-demo').DataTable({
"dom": "t",
"order": [1, 'asc'],
"columnDefs": [
{"width": "15%", "orderable": false, "targets": 0}
],
"orderCellsTop": true,
initComplete: function (settings, json) {
const api = this.api();
// that.statuses = api.column(5).data().unique().toArray();
// that.prodTypes = api.column(6).data().unique().toArray();
api.columns().every(function () {
const column = this;
const $head = $(column.header());
const inputContainer = $head.parent().next().children().get($head.index());
$(':input', inputContainer).val('').off('keyup change').on('keyup change', function (e) {
const $this = $(this);
const value = $this.val();
if (column.search() !== value) {
if ($this.is('select') && (value !== '')) {
column.search('\\b' + $.fn.dataTable.util.escapeRegex(value) + '\\b', true, false).draw();
} else {
column.search(value).draw();
}
}
});
});
}
});-->
DataTable DOM Options
DataTables have a set of options that can control the table and show more information about the contents of the table. These options can be shown or hidden. The order in which the letters are written around the 't' determines whether the options are shown above or below the table. For further documentation about DOM rules: https://datatables.net/reference/option/dom.
Name
Other Names
Titles
Bilbo Baggins
Mr. Lucky Number, Bilbo the Magnificent, Bilba Labingi
Burglar, Thief, Clue-finder, Web-cutter, Stinging Fly, Ringwinner, Luckwearer, Child of the Kindly West, Barrel-rider, Elf-friend, Mad Baggins, Ring-bearer
Merriadoc Brandybuck
Merry, "the Magnificent", Kalimac Brandagamba
Master of Buckland
Gandalf
Olórin, Mithrandir, Incánus, Tharkûn, The White Rider, Greyhame, Stormcrow, Old Grey Beard, Big Grey Beard, The White Pilgrim, Láthspell
The Grey, The White
Frodo Baggins
Mr. Underhill, The Halfling, Frodo of the Nine Fingers, Iorhael, Maura Labingi
Ring-bearer, Elf-friend, Master, Deputy Mayor of Michel Delving, Daur
Peregrin Took
Pippin, Fool of a Took, Ernil i Pheriannath, Thain Peregrin I, Razanur Tûk
Thain, Knight of Gondor, Guard of the Citadel, Counsellor of the North-kingdom
Bilbo Baggins
Mr. Lucky Number, Bilbo the Magnificent, Bilba Labingi
Burglar, Thief, Clue-finder, Web-cutter, Stinging Fly, Ringwinner, Luckwearer, Child of the Kindly West, Barrel-rider, Elf-friend, Mad Baggins, Ring-bearer
Merriadoc Brandybuck
Merry, "the Magnificent", Kalimac Brandagamba
Master of Buckland
Gandalf
Olórin, Mithrandir, Incánus, Tharkûn, The White Rider, Greyhame, Stormcrow, Old Grey Beard, Big Grey Beard, The White Pilgrim, Láthspell
The Grey, The White
Frodo Baggins
Mr. Underhill, The Halfling, Frodo of the Nine Fingers, Iorhael, Maura Labingi
Ring-bearer, Elf-friend, Master, Deputy Mayor of Michel Delving, Daur
Peregrin Took
Pippin, Fool of a Took, Ernil i Pheriannath, Thain Peregrin I, Razanur Tûk
Thain, Knight of Gondor, Guard of the Citadel, Counsellor of the North-kingdom
<!--TO USE CUSTOM 'INPUT' PAGINATION STYLE--><tableclass="table"data-datatables-options='{
"dom": "ptp",
"paging": true,
"pageLength": 4,
"pagingType": "input",
"searching": true
}'>
...
</table><!--TO SHOW ONLY ARROWS ON PAGINATION--><tableclass="table"data-datatables-options='{
"dom": "ptp",
"paging": true,
"pageLength": 4,
"searching": true
}'>
...
</table><!--TO SHOW WORDS PREVIOUS/NEXT ON PAGINATION--><tableclass="table"data-datatables-options='{
"dom": "ptp",
"paging": true,
"pageLength": 4,
"searching": true,
"language": {
"paginate": {
"previous": "Previous",
"next": "Next"
}
}
}'>
...
</table><!--TO SHOW ROW COUNT--><tableclass="table"data-datatables-options='{
"dom": "iti",
"info": true
}
}'>
...
</table>
Dropdowns dropdown.js
Examples
Add dropdown menus to nearly anything with this simple plugin, including the navbar, tabs, and pills.
Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the .open class on the parent list item.
On mobile devices, opening a dropdown adds a .dropdown-backdrop as a tap area for closing dropdown menus when tapping outside the menu, a requirement for proper iOS support. This means that switching from an open dropdown menu to a different dropdown menu requires an extra tap on mobile.
Note: The data-toggle="dropdown" attribute is relied on for closing dropdown menus at an application level, so it's a good idea to always use it.
Via data attributes
Add data-toggle="dropdown" to a link or button to toggle a dropdown.
Regardless of whether you call your dropdown via JavaScript or instead use the data-api, data-toggle="dropdown" is always required to be present on the dropdown's trigger element.
Options
None
Methods
$().dropdown('toggle')
Toggles the dropdown menu of a given navbar or tabbed navigation.
Events
All dropdown events are fired at the .dropdown-menu's parent element.
All dropdown events have a relatedTarget property, whose value is the toggling anchor element.
Event Type
Description
show.bs.dropdown
This event fires immediately when the show instance method is called.
shown.bs.dropdown
This event is fired when the dropdown has been made visible to the user (will wait for CSS transitions, to complete).
hide.bs.dropdown
This event is fired immediately when the hide instance method has been called.
hidden.bs.dropdown
This event is fired when the dropdown has finished being hidden from the user (will wait for CSS transitions, to complete).
$('#myDropdown').on('show.bs.dropdown',function(){// do something…})
EvenHeight evenheight.js
Add the data attribute data-evenheight-options to any parent tag to automatically set the height of all immediate children tags to the height of the tallest child.
Add a custom class to the data attribute data-evenheight-options of a parent container to automatically set the height of all tags within the container to the tallest element assigned with the class.
Custom Class Example
Title
One two three four five six seven eight nine ten eleven twelve thirteen
Title
One two three four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty
<divclass="row"data-evenheight-options='{"customClass": ".well"}'><divclass="col-xs-12 col-sm-6"><divclass="well no-shadow"><h2class="text-center">Title</h2><p>One two three four five six seven eight nine ten eleven twelve thirteen</p></div></div><divclass="col-xs-12 col-sm-6"><divclass="well no-shadow"><h2class="text-center">Title</h2><p>One two three four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty</p></div></div></div>
Modals modal.js
Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.
Multiple open modals not supported
Be sure not to open a modal while another is still visible. Showing more than one modal at a time requires custom code.
Modal markup placement
Always try to place a modal's HTML code in a top-level position in your document to avoid other components affecting the modal's appearance and/or functionality.
Due to how HTML5 defines its semantics, the autofocus HTML attribute has no effect in Bootstrap modals. To achieve the same effect, use some custom JavaScript:
As a general rule of thumb, keep the modal header generic. i.e. Delete, Edit, Save. The patterns within LPMD differ slightly when you are working within a single product view at one time, and then you may use specific product names within the modal header i.e. Edit CX725de.
Informational modal
This type of modal is used when there is only a need to inform the user that something is happening or allow them to compare two different types of data simultaneously. If using the modal for comparative data, it is okay to reposition the modal to the left or right instead of the center. No actions are associated with this type of modal.
Title of Modal
Informational or comparative content goes here.
<divclass="modal fade"tabindex="-1"role="dialog"><divclass="modal-dialog"role="document"><divclass="modal-content"><divclass="modal-header"><buttontype="button"class="close"data-dismiss="modal"aria-label="Close"><spanaria-hidden="true">×</span></button><h4class="modal-title">Title of Modal</h4></div><divclass="modal-body"><p>Informational or comparative content goes here.</p></div></div><!-- /.modal-content --></div><!-- /.modal-dialog --></div><!-- /.modal -->
Error alert modal
This type of modal is used when there is an error and requires the users attention.
Cannot save data with errors
Your changes have not been saved because of the following:
Long name is required
Model number is required
<divclass="modal fade"tabindex="-1"role="dialog"><divclass="modal-dialog"role="document"><divclass="modal-content"><divclass="modal-header error-modal"><h4class="modal-title">Cannot save data with errors</h4></div><divclass="modal-body"><p>Your changes have not been saved because of the following:
<ul><li>Long name is required</li><li>Model number is required</li></ul></p><buttonclass="btn btn-default margin-bottom-1">Okay</button></div></div><!-- /.modal-content --></div><!-- /.modal-dialog --></div><!-- /.modal -->
Warning alert modal
This type of modal is used when there is important information associated with a previous action or event. Option to switch out the single button with the cancel/proceed .modal-footer markup.
Important order information
The changes to your account will affect all open orders.
<divclass="modal fade"tabindex="-1"role="dialog"><divclass="modal-dialog"role="document"><divclass="modal-content"><divclass="modal-header warning-modal"><h4class="modal-title">Important order information</h4></div><divclass="modal-body"><pclass="margin-bottom-2">The changes to your account will affect all open orders.</p><buttonclass="btn btn-default margin-bottom-1">Okay</button></div></div><!-- /.modal-content --></div><!-- /.modal-dialog --></div><!-- /.modal -->
Modal with submittable actions
This type of modal is used when the modal contains data that can be submitted. This does not include login or 401 interactions.
Don't worry! We've saved your place, so you only need to log back in to continue where you left off.
<divclass="modal fade"tabindex="-1"role="dialog"><divclass="modal-dialog"role="document"><divclass="modal-content"><divclass="modal-body"><h2class="margin-top-1">Your login has expired.</h2><p>Don't worry! We've saved your place, so you only need to log back in to continue where you left off.</p><form><divclass="form-group required"><labelfor="userName401">Username</label><inputtype="text"id="userName401"class="form-control"></div><divclass="form-group required"><labelfor="userPassword401">Password</label><inputtype="text"id="userPassword401"class="form-control"></div></form><buttonclass="btn btn-primary btn-block">Log in</button></div></div><!-- /.modal-content --></div><!-- /.modal-dialog --></div><!-- /.modal -->
Live demo
Toggle a modal via JavaScript by clicking the button below. It will slide down and fade in from the top of the page.
Modal title
Text in a modal
Duis mollis, est non commodo luctus, nisi erat porttitor ligula.
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
Be sure to add role="dialog" and aria-labelledby="...", referencing the modal title, to .modal, and role="document" to the .modal-dialog itself.
Additionally, you may give a description of your modal dialog with aria-describedby on .modal.
Embedding videos
Embedding videos in modals requires additional JavaScript not in Bootstrap to automatically start/stop playback. Below are examples in both jwplayer and YouTube. For YouTube, be sure to add enablejsapi=1 to the iframe embed URL.
Have a bunch of buttons that all trigger the same modal, just with slightly different contents? Use event.relatedTarget and HTML data-* attributes (possibly via jQuery) to vary the contents of the modal depending on which button was clicked. See the Modal Events docs for details on relatedTarget,
...more buttons...
New message
<buttontype="button"class="btn btn-primary"data-toggle="modal"data-target="#exampleModal"data-whatever="@mdo">Open modal for @mdo</button><buttontype="button"class="btn btn-primary"data-toggle="modal"data-target="#exampleModal"data-whatever="@fat">Open modal for @fat</button><buttontype="button"class="btn btn-primary"data-toggle="modal"data-target="#exampleModal"data-whatever="@getbootstrap">Open modal for @getbootstrap</button>
...more buttons...
<divclass="modal fade"id="exampleModal"tabindex="-1"role="dialog"aria-labelledby="exampleModalLabel"><divclass="modal-dialog"role="document"><divclass="modal-content"><divclass="modal-header"><buttontype="button"class="close"data-dismiss="modal"aria-label="Close"><spanaria-hidden="true">×</span></button><h4class="modal-title"id="exampleModalLabel">New message</h4></div><divclass="modal-body"><form><divclass="form-group"><labelfor="recipient-name"class="control-label">Recipient:</label><inputtype="text"class="form-control"id="recipient-name"></div><divclass="form-group"><labelfor="message-text"class="control-label">Message:</label><textareaclass="form-control"id="message-text"></textarea></div></form></div><divclass="modal-footer"><buttontype="button"class="btn btn-default"data-dismiss="modal">Close</button><buttontype="button"class="btn btn-primary">Send message</button></div></div></div></div>
$('#exampleModal').on('show.bs.modal',function(event){varbutton=$(event.relatedTarget)// Button that triggered the modalvarrecipient=button.data('whatever')// Extract info from data-* attributes// If necessary, you could initiate an AJAX request here (and then do the updating in a callback).// Update the modal's content. We'll use jQuery here, but you could use a data binding library or other methods instead.varmodal=$(this)modal.find('.modal-title').text('New message to '+recipient)modal.find('.modal-body input').val(recipient)})
Usage
The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also adds .modal-open to the <body> to override default scrolling behavior and generates a .modal-backdrop to provide a click area for dismissing shown modals when clicking outside the modal.
Via data attributes
Activate a modal without writing JavaScript. Set data-toggle="modal" on a controller element, like a button, along with a data-target="#foo" or href="#foo" to target a specific modal to toggle.
Call a modal with id myModal with a single line of JavaScript:
$('#myModal').modal(options)
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-backdrop="".
Name
type
default
description
backdrop
boolean or the string 'static'
true
Includes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.
keyboard
boolean
true
Closes the modal when escape key is pressed
show
boolean
true
Shows the modal when initialized.
remote
path
false
This option is deprecated since v3.3.0 and has been removed in v4. We recommend instead using client-side templating or a data binding framework, or calling jQuery.load yourself.
If a remote URL is provided, content will be loaded one time via jQuery's load method and injected into the .modal-content div. If you're using the data-api, you may alternatively use the href attribute to specify the remote source. An example of this is shown below:
Activates your content as a modal. Accepts an optional options object.
$('#myModal').modal({keyboard:false})
.modal('toggle')
Manually toggles a modal. Returns to the caller before the modal has actually been shown or hidden (i.e. before the shown.bs.modal or hidden.bs.modal event occurs).
$('#myModal').modal('toggle')
.modal('show')
Manually opens a modal. Returns to the caller before the modal has actually been shown (i.e. before the shown.bs.modal event occurs).
$('#myModal').modal('show')
.modal('hide')
Manually hides a modal. Returns to the caller before the modal has actually been hidden (i.e. before the hidden.bs.modal event occurs).
$('#myModal').modal('hide')
.modal('handleUpdate')
Readjusts the modal's positioning to counter a scrollbar in case one should appear, which would make the modal jump to the left.
Only needed when the height of the modal changes while it is open.
$('#myModal').modal('handleUpdate')
Events
Bootstrap's modal class exposes a few events for hooking into modal functionality.
All modal events are fired at the modal itself (i.e. at the <div class="modal">).
Event Type
Description
show.bs.modal
This event fires immediately when the show instance method is called. If caused by a click, the clicked element is available as the relatedTarget property of the event.
shown.bs.modal
This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the relatedTarget property of the event.
hide.bs.modal
This event is fired immediately when the hide instance method has been called.
hidden.bs.modal
This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
loaded.bs.modal
This event is fired when the modal has loaded content using the remote option.
$('#myModal').on('hidden.bs.modal',function(e){// do something...})
Popovers popover.js
Add small overlays of content, like those on the iPad, to any element for housing secondary information.
Popovers whose both title and content are zero-length are never displayed.
Plugin dependency
Popovers require the tooltip plugin to be included in your version of Bootstrap.
Opt-in functionality
For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning you must initialize them yourself.
One way to initialize all popovers on a page would be to select them by their data-toggle attribute:
Popovers in button groups, input groups, and tables require special setting
When using popovers on elements within a .btn-group or an .input-group, or on table-related elements (<td>, <th>, <tr>, <thead>, <tbody>, <tfoot>), you'll have to specify the option container: 'body' (documented below) to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the popover is triggered).
Don't try to show popovers on hidden elements
Invoking $(...).popover('show') when the target element is display: none; will cause the popover to be incorrectly positioned.
Popovers on disabled elements require wrapper elements
To add a popover to a disabled or .disabled element, put the element inside of a <div> and apply the popover to that <div> instead.
Multiple-line links
Sometimes you want to add a popover to a hyperlink that wraps multiple lines. The default behavior of the popover plugin is to center it horizontally and vertically. Add white-space: nowrap; to your anchors to avoid this.
Examples
Static popover
Four options are available: top, right, bottom, and left aligned.
Popover top
Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.
Popover right
Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.
Popover bottom
Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.
Popover left
Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.
Live demo
<buttontype="button"class="btn btn-lg btn-danger"data-toggle="popover"title="Popover title"data-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>
Four directions
<buttontype="button"class="btn btn-default"data-container="body"data-toggle="popover"data-placement="left"data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
Popover on left
</button><buttontype="button"class="btn btn-default"data-container="body"data-toggle="popover"data-placement="top"data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
Popover on top
</button><buttontype="button"class="btn btn-default"data-container="body"data-toggle="popover"data-placement="bottom"data-content="Vivamus
sagittis lacus vel augue laoreet rutrum faucibus.">
Popover on bottom
</button><buttontype="button"class="btn btn-default"data-container="body"data-toggle="popover"data-placement="right"data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
Popover on right
</button>
Dismiss on next click
Use the focus trigger to dismiss popovers on the next click that the user makes.
Specific markup required for dismiss-on-next-click
For proper cross-browser and cross-platform behavior, you must use the <a> tag, not the <button> tag, and you also must include the role="button" and tabindex attributes.
<atabindex="0"class="btn btn-lg btn-danger"role="button"data-toggle="popover"data-trigger="focus"title="Dismissible popover"data-content="And here's some amazing content. It's very engaging. Right?">Dismissible popover</a>
Usage
Enable popovers via JavaScript:
$('#example').popover(options)
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-animation="".
Note that for security reasons the sanitize, sanitizeFn and whiteList options cannot be supplied using data attributes.
Name
Type
Default
Description
animation
boolean
true
Apply a CSS fade transition to the popover
container
string | false
false
Appends the popover to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.
content
string | function
''
Default content value if data-content attribute isn't present.
If a function is given, it will be called with its this reference set to the element that the popover is attached to.
delay
number | object
0
Delay showing and hiding the popover (ms) - does not apply to manual trigger type
If a number is supplied, delay is applied to both hide/show
Object structure is: delay: { "show": 500, "hide": 100 }
html
boolean
false
Insert HTML into the popover. If false, jQuery's text method will be used to insert content into the DOM. Use text if you're worried about XSS attacks.
placement
string | function
'right'
How to position the popover - top | bottom | left | right | auto. When "auto" is specified, it will dynamically reorient the popover. For example, if placement is "auto left", the popover will display to the left when possible, otherwise it will display right.
When a function is used to determine the placement, it is called with the popover DOM node as its first argument and the triggering element DOM node as its second. The this context is set to the popover instance.
selector
string
false
If a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See this and an informative example.
The popover's title will be injected into the .popover-title.
The popover's content will be injected into the .popover-content.
.arrow will become the popover's arrow.
The outermost wrapper element should have the .popover class.
title
string | function
''
Default title value if title attribute isn't present.
If a function is given, it will be called with its this reference set to the element that the popover is attached to.
trigger
string
'click'
How popover is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. manual cannot be combined with any other trigger.
viewport
string | object | function
{ selector: 'body', padding: 0 }
Keeps the popover within the bounds of this element. Example: viewport: '#viewport' or { "selector": "#viewport", "padding": 0 }
If a function is given, it is called with the triggering element DOM node as its only argument. The this context is set to the popover instance.
sanitize
boolean
true
Enable or disable the sanitization. If activated 'template', 'content' and 'title' options will be sanitized.
Here you can supply your own sanitize function. This can be useful if you prefer to use a dedicated library to perform sanitization.
Data attributes for individual popovers
Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.
Methods
$().popover(options)
Initializes popovers for an element collection.
.popover('show')
Reveals an element's popover. Returns to the caller before the popover has actually been shown (i.e. before the shown.bs.popover event occurs). This is considered a "manual" triggering of the popover. Popovers whose both title and content are zero-length are never displayed.
$('#element').popover('show')
.popover('hide')
Hides an element's popover. Returns to the caller before the popover has actually been hidden (i.e. before the hidden.bs.popover event occurs). This is considered a "manual" triggering of the popover.
$('#element').popover('hide')
.popover('toggle')
Toggles an element's popover. Returns to the caller before the popover has actually been shown or hidden (i.e. before the shown.bs.popover or hidden.bs.popover event occurs). This is considered a "manual" triggering of the popover.
$('#element').popover('toggle')
.popover('destroy')
Hides and destroys an element's popover. Popovers that use delegation (which are created using the selector option) cannot be individually destroyed on descendant trigger elements.
$('#element').popover('destroy')
Events
Event Type
Description
show.bs.popover
This event fires immediately when the show instance method is called.
shown.bs.popover
This event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.popover
This event is fired immediately when the hide instance method has been called.
hidden.bs.popover
This event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).
inserted.bs.popover
This event is fired after the show.bs.popover event when the popover template has been added to the DOM.
$('#myPopover').on('hidden.bs.popover',function(){// do something…})
ScrollSpy scrollspy.js
Example in navbar
The ScrollSpy plugin is for automatically updating nav targets based on scroll position. Scroll the area below the navbar and watch the active class change. The dropdown sub items will be highlighted as well.
@fat
Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.
@mdo
Veniam marfa mustache skateboard, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's vero. Cupidatat four loko nisi, ea helvetica nulla carles. Tattooed cosby sweater food truck, mcsweeney's quis non freegan vinyl. Lo-fi wes anderson +1 sartorial. Carles non aesthetic exercitation quis gentrify. Brooklyn adipisicing craft beer vice keytar deserunt.
one
Occaecat commodo aliqua delectus. Fap craft beer deserunt skateboard ea. Lomo bicycle rights adipisicing banh mi, velit ea sunt next level locavore single-origin coffee in magna veniam. High life id vinyl, echo park consequat quis aliquip banh mi pitchfork. Vero VHS est adipisicing. Consectetur nisi DIY minim messenger bag. Cred ex in, sustainable delectus consectetur fanny pack iphone.
two
In incididunt echo park, officia deserunt mcsweeney's proident master cleanse thundercats sapiente veniam. Excepteur VHS elit, proident shoreditch +1 biodiesel laborum craft beer. Single-origin coffee wayfarers irure four loko, cupidatat terry richardson master cleanse. Assumenda you probably haven't heard of them art party fanny pack, tattooed nulla cardigan tempor ad. Proident wolf nesciunt sartorial keffiyeh eu banh mi sustainable. Elit wolf voluptate, lo-fi ea portland before they sold out four loko. Locavore enim nostrud mlkshk brooklyn nesciunt.
three
Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.
Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats.
Usage
Requires Bootstrap nav
Scrollspy currently requires the use of a Bootstrap nav component for proper highlighting of active links.
Resolvable ID targets required
Navbar links must have resolvable id targets. For example, a <a href="#home">home</a> must correspond to something in the DOM like <div id="home"></div>.
Non-:visible target elements ignored
Target elements that are not :visible according to jQuery will be ignored and their corresponding nav items will never be highlighted.
Requires relative positioning
No matter the implementation method, scrollspy requires the use of position: relative; on the element you're spying on. In most cases this is the <body>. When scrollspying on elements other than the <body>, be sure to have a height set and overflow-y: scroll; applied.
Via data attributes
To easily add scrollspy behavior to your topbar navigation, add data-spy="scroll" to the element you want to spy on (most typically this would be the <body>). Then add the data-target attribute with the ID or class of the parent element of any Bootstrap .nav component.
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-offset="".
Name
type
default
description
offset
number
10
Pixels to offset from top when calculating position of scroll.
Events
Event Type
Description
activate.bs.scrollspy
This event fires whenever a new item becomes activated by the scrollspy.
$('#myScrollspy').on('activate.bs.scrollspy',function(){// do something…})
Selects bootstrap-select.js
<select> statements use the third-party plug-in Bootstrap Select that hides the original <select> mark-up and builds out the <select> as <div>s that can be styled.
One two three four five six seven eight nine ten eleven twelve thirteen
Description
One two three four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty
<ulclass="nav nav-tabs"><lirole="presentation"><ahref="#title"data-smooth-scroll>Title</a></li><lirole="presentation"><ahref="#description"data-smooth-scroll>Description</a></li><lirole="presentation"><ahref="#summary"data-smooth-scroll>Summary</a></li></ul><div><divclass="well no-shadow"><h2id="title">Title</h2><p>One two three four five six seven eight nine ten eleven twelve thirteen</p></div><divclass="well no-shadow"><h2id="description">Description</h2><p>One two three four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen twenty twenty-one twenty-two twenty-three twenty-four twenty-five twenty-six twenty-seven twenty-eight twenty-nine thirty thirty-one thirty-two thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty</p></div><divclass="well no-shadow"><h2id="summary">Summary</h2><p>thirty-three thirty-four thirty-five thirty-six thirty-seven thirty-eight thirty-nine forty</p></div></div>
Togglable tabs tab.js
Example tabs
Add quick, dynamic tab functionality to transition through panes of local content, even via dropdown menus. Nested tabs are not supported.
Responsive tab design
Tabs structure changes via javascript to accordions on screen sizes lower than 992px (sm and below size). If js is not implemented, tabs will not be responsive and remain regular tabs on mobile and tablet devices.
Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.
Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.
Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.
Trust fund seitan letterpress, keytar raw denim keffiyeh etsy art party before they sold out master cleanse gluten-free squid scenester freegan cosby sweater. Fanny pack portland seitan DIY, art party locavore wolf cliche high life echo park Austin. Cred vinyl keffiyeh DIY salvia PBR, banh mi before they sold out farm-to-table VHS viral locavore cosby sweater. Lomo wolf viral, mustache readymade thundercats keffiyeh craft beer marfa ethical. Wolf salvia freegan, sartorial keffiyeh echo park vegan.
Alternate design
You can remove the border around the main content by adding .border-none after .tab-pane.
Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.
Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.
$('#myTabs a[href="#profile"]').tab('show')// Select tab by name$('#myTabs a:first').tab('show')// Select first tab$('#myTabs a:last').tab('show')// Select last tab$('#myTabs li:eq(2) a').tab('show')// Select third tab (0-indexed)
Markup
You can activate a tab or pill navigation without writing any JavaScript by simply specifying data-toggle="tab" or data-toggle="pill" on an element. Adding the nav and nav-tabs classes to the tab ul will apply the Bootstrap tab styling, while adding the nav and nav-pills classes will apply pill styling.
<div><!-- Nav tabs --><ulclass="nav nav-tabs"role="tablist"><lirole="presentation"class="active"><ahref="#home"aria-controls="home"role="tab"data-toggle="tab">Home</a></li><lirole="presentation"><ahref="#profile"aria-controls="profile"role="tab"data-toggle="tab">Profile</a></li><lirole="presentation"><ahref="#messages"aria-controls="messages"role="tab"data-toggle="tab">Messages</a></li><lirole="presentation"><ahref="#settings"aria-controls="settings"role="tab"data-toggle="tab">Settings</a></li></ul><!-- Tab panes --><divclass="tab-content"><divrole="tabpanel"class="tab-pane active"id="home">...</div><divrole="tabpanel"class="tab-pane"id="profile">...</div><divrole="tabpanel"class="tab-pane"id="messages">...</div><divrole="tabpanel"class="tab-pane"id="settings">...</div></div></div>
Fade effect
To make tabs fade in, add .fade to each .tab-pane. The first tab pane must also have .in to make the initial content visible.
<divclass="tab-content"><divrole="tabpanel"class="tab-pane fade in active"id="home">...</div><divrole="tabpanel"class="tab-pane fade"id="profile">...</div><divrole="tabpanel"class="tab-pane fade"id="messages">...</div><divrole="tabpanel"class="tab-pane fade"id="settings">...</div></div>
Methods
$().tab
Activates a tab element and content container. Tab should have either a data-target or an href targeting a container node in the DOM. In the above examples, the tabs are the <a>s with data-toggle="tab" attributes.
.tab('show')
Selects the given tab and shows its associated content. Any other tab that was previously selected becomes unselected and its associated content is hidden. Returns to the caller before the tab pane has actually been shown (i.e. before the shown.bs.tab event occurs).
$('#someTab').tab('show')
Events
When showing a new tab, the events fire in the following order:
hide.bs.tab (on the current active tab)
show.bs.tab (on the to-be-shown tab)
hidden.bs.tab (on the previous active tab, the same one as for the hide.bs.tab event)
shown.bs.tab (on the newly-active just-shown tab, the same one as for the show.bs.tab event)
If no tab was already active, then the hide.bs.tab and hidden.bs.tab events will not be fired.
Event Type
Description
show.bs.tab
This event fires on tab show, but before the new tab has been shown. Use event.target and event.relatedTarget to target the active tab and the previous active tab (if available) respectively.
shown.bs.tab
This event fires on tab show after a tab has been shown. Use event.target and event.relatedTarget to target the active tab and the previous active tab (if available) respectively.
hide.bs.tab
This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use event.target and event.relatedTarget to target the current active tab and the new soon-to-be-active tab, respectively.
hidden.bs.tab
This event fires after a new tab is shown (and thus the previous active tab is hidden). Use event.target and event.relatedTarget to target the previous active tab and the new active tab, respectively.
$('a[data-toggle="tab"]').on('shown.bs.tab',function(e){e.target// newly activated tabe.relatedTarget// previous active tab})
Third Party Plugins
While generally avoided (To keep overhead and code bloat to a minimum), certain third-party plugins have been researched and implemented into the LxCore framework. These plugins allow for enhanced functionality and greater breadth of design.
Picturefill picturefill.js
The picturefill plugin creates different images at separate breakpoints in order to allow for optimization of images and change in design where necessary.
Example
To see an example of the picturefill plugin used within the framework see the Jumbotron component
Usage
The picturefill plugin has a couple of html markup styles for various uses (See picturefill documentation). The most pertinent to the LxCore framework is simply using the html5 picture element with ie9 polyfill.
Picturefill is a third-party plugin implemented into LXCore for the sake of optimization and design of images. The documentation for installation and use of picturefill.js is located on Github
Current version of picturefill plugin being used is 3.0.2
Tablesorter jquery.tablesorter.js
The tablesorter plugin allows users to click the header of a table the plugin is applied to and sort the associated column of the header.
Example
To see an example of the tablesorter plugin used within the framework see the Table component
Usage
The tablesorter plugin can sort multiple types of data and has some extensibility associated with it (See tablesorter documentation). The tablesorter plugin can be used by simply adding the .table-sortable to any table needing this functionality.
<tableclass="table table-sortable">
...
</table>
Source Documentation
Tablesorter is a third-party plugin implemented into LXCore for the sake of extra functionality of tables. The documentation for installation and use of jquery.tablesorter.js is located on Github
Current version of tablesorter plugin being used is 2.0.5b
Toggle Switch
Example
This design element is used when you need to toggle between different layouts and/or views.
Inspired by the excellent jQuery.tipsy plugin written by Jason Frame; Tooltips are an updated version, which don't rely on images, use CSS3 for animations, and data-attributes for local title storage.
Tooltips with zero-length titles are never displayed.
Tooltip on the left
Tooltip on the top
Tooltip on the bottom
Tooltip on the right
Examples
Applied to in-line links
Tight pants next level keffiyeh you probably haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel have a terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A really ironic artisan whatever keytar, scenester farm-to-table banksy Austin twitter handle freegan cred raw denim single-origin coffee viral.
<p>Tight pants next level keffiyeh <ahref="#"data-toggle="tooltip"title="Default tooltip">you probably</a> haven't heard of them.</p>
Applied to buttons
<buttontype="button"class="btn btn-default"data-toggle="tooltip"data-placement="left"title="Tooltip on left">Tooltip on left</button><buttontype="button"class="btn btn-default"data-toggle="tooltip"data-placement="top"title="Tooltip on top">Tooltip on top</button><buttontype="button"class="btn btn-default"data-toggle="tooltip"data-placement="bottom"title="Tooltip on bottom">Tooltip on bottom</button><buttontype="button"class="btn btn-default"data-toggle="tooltip"data-placement="right"title="Tooltip on right">Tooltip on right</button>
Applied to helper icon
Add a class of .helper-tooltip to the icon tag to apply color, sizing and icon placement.
<divclass="form-group"><labelfor="ef-pid">PID<iclass="icon icon-help helper-tooltip"aria-hidden="true"data-toggle="tooltip"data-container="body"data-placement="auto top"data-trigger="click hover"title="An auto-generated number used as a global identifier."></i></label><inputtype="text"class="form-control"name="pid"id="ef-pid"placeholder=""></div>
Opt-in functionality
For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning you must initialize them yourself.
One way to initialize all tooltips on a page would be to select them by their data-toggle attribute:
The tooltip plugin generates content and markup on demand, and by default places tooltips after their trigger element.
Trigger the tooltip via JavaScript:
$('#example').tooltip(options)
Markup
The required markup for a tooltip is only a data attribute and title on the HTML element you wish to have a tooltip. The generated markup of a tooltip is rather simple, though it does require a position (by default, set to top by the plugin).
<!-- HTML to write --><ahref="#"data-toggle="tooltip"title="Some tooltip text!">Hover over me</a><!-- Generated markup by the plugin --><divclass="tooltip top"role="tooltip"><divclass="tooltip-arrow"></div><divclass="tooltip-inner">
Some tooltip text!
</div></div>
Multiple-line links
Sometimes you want to add a tooltip to a hyperlink that wraps multiple lines. The default behavior of the tooltip plugin is to center it horizontally and vertically. Add white-space: nowrap; to your anchors to avoid this.
Tooltips in button groups, input groups, and tables require special setting
When using tooltips on elements within a .btn-group or an .input-group, or on table-related elements (<td>, <th>, <tr>, <thead>, <tbody>, <tfoot>), you'll have to specify the option container: 'body' (documented below) to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the tooltip is triggered).
Don't try to show tooltips on hidden elements
Invoking $(...).tooltip('show') when the target element is display: none; will cause the tooltip to be incorrectly positioned.
Accessible tooltips for keyboard and assistive technology users
For users navigating with a keyboard, and in particular users of assistive technologies, you should only add tooltips to keyboard-focusable elements such as links, form controls, or any arbitrary element with a tabindex="0" attribute.
Tooltips on disabled elements require wrapper elements
To add a tooltip to a disabled or .disabled element, put the element inside of a <div> and apply the tooltip to that <div> instead.
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-animation="".
Note that for security reasons the sanitize, sanitizeFn and whiteList options cannot be supplied using data attributes.
Name
Type
Default
Description
animation
boolean
true
Apply a CSS fade transition to the tooltip
container
string | false
false
Appends the tooltip to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the tooltip in the flow of the document near the triggering element - which will prevent the tooltip from floating away from the triggering element during a window resize.
delay
number | object
0
Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type
If a number is supplied, delay is applied to both hide/show
Object structure is: delay: { "show": 500, "hide": 100 }
html
boolean
false
Insert HTML into the tooltip. If false, jQuery's text method will be used to insert content into the DOM. Use text if you're worried about XSS attacks.
placement
string | function
'top'
How to position the tooltip - top | bottom | left | right | auto. When "auto" is specified, it will dynamically reorient the tooltip. For example, if placement is "auto left", the tooltip will display to the left when possible, otherwise it will display right.
When a function is used to determine the placement, it is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The this context is set to the tooltip instance.
selector
string
false
If a selector is provided, tooltip objects will be delegated to the specified targets. In practice, this is used to also apply tooltips to dynamically added DOM elements (jQuery.on support). See this and an informative example.
The tooltip's title will be injected into the .tooltip-inner.
.tooltip-arrow will become the tooltip's arrow.
The outermost wrapper element should have the .tooltip class.
title
string | function
''
Default title value if title attribute isn't present.
If a function is given, it will be called with its this reference set to the element that the tooltip is attached to.
trigger
string
'hover focus'
How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. manual cannot be combined with any other trigger.
viewport
string | object | function
{ selector: 'body', padding: 0 }
Keeps the tooltip within the bounds of this element. Example: viewport: '#viewport' or { "selector": "#viewport", "padding": 0 }
If a function is given, it is called with the triggering element DOM node as its only argument. The this context is set to the tooltip instance.
sanitize
boolean
true
Enable or disable the sanitization. If activated 'template', 'content' and 'title' options will be sanitized.
Here you can supply your own sanitize function. This can be useful if you prefer to use a dedicated library to perform sanitization.
Data attributes for individual tooltips
Options for individual tooltips can alternatively be specified through the use of data attributes, as explained above.
Methods
$().tooltip(options)
Attaches a tooltip handler to an element collection.
.tooltip('show')
Reveals an element's tooltip. Returns to the caller before the tooltip has actually been shown (i.e. before the shown.bs.tooltip event occurs). This is considered a "manual" triggering of the tooltip. Tooltips with zero-length titles are never displayed.
$('#element').tooltip('show')
.tooltip('hide')
Hides an element's tooltip. Returns to the caller before the tooltip has actually been hidden (i.e. before the hidden.bs.tooltip event occurs). This is considered a "manual" triggering of the tooltip.
$('#element').tooltip('hide')
.tooltip('toggle')
Toggles an element's tooltip. Returns to the caller before the tooltip has actually been shown or hidden (i.e. before the shown.bs.tooltip or hidden.bs.tooltip event occurs). This is considered a "manual" triggering of the tooltip.
$('#element').tooltip('toggle')
.tooltip('destroy')
Hides and destroys an element's tooltip. Tooltips that use delegation (which are created using the selector option) cannot be individually destroyed on descendant trigger elements.
$('#element').tooltip('destroy')
Events
Event Type
Description
show.bs.tooltip
This event fires immediately when the show instance method is called.
shown.bs.tooltip
This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.tooltip
This event is fired immediately when the hide instance method has been called.
hidden.bs.tooltip
This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).
inserted.bs.tooltip
This event is fired after the show.bs.tooltip event when the tooltip template has been added to the DOM.
$('#myTooltip').on('hidden.bs.tooltip',function(){// do something…})
Transitions transition.js
About transitions
For simple transition effects, include transition.js once alongside the other JS files. If you're using the compiled (or minified) bootstrap.js, there is no need to include this—it's already there.
What's inside
Transition.js is a basic helper for transitionEnd events as well as a CSS transition emulator. It's used by the other plugins to check for CSS transition support and to catch hanging transitions.
Disabling transitions
Transitions can be globally disabled using the following JavaScript snippet, which must come after transition.js (or bootstrap.js or bootstrap.min.js, as the case may be) has loaded:
