xobs/lca2019-talk

Rebecca Murphey 8f69e72cf7 update readme

2012-06-11 18:30:32 -04:00

8.7 KiB

Raw Blame History

reveal.js

A CSS 3D slideshow tool for quickly creating good looking HTML presentations. Doesn't rely on any external libraries but highlight.js is included by default for code highlighting.

Note that this requires a browser with support for CSS 3D transforms and classList. If CSS 3D support is not detected, the presentation will degrade to less exciting 2D transitions. A classList polyfill is incuded to make this work in < iOS 5, < Safari 5.1 and IE.

Curious about how it looks in action? Check out the demo page.

Usage

Markup

Markup heirarchy needs to be <div id="reveal"> <div class="slides"> <section> where the <section> represents one slide and can be repeated indefinitely. If you place multiple <section>'s inside of another <section> they will be shown as vertical slides. For example:

<div id="reveal">
	<div class="slides"> 
		<section>Single Horizontal Slide</section>
		<section>
			<section>Vertical Slide 1</section>
			<section>Vertical Slide 2</section>
		</section>
	</div>
</div>

Configuration

At the end of your page, after <script src="js/reveal.js"></script>, you need to initialize reveal by running the following code. Note that all config values are optional.

Reveal.initialize({
	// Display controls in the bottom right corner
	controls: true,

	// Display a presentation progress bar
	progress: true,

	// If true; each slide will be pushed to the browser history
	history: true,

	// Loops the presentation, defaults to false
	loop: false,

	// Flags if mouse wheel navigation should be enabled
	mouseWheel: true,

	// Apply a 3D roll to links on hover
	rollingLinks: true,

	// UI style
	theme: 'default', // default/neon

	// Transition style
	transition: 'default' // default/cube/page/concave/linear(2d)
});

API

The Reveal class provides a minimal JavaScript API for controlling its navigation:

Reveal.navigateTo( indexh, indexv );
Reveal.navigateLeft();
Reveal.navigateRight();
Reveal.navigateUp();
Reveal.navigateDown();
Reveal.navigatePrev();
Reveal.navigateNext();
Reveal.toggleOverview();

States

If you set data-state="somestate" on a slide <section>, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide.

Furthermore you can also listen to these changes in state via JavaScript:

Reveal.addEventListener( 'somestate', function() {
	// TODO: Sprinkle magic
}, false );

Slide change event

An 'slidechanged' event is fired each time the slide is changed (regardless of state). The event object holds the index values of the current slide as well as a reference to the previous and current slide HTML nodes.

Reveal.addEventListener( 'slidechanged', function( event ) {
	// event.previousSlide, event.currentSlide, event.indexh, event.indexv
} );

Fragment events

When a slide fragment is either shown or hidden reveal.js will dispatch an event.

Reveal.addEventListener( 'fragmentshown', function( event ) {
	// event.fragment = the fragment DOM element
} );
Reveal.addEventListener( 'fragmenthidden', function( event ) {
	// event.fragment = the fragment DOM element
} );

Examples

Send me a link if you used reveal.js for a project or presentation.

History

1.4 (master/beta)

Main #reveal container is now selected via a class instead of ID
API methods for adding or removing all event listeners
The 'slidechange' event now includes currentSlide and previousSlide
Fixed bug where 'slidechange' was firing twice when history was enabled

1.3

Revised keyboard shortcuts, including ESC for overview, N for next, P for previous. Thanks mahemoff
Added support for looped presentations via config
Fixed IE9 fallback
Added event binding methods (Reveal.addEventListener, Reveal.removeEventListener)
Added 'slidechanged' event
Added print styles. Thanks skypanther
The address bar now hides automatically on mobile browsers
Space and return keys can be used to exit the overview mode
Events for fragment states ('fragmentshown'/'fragmenthidden')
Support for swipe navigation on touch devices. Thanks akiersky
Support for pinch to overview on touch devices

1.2

Big changes to DOM structure:
- Previous #main wrapper is now called #reveal
- Slides were moved one level deeper, into #reveal .slides
- Controls and progress bar were moved into #reveal
CSS is now much more explicit, rooted at #reveal, to prevent conflicts
Config option for disabling updates to URL, defaults to true
Anchors with image children no longer rotate in 3D on hover
Support for mouse wheel navigation (naugtur)
Delayed updates to URL hash to work around a bug in Chrome
Included a classList polyfill for IE9
Support for wireless presenter keys
States can now be applied as classes on the document element by adding data-state on a slide

1.1

Added an optional presentation progress bar
Images wrapped in anchors no longer unexpectedly flip in 3D
Slides that contain other slides are given the 'stack' class
Added 'transition' option for specifying transition styles
Added 'theme' option for specifying UI styles
New transitions: 'box' & 'page'
New theme: 'neon'

1.0

New and improved style
Added controls in bottom right which indicate where you can navigate
Reveal views in iteratively by giving them the .fragment class
Code sample syntax highlighting thanks to highlight.js
Initialization options (toggling controls, toggling rolling links, transition theme)

0.3

Added licensing terms
Fixed broken links on touch devices

0.2

Refactored code and added inline documentation
Slides now have unique URL's
A basic API to invoke navigation was added

0.1

First release
Transitions and a white theme

License

MIT licensed

8.7 KiB Raw Blame History