OOJS @ Wikia

Object Oriented JavaScript and MVC

By Liz Lee

Historical Patterns at Wikia

Globals

Example: WMU

Globals clutter up the namespace

Object Literals

Examples: Lightbox, ArticleComments, etc.

Also relies on globals
Very hard to extend
Massive file sizes

Revealing Module Pattern

Examples: LVS, StringHelper, etc.

Hard to extend for multiple instances

Mozilla Developer Network says OO JS...

is:

... each object is capable of receiving messages, processing data, and sending messages to other objects ... and can be viewed as an independent little machine with a distinct role or responsibility.

is not:

... a collection of functions, or simply a list of instructions to the computer.

Suggestions for style, encapsulation, and building modular code

Every module consists of one constructor / class
```
var MyClass = function () {...}
```

Prototype properties and methods are added like:

MyClass.prototype.myMethod = function () { ... }

The constructor is exported as the value of the module
```
return MyClass;
```

Sample Module

define('wikia.MyClass', [...], function() {
	'use strict';

	var MyClass = function() { ... }

	MyClass.prototype.myMethod = function () { ... }

	return MyClass;
});

Sample Usage

require('wikia.MyClass', function (MyClass) {
	var myClass = new MyClass();
	// or
	var newClass = function () { ... }
	newClass.prototype = Object.create(MyClass.prototype);
}

Benefits

Truly modular code
Easy to create a base class and extend it for reusable functionality
- Example: "Image" and "Video" classes can extend a "Media" class

In Production: TitleThumbnail

Base class in Thumbnails extension: titleThumbnail
Usage in VideosModule extension: titleThumbnail
Two different instances of TitleThumbnail with different tracking methods: Video Home Page and Videos Module

JavaScript MVC

Without a Framework

Adapting useful constructs from Backbone

MV* - Backbone has models, views, collections, and routers
We adapted for MVC - model, view, controller

Models

Key/Value store of data
fetch method, with optional event binding
Example: videos module

Views

el or $el property represents HTML wrapper element
render method returns rendered html

Heads Up

reveal.js is a framework for easily creating beautiful presentations using HTML. You'll need a browser with support for CSS 3D transforms to see it in its full glory.

Oh hey, these are some notes. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit 's' on your keyboard).

Vertical Slides

Slides can be nested inside of other slides, try pressing down.

Basement Level 1

Press down or up to navigate.

Basement Level 2

Cornify

Basement Level 3

That's it, time to go back up.

Slides

Not a coder? No problem. There's a fully-featured visual editor for authoring these, try it out at http://slid.es.

Point of View

Press ESC to enter the slide overview.

Hold down alt and click on any element to zoom in on it using zoom.js. Alt + click anywhere to zoom back out.

Works in Mobile Safari

Try it out! You can swipe through the slides and pinch your way to the overview.

Marvelous Unordered List

No order here
Or here
Or here
Or here

Fantastic Ordered List

One is smaller than... Two is smaller than... Three!

Markdown support

For those of you who like that sort of thing. Instructions and a bit more info available here.

<section data-markdown>
  ## Markdown support

  For those of you who like that sort of thing.
  Instructions and a bit more info available [here](https://github.com/hakimel/reveal.js#markdown).
</section>

Transition Styles

You can select from different transitions, like: Cube - Page - Concave - Zoom - Linear - Fade - None - Default

Themes

Reveal.js comes with a few themes built in: Default - Sky - Beige - Simple - Serif - Night Moon - Solarized

* Theme demos are loaded after the presentation which leads to flicker. In production you should load your theme in the <head> using a <link>.

Global State

Set data-state="something" on a slide and "something" will be added as a class to the document element when the slide is open. This lets you apply broader style changes, like switching the background.

Custom Events

Additionally custom events can be triggered on a per slide basis by binding to the data-state name.

Reveal.addEventListener( 'customevent', function() {
	console.log( '"customevent" has fired' );
} );

Slide Backgrounds

Set data-background="#007777" on a slide to change the full page background to the given color. All CSS color formats are supported.

Image Backgrounds

<section data-background="image.png">

Repeated Image Backgrounds

<section data-background="image.png" data-background-repeat="repeat" data-background-size="100px">

Background Transitions

Pass reveal.js the backgroundTransition: 'slide' config argument to make backgrounds slide rather than fade.

Background Transition Override

You can override background transitions per slide by using data-background-transition="slide".

Clever Quotes

These guys come in two forms, inline: “The nice thing about standards is that there are so many to choose from” and block:

“For years there has been a theory that millions of monkeys typing at random on millions of typewriters would reproduce the entire works of Shakespeare. The Internet has proven this theory to be untrue.”

Pretty Code

function linkify( selector ) {
  if( supports3DTransforms ) {

    var nodes = document.querySelectorAll( selector );

    for( var i = 0, len = nodes.length; i < len; i++ ) {
      var node = nodes[i];

      if( !node.className ) {
        node.className += ' roll';
      }
    }
  }
}

Courtesy of highlight.js.

Intergalactic Interconnections

You can link between slides internally, like this.

Fragmented Views

Hit the next arrow...

... to step through ...

any type of view fragments This slide has fragments which are also stepped through in the notes window.

Fragment Styles

There's a few styles of fragments, like:

grow

shrink

roll-in

fade-out

highlight-red

highlight-green

highlight-blue

current-visible

highlight-current-blue

Spectacular image!

Export to PDF

Presentations can be exported to PDF, below is an example that's been uploaded to SlideShare.

Take a Moment

Press b or period on your keyboard to enter the 'paused' mode. This mode is helpful when you want to take distracting slides off the screen during a presentation.

OOJS @ Wikia – Historical Patterns at Wikia – Suggestions for style, encapsulation, and building modular code

lizlux