CLF Javascript
The Javascript included in the UBC CLF package is based on the Bootstrap framework, but customized to fit our CLF needs. All CLF scripts are contained in the ubc-clf.js file. This file incorporates all the minified javascript files below and some custom functions as well.
Some of the added features include:
- Loading the content triggered by the Global Utility Button and the footer content
- A Unit Name resize function, which will resize longer unit and/or faculty names, so that they fit nicely on smaller resolutions (see how it works)
- Smoothing animation for the 'Back to top' links
Carousel
Example carousel
The slideshow below shows a generic plugin and component for cycling through elements like a carousel.
<div id="my-carousel" class="ubc-carousel carousel slide" role="complementary" aria-label="promotions">
<div class="carousel-inner">
<!-- Carousel items -->
<!-- First Active Slide -->
<div class="item active">
<a href="yourimagelink" title="your link title"><img src="yourimagesource.filetype" alt="alternate text"></a>
<div class="carousel-caption">
<h4>Caption heading</h4>
<p>Blurb about image<a href="yourlink" title="your link title">Your Link Text</a></p>
</div>
</div>
<!-- Second Slide -->
<div class="item">
<a href="yourimagelink" title="your link title"><img src="yourimagesource.filetype" alt="alternate text"></a>
<div class="carousel-caption">
<h4>Caption heading</h4>
<p>Blurb about image<a href="yourlink" title="your link title">Your Link Text</a></p>
</div>
</div>
</div>
<!-- Carousel controller -->
<div id="ubc7-carousel-controller">
<button type="button" class="ubc7-carousel-control left" data-slide="prev"></button>
<button type="button" class="ubc7-carousel-control pause" data-slide="pause"></button>
<button type="button" class="ubc7-carousel-control right" data-slide="next"></button>
<div class="ubc7-carousel-counter"></div>
</div>
</div>
Usage
Via JavaScript
Call carousel manually with:
$('#my-carousel').ubc_spotlight()
Options
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 | 8000 | The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle. |
| pause | string | 'cycle' | The slides will cycle indefinitely, unless the pause button is clicked/tapped. If you would like the slides to be paused on hover, you need to include the 'hover' value as well. |
Methods
.carousel(options)
Initializes the carousel with an optional options object and starts cycling through items.
$('.carousel').ubc_spotlight({
interval: 5000,
pause: 'hover'
})
.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.
| Event | Description |
|---|---|
| slide | This event fires immediately when the slide instance method is invoked. |
| slid | This event is fired when the carousel has completed its slide transition. |
Collapse
About
Get base styles and flexible support for collapsible components like accordions and navigation.
* Requires the Transitions plugin to be included.
Example accordion
Using the collapse plugin, we built a simple accordion style widget:
<div class="accordion" id="accordion2">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseOne">
Collapsible Group Item #1
</a>
</div>
<div id="collapseOne" class="accordion-body collapse in">
<div class="accordion-inner">
Bacon ipsum dolor sit amet short loin...
</div>
</div>
</div>
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseTwo">
Collapsible Group Item #2
</a>
</div>
<div id="collapseTwo" class="accordion-body collapse">
<div class="accordion-inner">
Bacon ipsum dolor sit amet short loin...
</div>
</div>
</div>
</div>
...
You can also use the plugin without the accordion markup. Make a button toggle the expanding and collapsing of another element.
<button type="button" class="btn btn-danger" data-toggle="collapse" data-target="#demo"> simple collapsible </button> <div id="demo" class="collapse in"> ... </div>
Usage
Via data attributes
Just add data-toggle="collapse" and a data-target to 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 selector then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior) |
| 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.
.collapse('show')
Shows a collapsible element.
.collapse('hide')
Hides a collapsible element.
Events
Bootstrap's collapse class exposes a few events for hooking into collapse functionality.
| Event | Description |
|---|---|
| show | This event fires immediately when the show instance method is called. |
| shown | This event is fired when a collapse element has been made visible to the user (will wait for css transitions to complete). |
| hide |
This event is fired immediately when the hide method has been called.
|
| hidden | This event is fired when a collapse element has been hidden from the user (will wait for css transitions to complete). |
$('#myCollapsible').on('hidden', function () {
// do something
})
Dropdown
Examples
Add dropdown menus to nearly anything with this simple plugin, including:
- navbar
- tabs
- pills
View available styles for basic and split dropdowns.
Usage
Via data attributes
Add data-toggle="dropdown" to a link or button to toggle a dropdown.
<div class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#">Dropdown trigger</a>
<ul class="dropdown-menu" role="menu" aria-labelledby="dLabel">
...
</ul>
</div>
To keep URLs intact, use the data-target attribute instead of href="#".
<div class="dropdown">
<a class="dropdown-toggle" id="dLabel" role="button" data-toggle="dropdown" data-target="#" href="/page.html">
Dropdown
<b class="caret"></b>
</a>
<ul class="dropdown-menu" role="menu" aria-labelledby="dLabel">
...
</ul>
</div>
Via JavaScript
Call the dropdowns via JavaScript:
$('.dropdown-toggle').dropdown()
Options
None
Methods
$().dropdown('toggle')
A programatic api for toggling menus for a given navbar or tabbed navigation.
Tabs
Example tabs
Add quick, dynamic tab functionality to transiton through panes of local content, even via dropdown menus.
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.
Usage
Enable tabbable tabs via JavaScript (each tab needs to be activated individually):
$('#myTab a').click(function (e) {
e.preventDefault();
$(this).tab('show');
})
You can activate individual tabs in several ways:
$('#myTab a[href="#profile"]').tab('show'); // Select tab by name
$('#myTab a:first').tab('show'); // Select first tab
$('#myTab a:last').tab('show'); // Select last tab
$('#myTab 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.
<ul class="nav nav-tabs"> <li><a href="#home" data-toggle="tab">Home</a></li> <li><a href="#profile" data-toggle="tab">Profile</a></li> <li><a href="#messages" data-toggle="tab">Messages</a></li> <li><a href="#settings" data-toggle="tab">Settings</a></li> </ul>
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.
<ul class="nav nav-tabs" id="myTab">
<li class="active"><a href="#home">Home</a></li>
<li><a href="#profile">Profile</a></li>
<li><a href="#messages">Messages</a></li>
<li><a href="#settings">Settings</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="home">...</div>
<div class="tab-pane" id="profile">...</div>
<div class="tab-pane" id="messages">...</div>
<div class="tab-pane" id="settings">...</div>
</div>
<script>
$(function () {
$('#myTab a:last').tab('show');
})
</script>
Events
| Event | Description |
|---|---|
| show | 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 | 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. |
$('a[data-toggle="tab"]').on('shown', function (e) {
e.target // activated tab
e.relatedTarget // previous tab
})
Transitions
For simple transition effects we have included the bootstrap-transition.js as part of the CLF Javascript.
Use cases
A few examples of the transition plugin:
- Sliding or fading in modals
- Fading out tabs
- Fading out alerts
- Sliding carousel panes